aboutsummaryrefslogtreecommitdiffstats
path: root/pages/about-enventor.txt
blob: 8c9b01fdfdbe43e434c599bbbde501481c44db70 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
~~Title: About Enventor~~
==== Enventor ====

[[download|Download Enventor Here]]

{{:icon-enventor.png?nolink |}}

===A. What is Enventor?===

Enventor, which is also known as a dynamic EDC (Edje Data Collections) Editor, is a EDC script editor tool that supports text editing and previewing functions for the EDC source code.

{{ :enventor-main.png?&300|}}

When your application requires real-time changeable layouts like animated ones, you can write the layout design using EDC script, compile it into EDJ format file, and import it into your application using a UI layout component. You can also write design layouts from simple to complex ones using the EDC script with Enventor. Enventor helps you write EDC script code easier and finish your work faster. If you are not familiar with EDC programming, see [[/develop/legacy/program_guide/edje_pg|Edje Programming Guide]] for more information.

Basically, Enventor view is divided into live view and text view. The live view on the left pane previews images corresponding to part objects of the EDC source code. The text view on the right pane contains the EDC source code. Because of its real-time update mechanism, Enventor updates the preview real-time while you modify the source code. Enventor also provides useful functions for you to develop your GUI. Before using Enventor, familiarize yourself with the following functionalities.

  A. What is Enventor?
  B. GUI Layout
  C. Text View
  D. EDC Navigator
  E. Interactive Feedback
  F. Live Edit
  G. Workspace
  H. Tool Functions
  I. Status View
  J. Templates
  K. Settings
  L. Command Line Usage

===B. GUI Layout===

{{ :enventor-layout.png?&350|}}

Enventor view consists of the file browser, live view, text view, tools and the EDC navigator.

The following figure illustrates the Enventor layout sections.

  * Red: Tools
  * Cyan: File browser
  * Green: Live view
  * Blue: Text view
  * Orange: EDC navigator
  * Purple: Console view
  * White: File tab
  * Yellow: Status view

===C. Text View===

Enventor text view mainly supports text editing. You can write and modify EDC source code in this view. Once the part sections are written in the text view and the modified EDC source code is saved, the preview images corresponding to the part objects of EDC source code are displayed in the live view. Basically, this text editor applies syntax color and auto indentation for EDC with its own coding standard rules. If you open an EDC file which is not matched with Enventor coding standard rule, Enventor applies it to your source code automatically for your convenience. To disable this functionality, go to "Setting -> Preference -> Auto Indentation".

Furthermore, the Text view supports the following features.

{{ :enventor-autocomplete.png?&150|}}


==Auto-complete==

To help you write EDC source code, the Text view supports an auto-complete function which lists the reserved keywords in a contextual pop-up.

When you enter a part of a reserved keyword, a contextual pop-up appears with a list of keywords beginning with your input string. Choose a keyword with the up and down arrow keys and press "Enter". The keyword is selected and a related EDC code snippet is inserted in the text view automatically. In contrast, if you press "Backspace" key, the auto-complete function is cancelled and the contextual pop-up is dismissed. To enable or disable the auto-complete function, go to "Settings -> Preferences -> Auto Completion".

You can also use auto-complete as a context help. Use the "Ctrl+Space" key combination to show a list of available keywords in the current cursor position context.


{{:enventor-candidate.png?&300 |}}

==Candidate list==

The EDC script provides a variety of pre-defined keywords, including part object types and program action types. To easily edit the keywords, the text view supports a candidate list function for the keywords. When you double-click a keyword in the text view, the available candidate keyword list based on the context pops up. If you select one of the candidate keywords, the double-clicked keyword is changed to a selected one.

The candidate list function also helps you to know the available range of numeric values based on the context. The numeric candidate function shows a range of available numbers. when you drag the sliders, Enventor updates the live view instantly.


{{ :enventor-colorselector.png?&150|}}

==Color selector==

To change color values, use the color selector tool. Each time a "color" keyword is double-clicked, it displays the color selector.


==Zooming text==

Zooming in and out in the text view area changes the editor text font size relative to the zoom factor. This action can be done pressing the "Ctrl" key and rolling the mouse wheel up and down while the mouse cursor is placed the text area. To change the font size in the Text Editor Settings, go to Settings -> Text Editor -> Font Size".


===D. EDC Navigator===

{{ :enventor-navigator.png?&300|}}

For easy navigation inside the EDC block, Enventor provides a tree-style visual tool, called EDC Navigator. You can expand and contract tree items and understand the structure of your EDC layout at a glance.

