summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-07-24 14:13:56 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-07-24 14:13:56 +0200
commita45cc2d47bd2ce9977d6f42af1868e8ec5813d7c (patch)
tree76b604c9b15587dc525177efc8e3644b29693348
parenta836c73ef61f5557746c5e4d944b01a77bc3a8de (diff)
docs: minor nitpicks to Efl.Ui.Win docs
-rw-r--r--src/lib/elementary/efl_ui_win.eo36
1 files changed, 18 insertions, 18 deletions
diff --git a/src/lib/elementary/efl_ui_win.eo b/src/lib/elementary/efl_ui_win.eo
index bad19808cd..f6f499cbce 100644
--- a/src/lib/elementary/efl_ui_win.eo
+++ b/src/lib/elementary/efl_ui_win.eo
@@ -1,6 +1,6 @@
1enum @beta Efl.Ui.Win_Type 1enum @beta Efl.Ui.Win_Type
2{ 2{
3 [[Defines the types of window that can be created 3 [[Defines the types of window that can be created.
4 4
5 These are hints set on a window so that a running Window Manager knows 5 These are hints set on a window so that a running Window Manager knows
6 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
@@ -9,7 +9,7 @@ enum @beta Efl.Ui.Win_Type
9 Currently, only the X11 backed engines use them. 9 Currently, only the X11 backed engines use them.
10 ]] 10 ]]
11 11
12 unknown = -1, [[Default, unknown, type]] 12 unknown = -1, [[Default, unknown type.]]
13 basic, [[A normal window. Indicates a normal, top-level window. Almost every 13 basic, [[A normal window. Indicates a normal, top-level window. Almost every
14 window will be created with this type.]] 14 window will be created with this type.]]
15 dialog_basic, [[Used for simple dialog windows.]] 15 dialog_basic, [[Used for simple dialog windows.]]
@@ -17,23 +17,23 @@ enum @beta Efl.Ui.Win_Type
17 desktop icons.]] 17 desktop icons.]]
18 dock, [[The window is used as a dock or panel. Usually would be kept on top 18 dock, [[The window is used as a dock or panel. Usually would be kept on top
19 of any other window by the Window Manager.]] 19 of any other window by the Window Manager.]]
20 toolbar, [[The window is used to hold a floating toolbar, or similar.]] 20 toolbar, [[The window is used to hold a floating toolbar or similar.]]
21 menu, [[Similar to @.toolbar.]] 21 menu, [[Similar to @Efl.Ui.Win_Type.toolbar.]]
22 utility, [[A persistent utility window, like a toolbox or palette.]] 22 utility, [[A persistent utility window, like a toolbox or palette.]]
23 splash, [[Splash window for a starting up application.]] 23 splash, [[Splash window for a starting up application.]]
24 dropdown_menu, [[The window is a dropdown menu, as when an entry in a 24 dropdown_menu, [[The window is a dropdown menu, as when an entry in a
25 menubar is clicked. 25 menu bar is clicked.
26 This hint exists for completion only, as the EFL way of 26 This hint exists for completeness' sake, as the EFL way of
27 implementing a menu would not normally use a separate 27 implementing a menu would not normally use a separate
28 window for its contents.]] 28 window for its contents.]]
29 popup_menu, [[Like @.dropdown_menu, but for the menu triggered by 29 popup_menu, [[Like @Efl.Ui.Win_Type.dropdown_menu, but for the menu triggered by
30 right-clicking an object.]] 30 right-clicking an object.]]
31 tooltip, [[The window is a tooltip. A short piece of explanatory text that 31 tooltip, [[The window is a tooltip. A short piece of explanatory text that
32 typically appear after the mouse cursor hovers over an object 32 typically appear after the mouse cursor hovers over an object
33 for a while. Typically not very commonly used in the EFL.]] 33 for a while. Not commonly used in the EFL.]]
34 notification, [[A notification window, like a warning about battery life or 34 notification, [[A notification window, like a warning about battery life or
35 a new E-Mail received.]] 35 a new E-Mail received.]]
36 combo, [[A window holding the contents of a combo box. Not usually used in 36 combo, [[A window holding the contents of a combo box. Not commonly used in
37 the EFL.]] 37 the EFL.]]
38 dnd, [[Internal use.]] 38 dnd, [[Internal use.]]
39 inlined_image, [[Internal use.]] 39 inlined_image, [[Internal use.]]
@@ -73,27 +73,27 @@ enum @beta Efl.Ui.Win_Keyboard_Mode
73 73
74enum Efl.Ui.Win_Indicator_Mode 74enum Efl.Ui.Win_Indicator_Mode
75{ 75{
76 [[Defines the type indicator that can be shown 76 [[Defines the type indicator that can be shown.
77 77
78 @since 1.22 78 @since 1.22
79 ]] 79 ]]
80 off, [[Request to deactivate the indicator]] 80 off, [[Request to deactivate the indicator.]]
81 bg_opaque, [[The indicator icon is opaque, as is the indicator background. 81 bg_opaque, [[The indicator icon is opaque, as is the indicator background.
82 The content of window is located at the end of the indicator. 82 The content of window is located at the end of the indicator.
83 The area of indicator and window content are not overlapped]] 83 The area of indicator and window content are not overlapped.]]
84 bg_transparent, [[The icon of indicator is opaque, but the background is transparent. 84 bg_transparent, [[The icon of indicator is opaque, but the background is transparent.
85 The content of window is located under the indicator in Z-order. 85 The content of window is located under the indicator in Z-order.
86 The area of indicator and window content are overlapped]] 86 The area of indicator and window content are overlapped.]]
87 hidden [[The indicator is hidden so user can see only the content of window such as in video mode. 87 hidden [[The indicator is hidden so user can see only the content of window such as in video mode.
88 If user flicks the upper side of window, the indicator is shown temporarily.]] 88 If user flicks the upper side of window, the indicator is shown temporarily.]]
89} 89}
90 90
91enum @beta Efl.Ui.Win_Modal_Mode 91enum @beta Efl.Ui.Win_Modal_Mode
92{ 92{
93 [[Defines the mode of a modal window]] 93 [[Defines the mode of a modal window.]]
94 94
95 none, [[The window is not modal window.]] 95 none, [[The window is not a modal window.]]
96 modal [[The window is modal window.]] 96 modal [[The window is a modal window.]]
97} 97}
98 98
99enum @beta Efl.Ui.Win_Urgent_Mode 99enum @beta Efl.Ui.Win_Urgent_Mode
@@ -106,7 +106,7 @@ enum @beta Efl.Ui.Win_Urgent_Mode
106 106
107enum Efl.Ui.Win_Move_Resize_Mode 107enum Efl.Ui.Win_Move_Resize_Mode
108{ 108{
109 [[Define the move or resize mode of window. 109 [[Define the move or resize mode of a window.
110 110
111 The user can request the display server to start moving or resizing 111 The user can request the display server to start moving or resizing
112 the window by combining these modes. However only limited combinations 112 the window by combining these modes. However only limited combinations
@@ -140,7 +140,7 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W
140 Efl.Text, Efl.Config, 140 Efl.Text, Efl.Config,
141 Efl.Ui.Widget_Focus_Manager, Efl.Ui.Focus.Manager_Window_Root 141 Efl.Ui.Widget_Focus_Manager, Efl.Ui.Focus.Manager_Window_Root
142{ 142{
143 [[Efl UI window class 143 [[Efl UI window class.
144 144
145 @since 1.22 145 @since 1.22
146 ]] 146 ]]