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

Elm index item: migrate docs.

This commit is contained in:
Tom Hacohen 2015-08-06 14:59:32 +01:00
parent 7dbbbca898
commit a8d6564f2e
1 changed files with 16 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
legacy/elementary/src/lib/elm_index_item.eo
View File

@ -4,55 +4,38 @@ class Elm.Index_Item(Elm.Widget_Item)
methods {
@property selected {
set {
/*@
Set the selected state of an item.
[[Set the selected state of an item.
This sets the selected state of the given item @p it.
@c EINA_TRUE for selected, @c EINA_FALSE for not selected.
This sets the selected state of the given item $it.
$true for selected, $false for not selected.
If a new item is selected the previously selected will be unselected.
Previously selected item can be get with function
elm_index_selected_item_get().
If a new item is selected the previously selected will be unselected.
Previously selected item can be get with function
elm_index_selected_item_get().
Selected items will be highlighted.
@see elm_index_selected_item_get()
@ingroup Index
*/
Selected items will be highlighted.]]
}
values {
selected: bool; /*@ EINA_TRUE if selected EINA_FALSE otherwise */
selected: bool; [[$true if selected, $false otherwise]]
}
}
@property priority {
set {
/*@
Sets the priority of an item.
[[Sets the priority of an item.
The priority is @c -1 by default, which means that the item doesn't belong to a group.
The value of the priority starts from @c 0.
The priority is -1 by default, which means that the item doesn't belong to a group.
The value of the priority starts from 0.
In elm_index_level_go, the items are sorted in ascending order according to priority.
Items of the same priority make a group and the primary group is shown by default.
@see elm_index_item_priority_get()
@ingroup Index
*/
In elm_index_level_go, the items are sorted in ascending order according to priority.
Items of the same priority make a group and the primary group is shown by default.]]
}
values {
priority: int; /*@ The priority */
priority: int; [[The priority]]
}
}
letter_get @const {
/*@
Get the letter (string) set on a given index widget item.
@return The letter string set on @p item
@ingroup Index
*/
return: const (char)*;
[[Get the letter (string) set on a given index widget item.]]
return: const (char)*; [[The letter string set on $item]]
}
}
implements {