The following sets of blocks are supported in the EDC Navigator.

  * Group
  * Part
  * State
  * Program

To navigate the EDC source code through the EDC Navigator, click an item in the list. The editor cursor in the text view changes its position to the name of selected item. In case of program items in the tree, they provide the play and stop buttons to trigger or stop the programs in Enventor. This helps you to check the programs by seeing the results directly in the tool.

This tool can be enabled or disabled by the "F10" shortcut key.


===E. Interactive Feedback===

Enventor has the following ways of providing interactive feedback information when you edit the EDC source code.


{{ :enventor-highlight.png?&250|}}

==Highlighting a Part Object==

To easily identify the part object that you modify, Enventor provides a function for highlighting the preview image corresponding to a part object. Click a part section in the EDC source code and the preview image corresponding to the part object in live view is highlighted. Oppositely, clicking a part object of the preview image in live view moves the editor cursor to the corresponding EDC line in the text view.


{{:enventor-errors.png?&250 |}}

==Detecting Errors==

To quickly notify about an EDC grammar error, Enventor compiles the EDC source code in the background and detects errors whenever the EDC source code is saved. The detected errors are printed in the console view, and an error code is highlighted with an underline in the text view. When errors are detected, the console view is activated automatically. It is deactivated when the errors are fixed. This behavior is only enabled if the Auto Hiding Console mode is enabled in "Settings -> Preference -> Auto Hiding Console". You can change the size of the console view by dragging a pane divider between the text view and the console view. You can also toggle the console view visibility with the "Alt+up" and "Alt+down" shortcut keys.


{{ :enventor-preview.png?&150|}}

==Image Preview==

To easily check the image files you use, the text view provides a function for previewing image files. Write an image keyword and an image file name in the EDC source code and click the image keyword. The preview image pop-up of the clicked image file opens. If other image files are written in a previous or a next line of the previewed image line, you can go to them using the up and down arrow keys or mouse wheel.


{{:enventor-reference.png?&150 |}}

==Reference popup==

Reference popup is a kind of like a manual for EDC keywords that current cursor positioned on. It shows a description of an EDC keyword for the beginners, who don't familiar with the EDC programming script language, by understanding them its syntax. To pop up the reference, Press "F5" key after positioned the editor cursor on any EDC keywords.


===F. Live Edit===

{{ :enventor-liveedit1.png?&250|}}

Enventor also provides mode called live edit to add part objects easier. Click one of the part object buttons in tools to activate live edit mode. After that, you can add a part object using the live edit contextual pop-up and change its position and size by dragging. Once you confirm the new part, a code snippet describing the new part is inserted in the text editor. When the live edit mode is activated, the text view is disabled.

{{:enventor-liveedit2.png?&150 |}}

==Adding a New Part Object==

The tools contain 6 frequently-used part type buttons: Rect, Text, Image, Swallow, Textblock, and Spacer. Click a required part type button, and the corresponding part object appears in the live view.


==Setting Position and Size==

The position and size of a part object in pixels are displayed in the center of the part object preview image. The relative position of the part object is displayed on a top left box and on bottom right box.

The position and size of a part object can be changed by dragging each control point. These control points are placed on each edge of a part object. To move the part object only, drag the object itself. To move the object position by 1 pixel, use the arrow keys.


{{ :enventor-liveedit3.png?&150|}}

==Auto-Aligning==

By default, the live edit mode provides an auto-aligning functionality which helps you place a control point, which you are dragging, near other parts. If the auto-aligning is activated, it highlights a control line with red color when it attaches to another part. Auto-aligning helps you construct a layout quickly and easily. You disable the auto-align functionality instantly by pressing a "Ctrl" while you drag a control point.


{{:enventor-liveedit4.png?&150 |}}

==Fixed Size==

Each part in a layout can be constructed with relative or fixed size. A part with a relative size expands or contracts its size to keep up other parts position and size or a layout size. On the other hand, if a part is constructed with the fixed size, its size does not scale with the other parts or the layout size. When live edit mode is activated, you can find a fixed size tool in the bottom of the live view. You can check fixed size options for width and height if you want the width and height values to be fixed. For more information about scalability concept in EDC, see [[/develop/legacy/program_guide/scalability/scalability_using_edje|Scalability Using Edje]]


{{ :enventor-liveedit5.png?&150|}}

==Relative Positioning==

In contrast to the fixed size, you can set a new part's position and size relative to other parts. Drag a control point to the edge of other existing parts. Once you release the mouse button, a contextual pop-up pops up. This popup displays a list of candidate parts that you can choose as relative to x and y coordinates to this new part.


==Confirmation and Cancellation==

After you have confirmed a new part, press "Enter" or double-click a mouse button to insert the part object in your layout. The live edit mode is terminated and the text view is enabled again. To cancel the live edit mode any time during editing, press "Esc" or "Backspace" key.


==Dummy Parts==

Enventor displays non-visual parts with symbols so that you can understand how their parts have positioned and sized. Typically, dummy parts are the swallow and spacer parts. You can toggle the dummy parts by pressing "Ctrl+U" to show or hide the symbols.


{{:enventor-wireframe.png?&150 |}}

==Wireframes==

Wireframe is also one of useful functions for live editing. It displays outlines of all parts with solid lines so that you can understand the logical boundaries of the parts in a layout. You can toggle this function by pressing "Ctrl+W".


===G. Workspace===

Set up the workspace if your EDC collections are consisted of multiple EDC files. The default workspace directory is where you launch the Enventor but if you launch Enventor with "-w" command option which specifies a workspace path, then Enventor regards that path is a current workspace directory. Workspace is designed to be used with the File browser (toggle shortcut key, F9) and the File tab (toggle shortcut key, F11) so that you can navigate multiple EDC files in those tools. Basically, the file browser displays the current workspace directory.


==File Browser==

You can open EDC files in the file browser. Just double click any EDC files on it. Then EDC text will be opened with a new file tab.

Enventor allows only one main EDC file that can be activated in the Live view. In the file browser, the main EDC file will be displayed with [main] tag. If the main EDC file contains multiple sub EDC files, then you can open and navigate through them. You can easily open those files in the file browser but you can also open them by pressing "F3" if the text editor cursor is placed on the "include" line in the text view. (ie, #include "subfile.edc").
"F4" shortcut key helps you to go back to the previous edit page quickly.

Enventor tracks a current focused EDC group to display it while you go through groups in one EDC collection. But If you open a new EDC file which contains another collection, then you need to manually set up that file to be a main. For this, press "F2" after selecting a new main EDC file in the file browser. Then Enventor understands that EDC has a collection to be adoptable with its subordinate files. You can also change a main EDC file in "Settings -> EDC Build -> Main EDC File".


===H. Tool Functions===

Enventor provides useful tool functions. The following table shows the tool buttons at the top of the Enventor window along with their functions. To toggle the tools itself, use the "F7" shortcut key.

^Icon                                 ^ Function                                                                               ^Hotkey  ^
|{{:enventor-tool-high.png?&20|}}     |Show a highlight effect on the selected part in the live view.                          |Ctrl+H  |
|{{:enventor-tool-dummy.png?&20|}}    |Display virtual images for the swallow and spacer parts.                                |Ctrl+U  |
|{{:enventor-tool-wire.png?&20|}}     |Display wireframes to identify the parts boundaries.                                    |Ctrl+W  |
|{{:enventor-tool-mirror.png?&20|}}   |Invert the layout horizontally and review the designed layout in RTL, LTR settings.     |Ctrl+M  |
|{{:enventor-tool-rect.png?&20|}}     |Add a Rect part to the live view.                                                       |        |
|{{:enventor-tool-text.png?&20|}}     |Add a Text part to the live view.                                                       |        |
|{{:enventor-tool-image.png?&20|}}    |Add a Image part to the live view.                                                      |        |
|{{:enventor-tool-swallow.png?&20|}}  |Add a Swallow part to the live view.                                                    |        |
|{{:enventor-tool-textblock.png?&20|}}|Add a Textblock part to the live view.                                                  |        |
|{{:enventor-tool-spacer.png?&20|}}   |Add a Spacer part to the live view.                                                     |        |
|{{:enventor-tool-save.png?&20|}}     |Save the current script to a file.                                                      |Ctrl+S  |
|{{:enventor-tool-undo.png?&20|}}     |Undo text changes.                                                                      |Ctrl+Z  |
|{{:enventor-tool-redo.png?&20|}}     |Redo text changes.                                                                      |Ctrl+R  |
|{{:enventor-tool-find.png?&20|}}     |Find or replace text.                                                                   |Ctrl+F  |
|{{:enventor-tool-goto.png?&20|}}     |Open the go to window to move the cursor position.                                      |Ctrl+L  |
|{{:enventor-tool-line.png?&20|}}     |Display the script line numbers.                                                        |        |
|{{:enventor-tool-code.png?&20|}}     |Insert the best code corresponding the current editor context.                          |Ctrl+T  |
|{{:enventor-tool-console.png?&20|}}  |Display the console box which shows EDC build logs.                                     |Alt+Down|
|{{:enventor-tool-browser.png?&20|}}  |Display the file browser which shows a file list in current workspace.                  |F9      |
|{{:enventor-tool-navi.png?&20|}}     |Display the EDC navigator which shows the current group hierarchy tree.                 |F10     |
|{{:enventor-tool-tab.png?&20|}}      |Display the file tab in the bottom area.                                                |F11     |
|{{:enventor-tool-menu.png?&20|}}     |Open the Enventor main menu.                                                            |Esc     |


===I. Status View===

Enventor displays the status view on the bottom area. This status view provides extra functions. At times, it displays useful informative messages for your control. Most of times, you can change the live view zoom level and live view size. Otherwise, you can check the current mouse position, a name of the focused group and the text editor cursor line position. See the following sections for more information. To toggle the status view itself, use the "F8" shortcut key.


{{ :enventor-status.png?&300|}}

==Zooming View==

To change the live view zoom value, you can use a zoom level controller (Slider). Zooming can be done by pressing "Ctrl" and roling the mouse wheel up and down while you place the mouse cursor in the live view area. The range of the zoom is from 0.1x to 5.0x.


==View Size==

When a new group view comes in live view area, it will have a default view size, 300x300. You can change its view size. Click the resize expand button to display a slider to manipulate it. You could control slider indicator using the mouse dragging or the mouse wheel. Each group keeps individual view sizes so when you switch views they may have different view size. Also, you can swap the width and height of the live view instantly. This swap functionality can be used for simulating some scenarios, such as mobile device portrait and landscape modes. To change the default view size, go to "Settings -> Preferences -> View Size".


===J. Templates===

{{ :enventor-template.png?&200|}}

Enventor provides various useful templates for a quick start. To choose a template, open a new file from the main menu. There are many templates designed to make you understand how to use EDC and how to make GUI designs with them. Also, it can bring you some ideas about what you can do with EDC programming. These templates contain simple samples and also practical examples.


===K. Settings===

The Settings window allows you to set and control the Enventor properties. This window contains 3 tabs: Preferences, Text Editor, and EDC Build.


{{:enventor-setting-preference.png?&200 |}}

==Preferences==

Preferences contain occasionally used options in Enventor. Also, it contains some unique function options such as Auto Hiding Console, Smart Redo/Undo, and Error Message Red Alert.

When the Auto Hiding Console option is turned on, Enventor hides the console box automatically when no messages are to be shown after you have fixed all grammatical errors.

When the Smart Undo/Redo option is turned on, Enventor redoes and undoes text word by word. If disabled, redoing and undoing works character by character.

When the Error Message Red Alert option is turned on, Enventor enables the error message red alert effect. When the EDC compilation fails because of a grammatical error, Enventor alerts you with a fading screen effect.


{{ :enventor-setting-text.png?&200|}}

==Text Editor==

The Text Editor tab provides text options to control the font size and type. You can also change the text color highlighting scheme. Double-click a keyword in the preview to change its color.


==EDC Build==

This tab provides some options to control EDC build. You can change the image, sound, font, data, and even main EDC pathes here.


===L. Command Line Usages===

You could launch Enventor with commands. Please see the following.

  * Usage: enventor [input file] [output file] [-t] [-i image path] [-s sound path] [-f font path] [-d data path] [-w workspace]

^Options                           ^ Function                                   ^
|-t, --to                          |Open template menu                          |
|-i=path, --id=path                |Images path                                 |
|-s=path, --sd=path                |Sounds path                                 |
|-f=path, --fd=path                |Fonts path                                  |
|-d=path, --dd=path                |Data path                                   |
|-w=path, --wd=path                |Workspace path                              |
|-v, --version                     |show program version.                       |
|-c, --copyright                   |show copyright.                             |
|-l, --license                     |show license.                               |
|-h[=CATEGORY], --help[=CATEGORY]  |show this message. No categories available. |

Examples of Enventor command line usage:
  * enventor
  * enventor input.edc -i ./images
  * enventor input.edc output.edj -i ./images
  * enventor -t
  * enventor newfile.edc -t
  * enventor input.edc output.edj -i ./images -s ./sounds -w ./workspace


===Demo Video===

{{youtube>lTLfr6knXrA?large}}