aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-11-22 14:52:03 +0100
committerStefan Schmidt <stefan@osg.samsung.com>2016-11-22 16:42:13 +0100
commit843bee8c779a058c27d4eb792f94178681b84b19 (patch)
tree30cde5c7351a56f8af03fe4351415c19a945e3a3 /src
parentdocs: elm_colorselector: fill gaps in elm_colorselector eo file documentation (diff)
downloadefl-843bee8c779a058c27d4eb792f94178681b84b19.tar.gz
docs: elm_menu: fill gaps in elm_menu eo file documentation
Diffstat (limited to '')
-rw-r--r--src/lib/elementary/elm_menu.eo18
-rw-r--r--src/lib/elementary/elm_menu_item.eo11
2 files changed, 15 insertions, 14 deletions
diff --git a/src/lib/elementary/elm_menu.eo b/src/lib/elementary/elm_menu.eo
index d0777bf861..87a79836db 100644
--- a/src/lib/elementary/elm_menu.eo
+++ b/src/lib/elementary/elm_menu.eo
@@ -1,5 +1,6 @@
class Elm.Menu (Elm.Widget, Efl.Ui.Clickable, Elm.Interface.Atspi.Selection)
{
+ [[Elementary menu class]]
legacy_prefix: elm_menu;
eo_prefix: elm_obj_menu;
event_prefix: elm_menu;
@@ -13,19 +14,19 @@ class Elm.Menu (Elm.Widget, Efl.Ui.Clickable, Elm.Interface.Atspi.Selection)
@property items {
get {
[[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 {
get {
[[Get the first item in the menu.]]
- return: Elm.Widget.Item;
+ return: Elm.Widget.Item; [[First item in menu]]
}
}
@property last_item {
get {
[[Get the last item in the menu.]]
- return: Elm.Widget.Item;
+ return: Elm.Widget.Item; [[Last item in menu]]
}
}
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.
]]
params {
- @in x: Evas.Coord; [[The new position.]]
- @in y: Evas.Coord; [[The new position.]]
+ @in x: Evas.Coord; [[The new X coordinate]]
+ @in y: Evas.Coord; [[The new Y coordinate]]
}
}
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;
}
events {
- dismissed;
- elm,action,block_menu;
- elm,action,unblock_menu;
+ dismissed; [[Called when menu widget was dismissed]]
+ elm,action,block_menu; [[Called when menu blocking have been enabled]]
+ elm,action,unblock_menu; [[Called when menu blocking has been disabled]]
}
-
}
diff --git a/src/lib/elementary/elm_menu_item.eo b/src/lib/elementary/elm_menu_item.eo
index 2a49a21f7e..be56cfcab6 100644
--- a/src/lib/elementary/elm_menu_item.eo
+++ b/src/lib/elementary/elm_menu_item.eo
@@ -1,5 +1,6 @@
class Elm.Menu.Item(Elm.Widget.Item, Elm.Interface.Atspi.Selection)
{
+ [[Elementary menu item class]]
legacy_prefix: elm_menu_item;
eo_prefix: elm_obj_menu_item;
methods {
@@ -36,15 +37,15 @@ class Elm.Menu.Item(Elm.Widget.Item, Elm.Interface.Atspi.Selection)
}
prev_get @const {
[[Get the previous item in the menu.]]
- return: Elm.Widget.Item;
+ return: Elm.Widget.Item; [[Item object]]
}
next_get @const {
[[Get the next item in the menu.]]
- return: Elm.Widget.Item;
+ return: Elm.Widget.Item; [[Item object]]
}
index_get @const {
- [[Get the next item in the menu.]]
- return: uint;
+ [[Get the item index]]
+ return: uint; [[Item index]]
}
subitems_clear {
[[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 {
[[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 {
[[Returns whether $item is a separator.]]