summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorMarcel Hollerbach <mail@marcel-hollerbach.de>2019-02-17 17:56:32 +0100
committerMarcel Hollerbach <mail@marcel-hollerbach.de>2019-02-22 14:00:29 +0100
commit113cb3b97cb92e57416d9c088527e9bdab46f782 (patch)
treeae6b0ade9803284b2ac78ad8b269f9b87fe5bed4 /src
parent93903a7ba3c444be4255724dd02488a8c83a01a4 (diff)
efl_ui_focus_manager: improve docs
Reviewed-by: Xavi Artigas <xavierartigas@yahoo.es> Differential Revision: https://phab.enlightenment.org/D7991
Diffstat (limited to 'src')
-rw-r--r--src/lib/elementary/efl_ui_focus_manager.eo39
1 files changed, 19 insertions, 20 deletions
diff --git a/src/lib/elementary/efl_ui_focus_manager.eo b/src/lib/elementary/efl_ui_focus_manager.eo
index b87f99fa49..5eb2e17d59 100644
--- a/src/lib/elementary/efl_ui_focus_manager.eo
+++ b/src/lib/elementary/efl_ui_focus_manager.eo
@@ -29,11 +29,10 @@ struct Efl.Ui.Focus.Manager_Logical_End_Detail {
29} 29}
30 30
31interface @beta Efl.Ui.Focus.Manager { 31interface @beta Efl.Ui.Focus.Manager {
32 [[Calculates the directions of Efl.Ui.Focus.Direction 32 [[Interface for managing focus objects
33 33
34 Each registered item will get a other registered object into each 34 This interface is build in order to support movement of the focus property in a set of widgets.
35 direction, you can get those items for the currently focused item if 35 The movement of the focus property can happen in a tree manner, or a graph manner. The movements is also keeping track of the history of focused elements. The tree interpretation differentiates between logical and none-logical widgets, a logical widget cannot receive focus, a none-logical can.
36 you call request move.
37 36
38 @since 1.20 37 @since 1.20
39 ]] 38 ]]
@@ -92,10 +91,10 @@ interface @beta Efl.Ui.Focus.Manager {
92 } 91 }
93 } 92 }
94 @property viewport_elements { 93 @property viewport_elements {
95 [[The list of elements which are at the border of the viewport. 94 [[Get all elements that are at the border of the viewport
96 95
97 This means one of the relations right,left or down,up are not set. 96 Every element returned by this is located in the viewport rectangle,
98 This call flushes all changes. See @Efl.Ui.Focus.Manager.move 97 but has a right,left,down or up relation outside the viewport.
99 ]] 98 ]]
100 get {} 99 get {}
101 keys { 100 keys {
@@ -124,14 +123,14 @@ interface @beta Efl.Ui.Focus.Manager {
124 } 123 }
125 } 124 }
126 request_subchild { 125 request_subchild {
127 [[Returns a widget that can receive focus 126 [[Return the widget in the direction next.
128 127
129 The returned widget is in a child of the passed param. 128 The returned widget is a child of $root.
130 Its garanteed that child will not be prepared once again, 129 Its garanteed that child will not be prepared once again,
131 so you can call this function out of a prepare call. 130 so you can call this function out of a prepare call.
132 ]] 131 ]]
133 params { 132 params {
134 child : Efl.Ui.Focus.Object; [[Parent for returned child]] 133 root : Efl.Ui.Focus.Object; [[Parent for returned child]]
135 } 134 }
136 return : Efl.Ui.Focus.Object; [[Child of passed parameter]] 135 return : Efl.Ui.Focus.Object; [[Child of passed parameter]]
137 } 136 }
@@ -157,17 +156,20 @@ interface @beta Efl.Ui.Focus.Manager {
157 [[Reset the history stack of this manager object. 156 [[Reset the history stack of this manager object.
158 This means the most upper element will be unfocused, all other elements will be removed from the remembered before. 157 This means the most upper element will be unfocused, all other elements will be removed from the remembered before.
159 158
160 To not break the assertion that there should be always a focused element, you should focus a other element immidiatly after calling that. 159 To not break the assertion that there should be always a focused element, you should focus a other element immidiatly after calling this.
161 ]] 160 ]]
162 } 161 }
163 pop_history_stack { 162 pop_history_stack {
164 [[Removes the most upper history element, and move focus on. 163 [[Remove the most upper history element, and focus the next possible element
165 164
166 If there is a element that was focused before, it will be taken. Otherwise, the best fitting element from the registered elements will be focused. 165 If there is a element that was focused before, it will be taken. Otherwise, the best fitting element from the registered elements will be focused.
167 ]] 166 ]]
168 } 167 }
169 setup_on_first_touch { 168 setup_on_first_touch {
170 [[Called when this manager is set as redirect]] 169 [[Called when this manager is set as redirect.
170
171 In case that this is called as an result of a move call, $direction and $entry will be set to the direction of the move call, and the entry object will be set to the object, that had this object as redirect property.
172 ]]
171 params { 173 params {
172 direction : Efl.Ui.Focus.Direction; [[The direction in which this should be setup]] 174 direction : Efl.Ui.Focus.Direction; [[The direction in which this should be setup]]
173 entry : Efl.Ui.Focus.Object; [[The object that caused this manager to be redirect]] 175 entry : Efl.Ui.Focus.Object; [[The object that caused this manager to be redirect]]
@@ -187,13 +189,10 @@ interface @beta Efl.Ui.Focus.Manager {
187 } 189 }
188 } 190 }
189 events { 191 events {
190 redirect,changed : Efl.Ui.Focus.Manager; [[Emitted when the redirect 192 redirect,changed : Efl.Ui.Focus.Manager; [[Redirect object has changed, the old manager is passed as event info]]
191 object has changed, the old manager is passed as event info]] 193 flush,pre: void; [[Next to this event, the manager object will calculate relations in the graph. Can be used to add / remove children in a lazy manner]]
192 flush,pre: void; [[Emitted once the graph calculationg will be performed]] 194 coords,dirty: void; [[Cached calculation results have been invalidated]]
193 coords,dirty: void; [[Emitted once the graph is dirty, this means there are 195 manager_focus,changed : Efl.Ui.Focus.Object; [[the manager_focus property has changed, the previous focused object is passed as event argument]]
194 potential changes in border_elements you want to know about]]
195 manager_focus,changed : Efl.Ui.Focus.Object; [[Emitted if the manager has focused an
196 object, the passed focus object is the last focused object]]
197 dirty_logic_freeze,changed : bool; [[Called when this focus manager is frozen or unfrozen, even_info beeing $true indicates that it is now frozen, $false indicates that it is unfrozen.]] 196 dirty_logic_freeze,changed : bool; [[Called when this focus manager is frozen or unfrozen, even_info beeing $true indicates that it is now frozen, $false indicates that it is unfrozen.]]
198 } 197 }
199} 198}