NorwayFun
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Elm segment control item: migrate docs.

This commit is contained in:
Tom Hacohen 2015-08-06 15:05:42 +01:00
parent a8d6564f2e
commit 94eca6c747
1 changed files with 15 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3,52 +3,33 @@ class Elm.Segment_Control_Item(Elm.Widget_Item)
eo_prefix: elm_obj_segment_control_item;
methods {
index_get @const {
/*@
Get the index of an item.
[[Get the index of an item.
Index is the position of an item in segment control widget. Its
range is from @c 0 to <tt> count - 1 </tt>.
Count is the number of items, that can be get with
elm_segment_control_item_count_get().
Index is the position of an item in segment control widget. Its
range is from 0 to (count - 1).
Count is the number of items, that can be get with elm_segment_control_item_count_get()]]
@return The position of item in segment control widget.
@ingroup SegmentControl
*/
return: int(-1);
return: int(-1); [[The position of item in segment control widget.]]
}
object_get @const {
/*@
Get the real Evas(Edje) object created to implement the view of a given
segment_control @p item.
[[Get the real Evas(Edje) object created to implement the view of a given segment_control item.
Base object is the @c Evas_Object that represents that item.
@return The base Edje object associated with @p it.
@ingroup SegmentControl
*/
return: Evas.Object*;
Base object is the @Evas.Object that represents that item.]]
return: Evas.Object*; [[The base Edje object associated with $it]]
}
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.
Selected item can be got with function
elm_segment_control_item_selected_get().
If a new item is selected the previously selected will be unselected.
Selected item can be got with function elm_segment_control_item_selected_get().
The selected item always will be highlighted on segment control.
The selected item always will be highlighted on segment control.]]
@see elm_segment_control_item_selected_get()
@ingroup SegmentControl
*/
params {
selected: bool; /*@ The selected state. */
selected: bool; [[The selected state.]]
}
}
}