summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVitor Sousa <vitorsousasilva@gmail.com>2015-05-04 18:33:17 -0300
committerVitor Sousa <vitorsousasilva@gmail.com>2015-05-07 16:00:03 -0300
commit40202659d69d0ddcd2272d45122a64adef1aa0a3 (patch)
treeee3bc5ce76fd83ab240e035a91d3ffdb22f11c26
parentf235d0542e5a9deec8197e59ad6d8d1eab824828 (diff)
elm_win: Move enums to elm_win.eodevs/vitorsousa/efaces_elm_win_standard
Move enums from elm_win_common.h to elm_win.eo in order to make them more accessible for bindings. Moved the include for elm_win.eo.legacy.h to the top of elm_win_legacy.h to allow the use of the generated types in the function declarations.
-rw-r--r--src/lib/elm_win.eo166
-rw-r--r--src/lib/elm_win_common.h138
-rw-r--r--src/lib/elm_win_legacy.h4
3 files changed, 163 insertions, 145 deletions
diff --git a/src/lib/elm_win.eo b/src/lib/elm_win.eo
index d0863aee9..d6e070646 100644
--- a/src/lib/elm_win.eo
+++ b/src/lib/elm_win.eo
@@ -1,3 +1,159 @@
1enum Elm.Win.Type
2{
3 /*@
4 Defines the types of window that can be created
5
6 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
8 should have.
9
10 Currently, only the X11 backed engines use them.
11
12 @ingroup Win */
13
14 legacy: elm_win;
15
16 unknown = -1,
17 basic, /*@ A normal window. Indicates a normal, top-level
18 window. Almost every window will be created with this
19 type. */
20 dialog_basic, /*@ Used for simple dialog windows. */
21 desktop, /*@ For special desktop windows, like a background
22 window holding desktop icons. */
23 dock, /*@ The window is used as a dock or panel. Usually would
24 be kept on top of any other window by the Window
25 Manager. */
26 toolbar, /*@ The window is used to hold a floating toolbar, or
27 similar. */
28 menu, /*@ Similar to #ELM_WIN_TOOLBAR. */
29 utility, /*@ A persistent utility window, like a toolbox or
30 palette. */
31 splash, /*@ Splash window for a starting up application. */
32 dropdown_menu, /*@ The window is a dropdown menu, as when an
33 entry in a menubar is clicked. Typically used
34 with elm_win_override_set(). This hint exists
35 for completion only, as the EFL way of
36 implementing a menu would not normally use a
37 separate window for its contents. */
38 popup_menu, /*@ Like #ELM_WIN_DROPDOWN_MENU, but for the menu
39 triggered by right-clicking an object. */
40 tooltip, /*@ The window is a tooltip. A short piece of
41 explanatory text that typically appear after the
42 mouse cursor hovers over an object for a while.
43 Typically used with elm_win_override_set() and also
44 not very commonly used in the EFL. */
45 notification, /*@ A notification window, like a warning about
46 battery life or a new E-Mail received. */
47 combo, /*@ A window holding the contents of a combo box. Not
48 usually used in the EFL. */
49 dnd, /*@ Used to indicate the window is a representation of an
50 object being dragged across different windows, or even
51 applications. Typically used with
52 elm_win_override_set(). */
53 inlined_image, /*@ The window is rendered onto an image
54 buffer. No actual window is created for this
55 type, instead the window and all of its
56 contents will be rendered to an image buffer.
57 This allows to have children window inside a
58 parent one just like any other object would
59 be, and do other things like applying @c
60 Evas_Map effects to it. This is the only type
61 of window that requires the @c parent
62 parameter of elm_win_add() to be a valid @c
63 Evas_Object. */
64 socket_image, /*@ The window is rendered onto an image buffer
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}
75
76enum Elm.Win.Keyboard_Mode
77{
78 /*@
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
84 @ingroup Win */
85
86 legacy: elm_win_keyboard;
87
88 unknown, /*@ Unknown keyboard state */
89 off, /*@ Request to deactivate the keyboard */
90 on, /*@ Enable keyboard with default layout */
91 alpha, /*@ Alpha (a-z) keyboard layout */
92 numeric, /*@ Numeric keyboard layout */
93 pin, /*@ PIN keyboard layout */
94 phone_number, /*@ Phone keyboard layout */
95 hex, /*@ Hexadecimal numeric keyboard layout */
96 terminal, /*@ Full (QWERTY) keyboard layout */
97 password, /*@ Password keyboard layout */
98 ip, /*@ IP keyboard layout */
99 host, /*@ Host keyboard layout */
100 file, /*@ File keyboard layout */
101 url, /*@ URL keyboard layout */
102 keypad, /*@ Keypad layout */
103 j2me /*@ J2ME keyboard layout */
104}
105
106enum Elm.Win.Indicator_Mode
107{
108 /*@
109 In some environments, like phones, you may have an indicator that
110 shows battery status, reception, time etc. This is the indicator.
111
112 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
114 this circumstance if you use ELM_ILLUME_INDICATOR_HIDE. The default
115 is to have the indicator shown.
116
117 @ingroup Win */
118
119 legacy: elm_win_indicator;
120
121 unknown, /*@ Unknown indicator state */
122 hide, /*@ Hides the indicator */
123 show /*@ Shows the indicator */
124}
125
126enum Elm.Win.Indicator_Opacity_Mode
127{
128 /*@
129 Defines the opacity modes of indicator that can be shown
130
131 @ingroup Win */
132
133 legacy: elm_win_indicator;
134
135 opacity_unknown, /*@ Unknown indicator opacity mode */
136 opaque, /*@ Opacifies the indicator */
137 translucent, /*@ Be translucent the indicator */
138 transparent /*@ Transparentizes the indicator */
139}
140
141enum Elm.Illume_Command
142{
143 /*@
144 Available commands that can be sent to the Illume manager.
145
146 When running under an Illume session, a window may send commands to the
147 Illume manager to perform different actions.
148
149 @ingroup Win */
150
151 focus_back, /*@ Reverts focus to the previous window */
152 focus_forward, /*@ Sends focus to the next window in the list */
153 focus_home, /*@ Hides all windows to show the Home screen */
154 close /*@ Closes the currently active window */
155}
156
1class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window, 157class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
2 Elm_Interface_Atspi_Widget_Action) 158 Elm_Interface_Atspi_Widget_Action)
3{ 159{
@@ -600,7 +756,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
600 @ingroup Win */ 756 @ingroup Win */
601 } 757 }
602 values { 758 values {
603 Elm_Win_Keyboard_Mode mode; /*@ The mode to set, one of #Elm_Win_Keyboard_Mode */ 759 Elm.Win.Keyboard_Mode mode; /*@ The mode to set, one of #Elm_Win_Keyboard_Mode */
604 } 760 }
605 } 761 }
606 @property focus_highlight_animate { 762 @property focus_highlight_animate {
@@ -680,7 +836,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
680 @ingroup Win */ 836 @ingroup Win */
681 } 837 }
682 values { 838 values {
683 Elm_Win_Indicator_Opacity_Mode mode; /*@ The mode to set, one of #Elm_Win_Indicator_Opacity_Mode */ 839 Elm.Win.Indicator_Opacity_Mode mode; /*@ The mode to set, one of #Elm_Win_Indicator_Opacity_Mode */
684 } 840 }
685 } 841 }
686 @property demand_attention { 842 @property demand_attention {
@@ -886,7 +1042,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
886 @ingroup Win */ 1042 @ingroup Win */
887 } 1043 }
888 values { 1044 values {
889 Elm_Win_Indicator_Mode mode; /*@ The mode to set, one of #Elm_Win_Indicator_Mode */ 1045 Elm.Win.Indicator_Mode mode; /*@ The mode to set, one of #Elm_Win_Indicator_Mode */
890 } 1046 }
891 } 1047 }
892 @property conformant { 1048 @property conformant {
@@ -1194,7 +1350,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
1194 @ingroup Win */ 1350 @ingroup Win */
1195 } 1351 }
1196 values { 1352 values {
1197 Elm_Win_Type type(-1); 1353 Elm.Win.Type type(enum Elm.Win.Type.unknown);
1198 } 1354 }
1199 } 1355 }
1200 @property noblank { 1356 @property noblank {
@@ -1291,7 +1447,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
1291 @ingroup Win */ 1447 @ingroup Win */
1292 1448
1293 params { 1449 params {
1294 @in Elm_Illume_Command command; /*@ The command to send */ 1450 @in Elm.Illume_Command command; /*@ The command to send */
1295 @in void *params @optional; /*@ Optional parameters for the command */ 1451 @in void *params @optional; /*@ Optional parameters for the command */
1296 } 1452 }
1297 } 1453 }
diff --git a/src/lib/elm_win_common.h b/src/lib/elm_win_common.h
index b1e16fbb0..02d8bd4e2 100644
--- a/src/lib/elm_win_common.h
+++ b/src/lib/elm_win_common.h
@@ -5,144 +5,6 @@
5 */ 5 */
6 6
7/** 7/**
8 * Defines the types of window that can be created
9 *
10 * These are hints set on the window so that a running Window Manager knows
11 * how the window should be handled and/or what kind of decorations it
12 * should have.
13 *
14 * Currently, only the X11 backed engines use them.
15 */
16typedef enum
17{
18 ELM_WIN_UNKNOWN = -1,
19 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
20 window. Almost every window will be created with this
21 type. */
22 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
23 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
24 window holding desktop icons. */
25 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
26 be kept on top of any other window by the Window
27 Manager. */
28 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
29 similar. */
30 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
31 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
32 palette. */
33 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
34 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
35 entry in a menubar is clicked. Typically used
36 with elm_win_override_set(). This hint exists
37 for completion only, as the EFL way of
38 implementing a menu would not normally use a
39 separate window for its contents. */
40 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
41 triggered by right-clicking an object. */
42 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
43 explanatory text that typically appear after the
44 mouse cursor hovers over an object for a while.
45 Typically used with elm_win_override_set() and also
46 not very commonly used in the EFL. */
47 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
48 battery life or a new E-Mail received. */
49 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
50 usually used in the EFL. */
51 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
52 object being dragged across different windows, or even
53 applications. Typically used with
54 elm_win_override_set(). */
55 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
56 buffer. No actual window is created for this
57 type, instead the window and all of its
58 contents will be rendered to an image buffer.
59 This allows to have children window inside a
60 parent one just like any other object would
61 be, and do other things like applying @c
62 Evas_Map effects to it. This is the only type
63 of window that requires the @c parent
64 parameter of elm_win_add() to be a valid @c
65 Evas_Object. */
66 ELM_WIN_SOCKET_IMAGE,/**< The window is rendered onto an image buffer
67 and can be shown other process's plug image object.
68 No actual window is created for this type,
69 instead the window and all of its contents will be
70 rendered to an image buffer and can be shown
71 other process's plug image object*/
72 ELM_WIN_FAKE /**< This window was created using a pre-existing canvas.
73 The window widget can be deleted, but the canvas
74 must be managed externally.
75 @since 1.13 */
76} Elm_Win_Type;
77
78/**
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 */
84typedef enum
85{
86 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
87 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
88 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
89 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
90 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
91 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
92 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
93 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
94 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QWERTY) keyboard layout */
95 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
96 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
97 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
98 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
99 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
100 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
101 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
102} Elm_Win_Keyboard_Mode;
103
104/**
105 * In some environments, like phones, you may have an indicator that
106 * shows battery status, reception, time etc. This is the indicator.
107 *
108 * Sometimes you don't want it because you provide the same functionality
109 * inside your app, so this will request that the indicator is hidden in
110 * this circumstance if you use ELM_ILLUME_INDICATOR_HIDE. The default
111 * is to have the indicator shown.
112 */
113typedef enum
114{
115 ELM_WIN_INDICATOR_UNKNOWN, /**< Unknown indicator state */
116 ELM_WIN_INDICATOR_HIDE, /**< Hides the indicator */
117 ELM_WIN_INDICATOR_SHOW /**< Shows the indicator */
118} Elm_Win_Indicator_Mode;
119
120/**
121 * Defines the opacity modes of indicator that can be shown
122 */
123typedef enum
124{
125 ELM_WIN_INDICATOR_OPACITY_UNKNOWN, /**< Unknown indicator opacity mode */
126 ELM_WIN_INDICATOR_OPAQUE, /**< Opacifies the indicator */
127 ELM_WIN_INDICATOR_TRANSLUCENT, /**< Be translucent the indicator */
128 ELM_WIN_INDICATOR_TRANSPARENT /**< Transparentizes the indicator */
129} Elm_Win_Indicator_Opacity_Mode;
130
131/**
132 * Available commands that can be sent to the Illume manager.
133 *
134 * When running under an Illume session, a window may send commands to the
135 * Illume manager to perform different actions.
136 */
137typedef enum
138{
139 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous window */
140 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window in the list */
141 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home screen */
142 ELM_ILLUME_COMMAND_CLOSE, /**< Closes the currently active window */
143} Elm_Illume_Command;
144
145/**
146 * @typedef Elm_Win_Trap 8 * @typedef Elm_Win_Trap
147 * 9 *
148 * Trap can be set with elm_win_trap_set() and will intercept the 10 * Trap can be set with elm_win_trap_set() and will intercept the
diff --git a/src/lib/elm_win_legacy.h b/src/lib/elm_win_legacy.h
index 42a875f45..f38bc45d5 100644
--- a/src/lib/elm_win_legacy.h
+++ b/src/lib/elm_win_legacy.h
@@ -1,3 +1,5 @@
1#include "elm_win.eo.legacy.h"
2
1/** 3/**
2 * Adds a window object. If this is the first window created, pass NULL as 4 * Adds a window object. If this is the first window created, pass NULL as
3 * @p parent. 5 * @p parent.
@@ -225,5 +227,3 @@ EAPI void elm_win_wm_rotation_preferred_rotation_set(const Evas
225 * this is definitely not the function you are looking for. 227 * this is definitely not the function you are looking for.
226 */ 228 */
227EAPI Ecore_Window elm_win_window_id_get(const Evas_Object *obj); 229EAPI Ecore_Window elm_win_window_id_get(const Evas_Object *obj);
228
229#include "elm_win.eo.legacy.h"