forked from enlightenment/efl
docs: elm: fill gaps in hover, hoversel and notify eo file documentation
This commit is contained in:
parent
58a3fea061
commit
c52bd50eba
|
@ -9,6 +9,7 @@ enum Elm.Hover.Axis
|
|||
|
||||
class Elm.Hover (Elm.Layout, Efl.Ui.Clickable, Elm.Interface.Atspi_Widget_Action)
|
||||
{
|
||||
[[Elementary hover class]]
|
||||
legacy_prefix: elm_hover;
|
||||
eo_prefix: elm_obj_hover;
|
||||
event_prefix: elm_hover;
|
||||
|
@ -47,7 +48,7 @@ class Elm.Hover (Elm.Layout, Efl.Ui.Clickable, Elm.Interface.Atspi_Widget_Action
|
|||
|
||||
See also \@ref elm_object_part_content_set.
|
||||
]]
|
||||
return: string;
|
||||
return: string; [[Swallow location]]
|
||||
params {
|
||||
@in pref_axis: Elm.Hover.Axis; [[The preferred orientation axis
|
||||
for the hover object to use]]
|
||||
|
@ -77,8 +78,7 @@ class Elm.Hover (Elm.Layout, Efl.Ui.Clickable, Elm.Interface.Atspi_Widget_Action
|
|||
Efl.Part.part;
|
||||
}
|
||||
events {
|
||||
smart,changed;
|
||||
dismissed;
|
||||
smart,changed; [[Called when hover changed]]
|
||||
dismissed; [[Called when hover was dismissed]]
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
class Elm.Hover.Internal.Part (Elm.Layout.Internal.Part)
|
||||
{
|
||||
[[elementary hover internal part class]]
|
||||
data: null;
|
||||
implements {
|
||||
Efl.Container.content.set;
|
||||
|
|
|
@ -3,6 +3,7 @@ class Elm.Hoversel (Elm.Button, Efl.Ui.Selectable,
|
|||
Efl.Ui.Clickable,
|
||||
Elm.Interface.Atspi_Widget_Action)
|
||||
{
|
||||
[[Elementary hoversel class]]
|
||||
legacy_prefix: elm_hoversel;
|
||||
eo_prefix: elm_obj_hoversel;
|
||||
event_prefix: elm_hoversel;
|
||||
|
@ -42,7 +43,7 @@ class Elm.Hoversel (Elm.Button, Efl.Ui.Selectable,
|
|||
@property items {
|
||||
get {
|
||||
[[Get the list of items within the given hoversel.]]
|
||||
return: const(list<Elm.Widget.Item>);
|
||||
return: const(list<Elm.Widget.Item>); [[List of items]]
|
||||
}
|
||||
}
|
||||
@property auto_update {
|
||||
|
@ -103,10 +104,9 @@ class Elm.Hoversel (Elm.Button, Efl.Ui.Selectable,
|
|||
Elm.Interface.Atspi_Widget_Action.elm_actions.get;
|
||||
}
|
||||
events {
|
||||
dismissed;
|
||||
expanded;
|
||||
item,focused;
|
||||
item,unfocused;
|
||||
dismissed; [[Called when hoversel is dismissed]]
|
||||
expanded; [[Called when hoversel is expanded]]
|
||||
item,focused; [[Called when hoversel item got focus]]
|
||||
item,unfocused; [[Called when hoversel item lost focus]]
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
@ -2,6 +2,7 @@ import elm_icon;
|
|||
|
||||
class Elm.Hoversel.Item(Elm.Widget.Item)
|
||||
{
|
||||
[[Elementary hoversel item class]]
|
||||
legacy_prefix: elm_hoversel_item;
|
||||
eo_prefix: elm_obj_hoversel_item;
|
||||
methods {
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
class Elm.Notify (Elm.Widget, Efl.Container, Efl.Part)
|
||||
{
|
||||
[[Elementary notification class]]
|
||||
legacy_prefix: elm_notify;
|
||||
eo_prefix: elm_obj_notify;
|
||||
event_prefix: elm_notify;
|
||||
|
@ -42,7 +43,7 @@ class Elm.Notify (Elm.Widget, Efl.Container, Efl.Part)
|
|||
[[Return true if events are allowed below the notify object.]]
|
||||
}
|
||||
values {
|
||||
allow: bool; [[true if events are allowed, otherwise false]]
|
||||
allow: bool; [[$true if events are allowed, $false otherwise]]
|
||||
}
|
||||
}
|
||||
@property timeout {
|
||||
|
@ -99,9 +100,8 @@ class Elm.Notify (Elm.Widget, Efl.Container, Efl.Part)
|
|||
Efl.Part.part;
|
||||
}
|
||||
events {
|
||||
block,clicked;
|
||||
timeout;
|
||||
dismissed;
|
||||
block,clicked; [[Called when block was clicked]]
|
||||
timeout; [[Called when notify timed out]]
|
||||
dismissed; [[Called when notify was dismissed]]
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
class Elm.Notify.Internal.Part (Efl.Object, Efl.Container)
|
||||
{
|
||||
[[Elementary notification internel part class]]
|
||||
data: Elm_Part_Data;
|
||||
implements {
|
||||
Efl.Object.destructor;
|
||||
|
|
Loading…
Reference in New Issue