summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-06-11 16:39:33 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-06-11 16:39:33 +0100
commit32e26a4615779ee06c90a7dafbc15b2f7453e15e (patch)
treeda4ea47e7b4f365cc3e4af9af5a4c916bb2c8f24
parentc5f40609db341ea75064eaf1d2b9fa324db6291d (diff)
eo: migrate enum docs to new format
-rw-r--r--src/lib/elm_flip.eo19
-rw-r--r--src/lib/elm_general.eot104
-rw-r--r--src/lib/elm_panel.eo13
-rw-r--r--src/lib/elm_scroller.eo54
-rw-r--r--src/lib/elm_toolbar.eo30
-rw-r--r--src/lib/elm_toolbar_item.eo16
-rw-r--r--src/lib/elm_win.eo240
7 files changed, 218 insertions, 258 deletions
diff --git a/src/lib/elm_flip.eo b/src/lib/elm_flip.eo
index 7e908afdf..46818079d 100644
--- a/src/lib/elm_flip.eo
+++ b/src/lib/elm_flip.eo
@@ -1,8 +1,6 @@
1enum Elm.Flip.Mode 1enum Elm.Flip.Mode
2{ 2{
3 /*@ 3 [[]]
4 @ingroup Flip
5 */
6 legacy: elm_flip; 4 legacy: elm_flip;
7 rotate_y_center_axis, 5 rotate_y_center_axis,
8 rotate_x_center_axis, 6 rotate_x_center_axis,
@@ -20,9 +18,7 @@ enum Elm.Flip.Mode
20 18
21enum Elm.Flip.Interaction 19enum Elm.Flip.Interaction
22{ 20{
23 /*@ 21 [[]]
24 @ingroup Flip
25 */
26 none, 22 none,
27 rotate, 23 rotate,
28 cube, 24 cube,
@@ -31,13 +27,10 @@ enum Elm.Flip.Interaction
31 27
32enum Elm.Flip.Direction 28enum Elm.Flip.Direction
33{ 29{
34 /*@ 30 up = 0, [[Allows interaction with the top of the widget]]
35 @ingroup Flip 31 down, [[Allows interaction with the bottom of the widget]]
36 */ 32 left, [[Allows interaction with the left portion of the widget]]
37 up = 0, /*@< Allows interaction with the top of the widget */ 33 right [[Allows interaction with the right portion of the widget]]
38 down, /*@< Allows interaction with the bottom of the widget */
39 left, /*@< Allows interaction with the left portion of the widget */
40 right /*@< Allows interaction with the right portion of the widget */
41} 34}
42 35
43class Elm.Flip (Elm.Container) 36class Elm.Flip (Elm.Container)
diff --git a/src/lib/elm_general.eot b/src/lib/elm_general.eot
index aa84a665c..b492041b9 100644
--- a/src/lib/elm_general.eot
+++ b/src/lib/elm_general.eot
@@ -1,85 +1,89 @@
1struct Elm.Event.Policy_Changed 1struct Elm.Event.Policy_Changed
2{ 2{
3 /*@ 3 [[Data on the event when an Elementary policy has changed]]
4 @struct _Elm_Event_Policy_Changed 4 policy: uint; [[the policy identifier]]
5 5 new_value: int; [[value the policy had before the change]]
6 Data on the event when an Elementary policy has changed 6 old_value: int; [[new value the policy got]]
7 */
8 policy: uint; /*@< the policy identifier */
9 new_value: int; /*@< value the policy had before the change */
10 old_value: int; /*@< new value the policy got */
11} 7}
12 8
13enum Elm.Policy 9enum Elm.Policy
14{ 10{
15 /*@ 11 [[Policy identifiers.]]
16 Policy identifiers. 12 quit, [[under which circumstances the application should quit automatically.
17 */ 13 See also @Elm_Policy_Quit.]]
18 quit, /*@< under which circumstances the application should quit automatically. @see Elm_Policy_Quit. */ 14 exit, [[defines elm_exit() behaviour. See also @Elm_Policy_Exit.
19 exit, /*@< defines elm_exit() behaviour. @see Elm_Policy_Exit. 15
20 @since 1.8 16 @since 1.8
21 */ 17 ]]
22 throttle, /*@< defines how throttling should work @see Elm_Policy_Throttle 18 throttle, [[defines how throttling should work. See also @Elm_Policy_Throttle
19
23 @since 1.8 20 @since 1.8
24 */ 21 ]]
25 last 22 last
26} 23}
27 24
28enum Elm.Policy.Quit 25enum Elm.Policy.Quit
29{ 26{
30 /*@ 27 [[Possible values for the #ELM_POLICY_QUIT policy]]
31 Possible values for the #ELM_POLICY_QUIT policy 28 none = 0, [[never quit the application automatically]]
32 */ 29 last_window_closed [[quit when the application's last window is closed]]
33 none = 0, /*@< never quit the application
34 automatically */
35 last_window_closed /*@< quit when the
36 application's last
37 window is closed */
38} 30}
39 31
40enum Elm.Policy.Exit 32enum Elm.Policy.Exit
41{ 33{
42 /*@ 34 [[Possible values for the #ELM_POLICY_EXIT policy.
43 Possible values for the #ELM_POLICY_EXIT policy. 35
44 @since 1.8 36 @since 1.8
45 */ 37 ]]
46 none = 0, /*@< just quit the main loop on elm_exit() */ 38 none = 0, [[just quit the main loop on elm_exit()]]
47 windows_del /*@< delete all the windows after quitting 39 windows_del [[delete all the windows after quitting the main loop]]
48 the main loop */
49} 40}
50 41
51enum Elm.Policy.Throttle 42enum Elm.Policy.Throttle
52{ 43{
53 /*@ 44 [[Possible values for the #ELM_POLICY_THROTTLE policy.
54 Possible values for the #ELM_POLICY_THROTTLE policy. 45
55 @since 1.8 46 @since 1.8
56 */ 47 ]]
57 config = 0, /*@< do whatever elementary config is configured to do */ 48 config = 0, [[do whatever elementary config is configured to do]]
58 hidden_always, /*@< always throttle when all windows are no longer visible */ 49 hidden_always, [[always throttle when all windows are no longer visible]]
59 never /*@< never throttle when windows are all hidden, regardless of config settings */ 50 never [[never throttle when windows are all hidden, regardless of config
51 settings]]
60} 52}
61 53
62enum Elm.Object.Select_Mode 54enum Elm.Object.Select_Mode
63{ 55{
64 /*@ 56 [[Possible values for the #ELM_OBJECT_SELECT_MODE policy.
65 Possible values for the #ELM_OBJECT_SELECT_MODE policy. 57
66 @since 1.7 58 @since 1.7
67 */ 59 ]]
68 default = 0, /*@< default select mode. Once an item is selected, it would stay highlighted and not going to call selected callback again even it was clicked. Items can get focus. */ 60 default = 0, [[default select mode. Once an item is selected, it would stay
69 always, /*@< always select mode. Item selected callbacks will be called every time for click events, even after the item was already selected. Items can get focus. */ 61 highlighted and not going to call selected callback again
70 none, /*@< no select mode. Items will never be highlighted and selected but the size will be adjusted by the finger size configuration. Items can't get focus. */ 62 even it was clicked. Items can get focus.]]
71 display_only, /*@< no select mode with no finger size rule. Items will never be highlighted and selected and ignore the finger size. So the item size can be reduced below than the finger size configuration. Items can't get focus. */ 63 always, [[always select mode. Item selected callbacks will be called every
72 max /*@< canary value: any value greater or equal to ELM_OBJECT_SELECT_MODE_MAX is forbidden. */ 64 time for click events, even after the item was already selected.
65 Items can get focus.]]
66 none, [[no select mode. Items will never be highlighted and selected but
67 the size will be adjusted by the finger size configuration. Items
68 can't get focus.]]
69 display_only, [[no select mode with no finger size rule. Items will never
70 be highlighted and selected and ignore the finger size. So
71 the item size can be reduced below than the finger size
72 configuration. Items can't get focus.]]
73 max [[canary value: any value greater or equal to ELM_OBJECT_SELECT_MODE_MAX
74 is forbidden.]]
73} 75}
74 76
75enum Elm.Object.Multi_Select_Mode 77enum Elm.Object.Multi_Select_Mode
76{ 78{
77 /*@ 79 [[Possible values for the #ELM_OBJECT_MULTI_SELECT_MODE policy.
78 Possible values for the #ELM_OBJECT_MULTI_SELECT_MODE policy. 80
79 @since 1.8 81 @since 1.8
80 */ 82 ]]
81 default = 0, /*@< default multiple select mode */ 83 default = 0, [[default multiple select mode]]
82 with_control, /*@< disallow mutiple selection when clicked without control key pressed */ 84 with_control, [[disallow mutiple selection when clicked without control key
83 max /*@< canary value: any value greater or equal to ELM_OBJECT_MULTI_SELECT_MODE_MAX is forbidden. */ 85 pressed]]
86 max [[canary value: any value greater or equal to
87 ELM_OBJECT_MULTI_SELECT_MODE_MAX is forbidden.]]
84} 88}
85 89
diff --git a/src/lib/elm_panel.eo b/src/lib/elm_panel.eo
index d178f00fa..c4970e2ef 100644
--- a/src/lib/elm_panel.eo
+++ b/src/lib/elm_panel.eo
@@ -1,14 +1,11 @@
1enum Elm.Panel.Orient 1enum Elm.Panel.Orient
2{ 2{
3 /*@ 3 [[Panel orientation mode]]
4 Panel orientation mode
5 4
6 @ingroup Panel */ 5 top, [[Panel (dis)appears from the top]]
7 6 bottom, [[Panel (dis)appears from the bottom]]
8 top, /*@< Panel (dis)appears from the top */ 7 left, [[Panel (dis)appears from the left]]
9 bottom, /*@< Panel (dis)appears from the bottom */ 8 right [[Panel (dis)appears from the right]]
10 left, /*@< Panel (dis)appears from the left */
11 right /*@< Panel (dis)appears from the right */
12} 9}
13 10
14class Elm.Panel (Elm.Layout, Elm_Interface_Scrollable, 11class Elm.Panel (Elm.Layout, Elm_Interface_Scrollable,
diff --git a/src/lib/elm_scroller.eo b/src/lib/elm_scroller.eo
index 1c29a6fcc..d4441deb5 100644
--- a/src/lib/elm_scroller.eo
+++ b/src/lib/elm_scroller.eo
@@ -1,45 +1,39 @@
1enum Elm.Scroller.Policy 1enum Elm.Scroller.Policy
2{ 2{
3 /*@ 3 [[Type that controls when scrollbars should appear.
4 @brief Type that controls when scrollbars should appear. 4
5 @see elm_scroller_policy_set() 5 See also @elm_scroller_policy_set.
6 6 ]]
7 @ingroup Scroller 7 auto = 0, [[Show scrollbars as needed]]
8 */ 8 on, [[Always show scrollbars]]
9 auto = 0, /*@< Show scrollbars as needed */ 9 off, [[Never show scrollbars]]
10 on, /*@< Always show scrollbars */
11 off, /*@< Never show scrollbars */
12 last 10 last
13} 11}
14 12
15enum Elm.Scroller.Single_Direction 13enum Elm.Scroller.Single_Direction
16{ 14{
17 /*@ 15 [[Type that controls how the content is scrolled.
18 @brief Type that controls how the content is scrolled. 16
19 17 See also @elm_scroller_single_direction_set.
20 @see elm_scroller_single_direction_set() 18 ]]
21 @ingroup Scroller 19 none = 0, [[Scroll every direction]]
22 */ 20 soft, [[Scroll single direction if the direction is certain]]
23 none = 0, /*@< Scroll every direction */ 21 hard, [[Scroll only single direction]]
24 soft, /*@< Scroll single direction if the direction is certain*/
25 hard, /*@< Scroll only single direction */
26 last 22 last
27} 23}
28 24
29enum Elm.Scroller.Movement_Block 25enum Elm.Scroller.Movement_Block
30{ 26{
31 /*@ 27 [[Type that blocks the scroll movement in one or more direction.
32 @brief Type that blocks the scroll movement in one or more direction. 28
33 29 See also @elm_scroller_movement_block.
34 @see elm_scroller_movement_block() 30
35 31 @since 1.8
36 @since 1.8 32 ]]
37 @ingroup Scroller 33 legacy: elm_scroller_movement;
38 */ 34 no_block = 1 << 0, [[Do not block movements]]
39 legacy: elm_scroller_movement; 35 block_vertical = 1 << 1, [[Block vertical movements]]
40 no_block = 1 << 0, /*@< Do not block movements */ 36 block_horizontal = 1 << 2 [[Block horizontal movements]]
41 block_vertical = 1 << 1, /*@< Block vertical movements */
42 block_horizontal = 1 << 2 /*@< Block horizontal movements */
43} 37}
44 38
45class Elm.Scroller (Elm.Layout, Elm_Interface_Scrollable, 39class Elm.Scroller (Elm.Layout, Elm_Interface_Scrollable,
diff --git a/src/lib/elm_toolbar.eo b/src/lib/elm_toolbar.eo
index a6d643115..3735f2edd 100644
--- a/src/lib/elm_toolbar.eo
+++ b/src/lib/elm_toolbar.eo
@@ -2,29 +2,25 @@ import elm_general;
2 2
3enum Elm.Toolbar.Shrink_Mode 3enum Elm.Toolbar.Shrink_Mode
4{ 4{
5/*@ 5 [[Set toolbar's items display behavior, it can be scrollable,
6 Set toolbar's items display behavior, it can be scrollable, 6 show a menu with exceeding items, or simply hide them.
7 show a menu with exceeding items, or simply hide them.
8 7
9 @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value 8 Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
10 from elm config. 9 from elm config.
11 10
12 Values <b> don't </b> work as bitmask, only one can be chosen. 11 Values don't work as bitmask, only one can be chosen.
13 12
14 @see elm_toolbar_shrink_mode_set() 13 See also @elm_toobar_shrink_mode_set, @elm_toolbar_shrink_mode_get.
15 @see elm_toolbar_shrink_mode_get() 14 ]]
16
17 @ingroup Toolbar
18 */
19 15
20 legacy: elm_toolbar_shrink; 16 legacy: elm_toolbar_shrink;
21 17
22 none, /*@< Set toolbar minimum size to fit all the items. */ 18 none, [[Set toolbar minimum size to fit all the items.]]
23 hide, /*@< Hide exceeding items. */ 19 hide, [[Hide exceeding items.]]
24 scroll, /*@< Allow accessing exceeding items through a scroller. */ 20 scroll, [[Allow accessing exceeding items through a scroller.]]
25 menu, /*@< Inserts a button to pop up a menu with exceeding items. */ 21 menu, [[Inserts a button to pop up a menu with exceeding items.]]
26 expand, /*@< Expand all items according the size of the toolbar. */ 22 expand, [[Expand all items according the size of the toolbar.]]
27 last /*@< Indicates error if returned by elm_toolbar_shrink_mode_get() */ 23 last [[Indicates error if returned by elm_toolbar_shrink_mode_get()]]
28} 24}
29 25
30class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable, 26class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
diff --git a/src/lib/elm_toolbar_item.eo b/src/lib/elm_toolbar_item.eo
index ff6712aae..2fb998bdc 100644
--- a/src/lib/elm_toolbar_item.eo
+++ b/src/lib/elm_toolbar_item.eo
@@ -1,17 +1,13 @@
1enum Elm.Toolbar_Item.Scrollto_Type 1enum Elm.Toolbar_Item.Scrollto_Type
2{ 2{
3 /*@ 3 [[Defines where to position the item in the toolbar.]]
4 Defines where to position the item in the toolbar.
5 @ingroup Toolbar
6 */
7
8 legacy: elm_toolbar_item_scrollto; 4 legacy: elm_toolbar_item_scrollto;
9 5
10 none = 0, /*@< no scrollto */ 6 none = 0, [[no scrollto]]
11 in = (1 << 0), /*@< to the nearest viewport */ 7 in = (1 << 0), [[to the nearest viewport]]
12 first = (1 << 1), /*@< to the first of viewport */ 8 first = (1 << 1), [[to the first of viewport]]
13 middle = (1 << 2), /*@< to the middle of viewport */ 9 middle = (1 << 2), [[to the middle of viewport]]
14 last = (1 << 3) /*@< to the last of viewport */ 10 last = (1 << 3) [[to the last of viewport]]
15} 11}
16 12
17class Elm.Toolbar_Item(Elm.Widget_Item) 13class Elm.Toolbar_Item(Elm.Widget_Item)
diff --git a/src/lib/elm_win.eo b/src/lib/elm_win.eo
index ed3d0e808..10b236bd5 100644
--- a/src/lib/elm_win.eo
+++ b/src/lib/elm_win.eo
@@ -1,177 +1,157 @@
1enum Elm.Win.Type 1enum Elm.Win.Type
2{ 2{
3 /*@ 3 [[Defines the types of window that can be created
4 Defines the types of window that can be created
5 4
6 These are hints set on the window so that a running Window Manager knows 5 These are hints set on the window so that a running Window Manager knows
7 how the window should be handled and/or what kind of decorations it 6 how the window should be handled and/or what kind of decorations it
8 should have. 7 should have.
9 8
10 Currently, only the X11 backed engines use them. 9 Currently, only the X11 backed engines use them.
11 10 ]]
12 @ingroup Win */
13 11
14 legacy: elm_win; 12 legacy: elm_win;
15 13
16 unknown = -1, 14 unknown = -1,
17 basic, /*@ A normal window. Indicates a normal, top-level 15 basic, [[A normal window. Indicates a normal, top-level window. Almost every
18 window. Almost every window will be created with this 16 window will be created with this type.]]
19 type. */ 17 dialog_basic, [[Used for simple dialog windows.]]
20 dialog_basic, /*@ Used for simple dialog windows. */ 18 desktop, [[For special desktop windows, like a background window holding
21 desktop, /*@ For special desktop windows, like a background 19 desktop icons.]]
22 window holding desktop icons. */ 20 dock, [[The window is used as a dock or panel. Usually would be kept on top
23 dock, /*@ The window is used as a dock or panel. Usually would 21 of any other window by the Window Manager.]]
24 be kept on top of any other window by the Window 22 toolbar, [[The window is used to hold a floating toolbar, or similar.]]
25 Manager. */ 23 menu, [[Similar to #ELM_WIN_TOOLBAR.]]
26 toolbar, /*@ The window is used to hold a floating toolbar, or 24 utility, [[A persistent utility window, like a toolbox or palette.]]
27 similar. */ 25 splash, [[Splash window for a starting up application.]]
28 menu, /*@ Similar to #ELM_WIN_TOOLBAR. */ 26 dropdown_menu, [[The window is a dropdown menu, as when an entry in a
29 utility, /*@ A persistent utility window, like a toolbox or 27 menubar is clicked. Typically used with @elm_win_override_set.
30 palette. */ 28 This hint exists for completion only, as the EFL way of
31 splash, /*@ Splash window for a starting up application. */ 29 implementing a menu would not normally use a separate
32 dropdown_menu, /*@ The window is a dropdown menu, as when an 30 window for its contents.]]
33 entry in a menubar is clicked. Typically used 31 popup_menu, [[Like #ELM_WIN_DROPDOWN_MENU, but for the menu triggered by
34 with elm_win_override_set(). This hint exists 32 right-clicking an object.]]
35 for completion only, as the EFL way of 33 tooltip, [[The window is a tooltip. A short piece of explanatory text that
36 implementing a menu would not normally use a 34 typically appear after the mouse cursor hovers over an object
37 separate window for its contents. */ 35 for a while. Typically used with @elm_win_override_set and also
38 popup_menu, /*@ Like #ELM_WIN_DROPDOWN_MENU, but for the menu 36 not very commonly used in the EFL.]]
39 triggered by right-clicking an object. */ 37 notification, [[A notification window, like a warning about battery life or
40 tooltip, /*@ The window is a tooltip. A short piece of 38 a new E-Mail received.]]
41 explanatory text that typically appear after the 39 combo, [[A window holding the contents of a combo box. Not usually used in
42 mouse cursor hovers over an object for a while. 40 the EFL.]]
43 Typically used with elm_win_override_set() and also 41 dnd, [[Used to indicate the window is a representation of an object being
44 not very commonly used in the EFL. */ 42 dragged across different windows, or even applications. Typically
45 notification, /*@ A notification window, like a warning about 43 used with elm_win_override_set().]]
46 battery life or a new E-Mail received. */ 44 inlined_image, [[The window is rendered onto an image buffer. No actual
47 combo, /*@ A window holding the contents of a combo box. Not 45 window is created for this type, instead the window and
48 usually used in the EFL. */ 46 all of its contents will be rendered to an image buffer.
49 dnd, /*@ Used to indicate the window is a representation of an 47 This allows to have children window inside a parent one
50 object being dragged across different windows, or even 48 just like any other object would be, and do other things
51 applications. Typically used with 49 like applying @Evas_Map effects to it. This is the only
52 elm_win_override_set(). */ 50 type of window that requires the parent parameter of
53 inlined_image, /*@ The window is rendered onto an image 51 @elm_win_add to be a valid @Evas_Object.]]
54 buffer. No actual window is created for this 52 socket_image, [[The window is rendered onto an image buffer and can be shown
55 type, instead the window and all of its 53 other process's plug image object. No actual window is
56 contents will be rendered to an image buffer. 54 created for this type, instead the window and all of its
57 This allows to have children window inside a 55 contents will be rendered to an image buffer and can be
58 parent one just like any other object would 56 shown other process's plug image object.
59 be, and do other things like applying @c 57 ]]
60 Evas_Map effects to it. This is the only type 58 fake [[This window was created using a pre-existing canvas. The window
61 of window that requires the @c parent 59 widget can be deleted, but the canvas must be managed externally.
62 parameter of elm_win_add() to be a valid @c 60
63 Evas_Object. */ 61 @since 1.13
64 socket_image, /*@ The window is rendered onto an image buffer 62 ]]
65 and can be shown other process's plug image object.
66 No actual window is created for this type,
67 instead the window and all of its contents will be
68 rendered to an image buffer and can be shown
69 other process's plug image object. */
70 fake /*@ This window was created using a pre-existing canvas.
71 The window widget can be deleted, but the canvas
72 must be managed externally.
73 @since 1.13 */
74} 63}
75 64
76enum Elm.Win.Keyboard_Mode 65enum Elm.Win.Keyboard_Mode
77{ 66{
78 /*@ 67 [[The different layouts that can be requested for the virtual keyboard.
79 The different layouts that can be requested for the virtual keyboard.
80
81 When the application window is being managed by Illume, it may request
82 any of the following layouts for the virtual keyboard.
83 68
84 @ingroup Win */ 69 When the application window is being managed by Illume, it may request
70 any of the following layouts for the virtual keyboard.
71 ]]
85 72
86 legacy: elm_win_keyboard; 73 legacy: elm_win_keyboard;
87 74
88 unknown, /*@ Unknown keyboard state */ 75 unknown, [[Unknown keyboard state]]
89 off, /*@ Request to deactivate the keyboard */ 76 off, [[Request to deactivate the keyboard]]
90 on, /*@ Enable keyboard with default layout */ 77 on, [[Enable keyboard with default layout]]
91 alpha, /*@ Alpha (a-z) keyboard layout */ 78 alpha, [[Alpha (a-z) keyboard layout]]
92 numeric, /*@ Numeric keyboard layout */ 79 numeric, [[Numeric keyboard layout]]
93 pin, /*@ PIN keyboard layout */ 80 pin, [[PIN keyboard layout]]
94 phone_number, /*@ Phone keyboard layout */ 81 phone_number, [[Phone keyboard layout]]
95 hex, /*@ Hexadecimal numeric keyboard layout */ 82 hex, [[Hexadecimal numeric keyboard layout]]
96 terminal, /*@ Full (QWERTY) keyboard layout */ 83 terminal, [[Full (QWERTY) keyboard layout]]
97 password, /*@ Password keyboard layout */ 84 password, [[Password keyboard layout]]
98 ip, /*@ IP keyboard layout */ 85 ip, [[IP keyboard layout]]
99 host, /*@ Host keyboard layout */ 86 host, [[Host keyboard layout]]
100 file, /*@ File keyboard layout */ 87 file, [[File keyboard layout]]
101 url, /*@ URL keyboard layout */ 88 url, [[URL keyboard layout]]
102 keypad, /*@ Keypad layout */ 89 keypad, [[Keypad layout]]
103 j2me /*@ J2ME keyboard layout */ 90 j2me [[J2ME keyboard layout]]
104} 91}
105 92
106enum Elm.Win.Indicator_Mode 93enum Elm.Win.Indicator_Mode
107{ 94{
108 /*@ 95 [[In some environments, like phones, you may have an indicator that
109 In some environments, like phones, you may have an indicator that 96 shows battery status, reception, time etc. This is the indicator.
110 shows battery status, reception, time etc. This is the indicator.
111 97
112 Sometimes you don't want it because you provide the same functionality 98 Sometimes you don't want it because you provide the same functionality
113 inside your app, so this will request that the indicator is hidden in 99 inside your app, so this will request that the indicator is hidden in
114 this circumstance if you use ELM_ILLUME_INDICATOR_HIDE. The default 100 this circumstance if you use ELM_ILLUME_INDICATOR_HIDE. The default
115 is to have the indicator shown. 101 is to have the indicator shown.
116 102 ]]
117 @ingroup Win */
118 103
119 legacy: elm_win_indicator; 104 legacy: elm_win_indicator;
120 105
121 unknown, /*@ Unknown indicator state */ 106 unknown, [[Unknown indicator state]]
122 hide, /*@ Hides the indicator */ 107 hide, [[Hides the indicator]]
123 show /*@ Shows the indicator */ 108 show [[Shows the indicator]]
124} 109}
125 110
126enum Elm.Win.Indicator_Opacity_Mode 111enum Elm.Win.Indicator_Opacity_Mode
127{ 112{
128 /*@ 113 [[Defines the opacity modes of indicator that can be shown]]
129 Defines the opacity modes of indicator that can be shown
130
131 @ingroup Win */
132
133 legacy: elm_win_indicator; 114 legacy: elm_win_indicator;
134 115
135 opacity_unknown, /*@ Unknown indicator opacity mode */ 116 opacity_unknown, [[Unknown indicator opacity mode]]
136 opaque, /*@ Opacifies the indicator */ 117 opaque, [[Opacifies the indicator]]
137 translucent, /*@ Be translucent the indicator */ 118 translucent, [[Be translucent the indicator]]
138 transparent /*@ Transparentizes the indicator */ 119 transparent [[Transparentizes the indicator]]
139} 120}
140 121
141/** 122/**
142 */ 123 */
143enum Elm.Win.Keygrab_Mode 124enum Elm.Win.Keygrab_Mode
144{ 125{
145 /*@ 126 [[Define the keygrab modes of window. A window may send commands to the
146 Define the keygrab modes of window. 127 Keyrouter according this mode, and perform different actions.]]
147 A window may send commands to the Keyrouter according this mode,
148 and perform different actions.
149
150 @ingroup Win */
151
152 legacy: elm_win_keygrab; 128 legacy: elm_win_keygrab;
153 129
154 unknown = 0, /*@ Unknown keygrab mode */ 130 unknown = 0, [[Unknown keygrab mode]]
155 shared = (1 << 8), /*@ Getting the grabbed-key together with the other client windows */ 131 shared = (1 << 8), [[Getting the grabbed-key together with the other client
156 topmost = (1 << 9), /*@ Getting the grabbed-key only when window is top of the stack */ 132 windows]]
157 exclusive = (1 << 10), /*@ Getting the grabbed-key exclusively regardless of window's position */ 133 topmost = (1 << 9), [[Getting the grabbed-key only when window is top of the
158 override_exclusive = (1 << 11) /*@ Getting the grabbed-key exclusively regardless of window's position. Being overrided the grab by the other client window */ 134 stack]]
135 exclusive = (1 << 10), [[Getting the grabbed-key exclusively regardless of
136 window's position]]
137 override_exclusive = (1 << 11) [[Getting the grabbed-key exclusively
138 regardless of window's position. Being
139 overrided the grab by the other client
140 window]]
159} 141}
160 142
161enum Elm.Illume_Command 143enum Elm.Illume_Command
162{ 144{
163 /*@ 145 [[Available commands that can be sent to the Illume manager.
164 Available commands that can be sent to the Illume manager.
165
166 When running under an Illume session, a window may send commands to the
167 Illume manager to perform different actions.
168 146
169 @ingroup Win */ 147 When running under an Illume session, a window may send commands to the
148 Illume manager to perform different actions.
149 ]]
170 150
171 focus_back, /*@ Reverts focus to the previous window */ 151 focus_back, [[Reverts focus to the previous window]]
172 focus_forward, /*@ Sends focus to the next window in the list */ 152 focus_forward, [[Sends focus to the next window in the list]]
173 focus_home, /*@ Hides all windows to show the Home screen */ 153 focus_home, [[Hides all windows to show the Home screen]]
174 close /*@ Closes the currently active window */ 154 close [[Closes the currently active window]]
175} 155}
176 156
177class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window, 157class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,