enlightenment/efl
enlightenment
/
efl
8
7
Fork 15
Code Issues 12 Pull Requests 1 Projects Releases Wiki Activity

docs: elm_menu: fill gaps in elm_menu eo file documentation

This commit is contained in:
Stefan Schmidt 2016-11-22 14:52:03 +01:00
parent 79b65a90aa
commit 843bee8c77
2 changed files with 15 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/lib/elementary/elm_menu.eo
View File

@ -1,5 +1,6 @@
class Elm.Menu (Elm.Widget, Efl.Ui.Clickable, Elm.Interface.Atspi.Selection) class Elm.Menu (Elm.Widget, Efl.Ui.Clickable, Elm.Interface.Atspi.Selection)
{ {
[[Elementary menu class]]
legacy_prefix: elm_menu; legacy_prefix: elm_menu;
eo_prefix: elm_obj_menu; eo_prefix: elm_obj_menu;
event_prefix: elm_menu; event_prefix: elm_menu;
@ -13,19 +14,19 @@ class Elm.Menu (Elm.Widget, Efl.Ui.Clickable, Elm.Interface.Atspi.Selection)
@property items { @property items {
get { get {
[[Returns a list of the item's items.]] [[Returns a list of the item's items.]]
return: const(list<Elm.Widget.Item>); return: const(list<Elm.Widget.Item>); [[List of menu items]]
} }
} }
@property first_item { @property first_item {
get { get {
[[Get the first item in the menu.]] [[Get the first item in the menu.]]
return: Elm.Widget.Item; return: Elm.Widget.Item; [[First item in menu]]
} }
} }
@property last_item { @property last_item {
get { get {
[[Get the last item in the menu.]] [[Get the last item in the menu.]]
return: Elm.Widget.Item; return: Elm.Widget.Item; [[Last item in menu]]
} }
} }
move { move {
@ -36,8 +37,8 @@ class Elm.Menu (Elm.Widget, Efl.Ui.Clickable, Elm.Interface.Atspi.Selection)
Note: $x and $y coordinates are relative to parent. Note: $x and $y coordinates are relative to parent.
]] ]]
params { params {
@in x: Evas.Coord; [[The new position.]] @in x: Evas.Coord; [[The new X coordinate]]
@in y: Evas.Coord; [[The new position.]] @in y: Evas.Coord; [[The new Y coordinate]]
} }
} }
item_add { item_add {
@ -83,9 +84,8 @@ class Elm.Menu (Elm.Widget, Efl.Ui.Clickable, Elm.Interface.Atspi.Selection)
Elm.Interface.Atspi.Selection.selected_child.get; Elm.Interface.Atspi.Selection.selected_child.get;
} }
events { events {
dismissed; dismissed; [[Called when menu widget was dismissed]]
elm,action,block_menu; elm,action,block_menu; [[Called when menu blocking have been enabled]]
elm,action,unblock_menu; elm,action,unblock_menu; [[Called when menu blocking has been disabled]]
} }
} }

11
src/lib/elementary/elm_menu_item.eo
View File

@ -1,5 +1,6 @@
class Elm.Menu.Item(Elm.Widget.Item, Elm.Interface.Atspi.Selection) class Elm.Menu.Item(Elm.Widget.Item, Elm.Interface.Atspi.Selection)
{ {
[[Elementary menu item class]]
legacy_prefix: elm_menu_item; legacy_prefix: elm_menu_item;
eo_prefix: elm_obj_menu_item; eo_prefix: elm_obj_menu_item;
methods { methods {
@ -36,15 +37,15 @@ class Elm.Menu.Item(Elm.Widget.Item, Elm.Interface.Atspi.Selection)
} }
prev_get @const { prev_get @const {
[[Get the previous item in the menu.]] [[Get the previous item in the menu.]]
return: Elm.Widget.Item; return: Elm.Widget.Item; [[Item object]]
} }
next_get @const { next_get @const {
[[Get the next item in the menu.]] [[Get the next item in the menu.]]
return: Elm.Widget.Item; return: Elm.Widget.Item; [[Item object]]
} }
index_get @const { index_get @const {
[[Get the next item in the menu.]] [[Get the item index]]
return: uint; return: uint; [[Item index]]
} }
subitems_clear { subitems_clear {
[[Remove all sub-items (children) of the given item [[Remove all sub-items (children) of the given item
@ -57,7 +58,7 @@ class Elm.Menu.Item(Elm.Widget.Item, Elm.Interface.Atspi.Selection)
} }
subitems_get @const { subitems_get @const {
[[Returns a list of $item's subitems.]] [[Returns a list of $item's subitems.]]
return: const(list<Elm.Widget.Item>); [[a list of $item's subitems]] return: const(list<Elm.Widget.Item>); [[A list of $item's subitems]]
} }
is_separator @const { is_separator @const {
[[Returns whether $item is a separator.]] [[Returns whether $item is a separator.]]