enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 1 Projects Releases Wiki Activity

menu_item: convert docs

This commit is contained in:
Daniel Kolesa 2015-07-31 15:23:56 +01:00
parent 5bb43d7edf
commit 61a9917a3d
1 changed files with 27 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
legacy/elementary/src/lib/elm_menu_item.eo
View File

@ -4,118 +4,72 @@ class Elm.Menu_Item(Elm.Widget_Item)
methods {
@property icon_name {
get {
/*@
Get the string representation from the icon of a menu item
[[Get the string representation from the icon of a menu item
Once this icon is set, any previously set icon will be deleted.
To hide icon set it to "".
@see elm_menu_item_icon_name_set()
@ingroup Menu
*/
]]
}
set {
/*@
Set the icon of a menu item to the standard icon with name @p icon
[[Set the icon of a menu item to the standard icon with the
given name.
Once this icon is set, any previously set icon will be deleted.
To hide icon set it to "".
@ingroup Menu
*/
]]
}
values {
icon: const (char)*; /*@ The name of icon object */
icon: const (char)*; [[The name of icon object.]]
}
}
@property selected {
get {
/*@
Get the selected state of @p item.
@see elm_menu_item_selected_set()
@ingroup Menu
*/
[[Get the selected state of $item.]]
}
set {
/*@
Set the selected state of @p item.
@ingroup Menu
*/
[[Set the selected state of $item.]]
}
values {
selected: bool; /*@ EINA_TRUE if selected EINA_FALSE otherwise */
selected: bool; [[The selection state.]]
}
}
prev_get @const {
/*@
Get the previous item in the menu.
@ingroup Menu
*/
[[Get the previous item in the menu.]]
return: Elm_Object_Item*;
}
next_get @const {
/*@
Get the next item in the menu.
@ingroup Menu
*/
[[Get the next item in the menu.]]
return: Elm_Object_Item*;
}
index_get @const {
/*@
Get the next item in the menu.
@ingroup Menu
*/
[[Get the next item in the menu.]]
return: uint;
}
subitems_clear {
/*@
Remove all sub-items (children) of the given item
@since 1.8
[[Remove all sub-items (children) of the given item
This removes all items that are children (and their descendants) of the
given item @p it.
This removes all items that are children (and their descendants)
of the given item $it.
@see elm_object_item_del()
@ingroup Menu
*/
@since 1.8
]]
}
subitems_get @const {
/*@
Returns a list of @p item's subitems.
@see elm_menu_add()
@ingroup Menu
*/
return: const (list<Elm_Object_Item *>) *; /*@ An Eina_List* of @p item's subitems */
[[Returns a list of $item's subitems.]]
return: const (list<Elm_Object_Item *>) *; [[a list of $item's subitems]]
}
is_separator @const {
/*@
Returns whether @p item is a separator.
@see elm_menu_item_separator_add()
@ingroup Menu
*/
return: bool; /*@ If true, @p item is a separator */
[[Returns whether $item is a separator.]]
return: bool; [[$true if the item is a separator.]]
}
object_get @const {
/*@
Get the real Evas(Edje) object created to implement the view of a given
menu @p item.
[[Get the real Evas(Edje) object created to implement the view of
a given menu item.
@warning Don't manipulate this object!
@ingroup Menu
*/
return: Evas.Object*; /*@ The base Edje object containing the swallowed content associated with@p it. */
Warning: Don't manipulate this object!
]]
return: Evas.Object*; [[The base Edje object containing the
swallowed content associated with the item.]]
}
}
implements {