forked from enlightenment/efl
docs: fill in all missing item documentation for efl_ui_focus_*
There has been gaps in various files. Makre sure we have them all covered.
This commit is contained in:
parent
39793f4cd5
commit
246b44ed35
|
@ -20,7 +20,7 @@ enum Efl.Ui.Focus.Direction
|
|||
down = 3, [[ down direction ]]
|
||||
right = 4, [[ right direction ]]
|
||||
left = 5, [[ left direction ]]
|
||||
last = 6
|
||||
last = 6 [[ last direction ]]
|
||||
}
|
||||
|
||||
enum Efl.Ui.Interest_Region_Mode
|
||||
|
|
|
@ -39,7 +39,7 @@ mixin Efl.Ui.Focus.Composition (Efl.Interface, Elm.Widget ) {
|
|||
Set to $null to register them in the same manager as the implementor is
|
||||
]]
|
||||
values {
|
||||
custom_manager : Efl.Ui.Focus.Manager;
|
||||
custom_manager : Efl.Ui.Focus.Manager; [[EFL focus manager]]
|
||||
}
|
||||
}
|
||||
@property logical_mode @protected {
|
||||
|
|
|
@ -1,9 +1,11 @@
|
|||
class Efl.Ui.Focus.Composition.Adapter (Efl.Object, Efl.Ui.Focus.Object)
|
||||
{
|
||||
[[EFL UI Focus Composition Adapter class]]
|
||||
methods {
|
||||
@property canvas_object {
|
||||
[[Canvas Object Property]]
|
||||
values {
|
||||
v : Efl.Canvas.Object;
|
||||
v : Efl.Canvas.Object; [[EFL canvas object]]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -7,6 +7,7 @@ mixin Efl.Ui.Focus.Layer (Efl.Interface, Elm.Widget, Efl.Gfx, Efl.Ui.Focus.Manag
|
|||
]]
|
||||
methods {
|
||||
@property enable @protected {
|
||||
[[Enable property]]
|
||||
values {
|
||||
v : bool; [[$true to set enable the layer $false to disable it]]
|
||||
}
|
||||
|
|
|
@ -14,7 +14,7 @@ struct Efl.Ui.Focus.Relations {
|
|||
parent : Efl.Ui.Focus.Object; [[Parent object]]
|
||||
redirect : Efl.Ui.Focus.Manager; [[Redirect manager]]
|
||||
node : Efl.Ui.Focus.Object; [[The node where this is the information from]]
|
||||
logical : bool; [[true if this node is only logical]]
|
||||
logical : bool; [[$true if this node is only logical]]
|
||||
position_in_history : int; [[The position in the history stack]]
|
||||
}
|
||||
|
||||
|
@ -116,9 +116,9 @@ interface Efl.Ui.Focus.Manager {
|
|||
so you can call this function out of a prepare call.
|
||||
]]
|
||||
params {
|
||||
child : Efl.Ui.Focus.Object;
|
||||
child : Efl.Ui.Focus.Object; [[Parent for returned child]]
|
||||
}
|
||||
return : Efl.Ui.Focus.Object;
|
||||
return : Efl.Ui.Focus.Object; [[Child of passed parameter]]
|
||||
}
|
||||
fetch {
|
||||
[[This will fetch the data from a registered node.
|
||||
|
|
|
@ -1,11 +1,12 @@
|
|||
interface Efl.Ui.Focus.Parent_Provider {
|
||||
[[EFL UI Focus Parent Provider interface]]
|
||||
methods {
|
||||
find_logical_parent {
|
||||
[[Called to get the logical parent of widget]]
|
||||
params {
|
||||
widget : Efl.Ui.Focus.Object;
|
||||
widget : Efl.Ui.Focus.Object; [[Object to find parent for]]
|
||||
}
|
||||
return : Efl.Ui.Focus.Object;
|
||||
return : Efl.Ui.Focus.Object; [[Parent of parameter object]]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -1,13 +1,16 @@
|
|||
class Efl.Ui.Focus.Parent_Provider.Gen(Efl.Object, Efl.Ui.Focus.Parent_Provider) {
|
||||
[[EFL UI Focus Parent Provider Gen class]]
|
||||
methods {
|
||||
@property content_item_map {
|
||||
[[Content item map property]]
|
||||
values {
|
||||
map : hash<Elm.Widget, Elm.Widget.Item>;
|
||||
map : hash<Elm.Widget, Elm.Widget.Item>; [[Item map]]
|
||||
}
|
||||
}
|
||||
@property container {
|
||||
[[Container property]]
|
||||
values {
|
||||
container : Elm.Widget;
|
||||
container : Elm.Widget; [[Container widget]]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
class Efl.Ui.Focus.Parent_Provider.Standard(Efl.Object, Efl.Ui.Focus.Parent_Provider) {
|
||||
[[EFL UI Focus Parent Provider Standard Class]]
|
||||
implements {
|
||||
Efl.Ui.Focus.Parent_Provider.find_logical_parent;
|
||||
}
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
class Efl.Ui.Focus.Rectangle (Efl.Canvas.Rectangle, Efl.Ui.Focus.Object)
|
||||
{
|
||||
[[EFL UI Focus Rectangle class]]
|
||||
implements {
|
||||
Efl.Ui.Focus.Object.focus_geometry {get;}
|
||||
Efl.Ui.Focus.Object.focus {set; get;}
|
||||
|
|
|
@ -1,8 +1,10 @@
|
|||
class Efl.Ui.Focus.Util(Efl.Object) {
|
||||
[[EFL UI Focus Util class]]
|
||||
methods {
|
||||
focus @class {
|
||||
[[Focus helper method]]
|
||||
params {
|
||||
focus_elem : Efl.Ui.Focus.Object;
|
||||
focus_elem : Efl.Ui.Focus.Object; [[Focus element]]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue