efl/src/lib/elementary/elm_list_item.eo

122 lines
4.2 KiB
Plaintext
Raw Normal View History

class Elm.List.Item(Elm.Widget.Item, Efl.Ui.Legacy)
2014-09-27 22:15:48 -07:00
{
[[Elementary list item class]]
legacy_prefix: elm_list_item;
2014-09-27 22:15:48 -07:00
eo_prefix: elm_obj_list_item;
2015-05-07 09:32:53 -07:00
methods {
@property separator {
2014-09-27 22:15:48 -07:00
get {
2015-08-05 03:44:39 -07:00
[[Get a value whether item is a separator or not.]]
2014-09-27 22:15:48 -07:00
}
set {
2015-08-05 03:44:39 -07:00
[[Set or unset item as a separator.
2014-09-27 22:15:48 -07:00
2015-08-05 03:44:39 -07:00
Items aren't set as separator by default.
2014-09-27 22:15:48 -07:00
2015-08-05 03:44:39 -07:00
If set as separator it will display separator theme,
so won't display icons or label.
]]
2014-09-27 22:15:48 -07:00
}
values {
2015-08-05 03:44:39 -07:00
setting: bool; [[$true means item $it is a separator.
$false indicates it's not.]]
2014-09-27 22:15:48 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property selected {
2014-09-27 22:15:48 -07:00
get {
2015-08-05 03:44:39 -07:00
[[Get whether the item is selected or not.]]
2014-09-27 22:15:48 -07:00
}
set {
2015-08-05 03:44:39 -07:00
[[Set the selected state of an item.
2014-09-27 22:15:48 -07:00
2015-08-05 03:44:39 -07:00
This sets the selected state of the given item.
2014-09-27 22:15:48 -07:00
2015-08-05 03:44:39 -07:00
If a new item is selected the previously selected
will be unselected, unless multiple selection is
enabled with \@ref elm_list_multi_select_set.
Previously selected item can be get with function
\@ref elm_list_selected_item_get.
2014-09-27 22:15:48 -07:00
2015-08-05 03:44:39 -07:00
Selected items will be highlighted.
]]
2014-09-27 22:15:48 -07:00
}
values {
2015-08-05 03:44:39 -07:00
selected: bool; [[The selected state.]]
2014-09-27 22:15:48 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property object {
2014-09-27 22:15:48 -07:00
get {
2015-08-05 03:44:39 -07:00
[[Get the real Evas(Edje) object created to implement
the view of a given list item.
2014-09-27 22:15:48 -07:00
2015-08-05 03:44:39 -07:00
Base object is the $Evas_Object that represents that
item.
]]
2014-09-27 22:15:48 -07:00
}
values {
obj: Efl.Canvas.Object; [[The base Edje object associated with the item.]]
2014-09-27 22:15:48 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property prev {
2014-09-27 22:15:48 -07:00
get {
2015-08-05 03:44:39 -07:00
[[Get the item before the item in list.
2014-09-27 22:15:48 -07:00
2015-08-05 03:44:39 -07:00
Note: If it is the first item, $null will be returned.
]]
legacy: elm_list_item_prev;
2014-09-27 22:15:48 -07:00
}
values {
item: Elm.Widget.Item; [[The item before or $null.]]
2014-09-27 22:15:48 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property next {
2014-09-27 22:15:48 -07:00
get {
2015-08-05 03:44:39 -07:00
[[Get the item after the item in list.
2014-09-27 22:15:48 -07:00
2015-08-05 03:44:39 -07:00
Note: If it is the last item, $null will be returned.
]]
legacy: elm_list_item_next;
2014-09-27 22:15:48 -07:00
}
values {
item: Elm.Widget.Item; [[The item after or $null.]]
2014-09-27 22:15:48 -07:00
}
}
/* init { FIXME
params {
Evas_Smart_Cb func;
const(void_ptr) data;
2014-09-27 22:15:48 -07:00
}
}*/
show {
2015-08-05 03:44:39 -07:00
[[Show item in the list view.
2014-09-27 22:15:48 -07:00
2015-08-05 03:44:39 -07:00
It won't animate list until item is visible. If such
behavior is wanted, use @.bring_in instead.
]]
2014-09-27 22:15:48 -07:00
}
bring_in {
2015-08-05 03:44:39 -07:00
[[Bring in the given item to list view.
2014-09-27 22:15:48 -07:00
2015-08-05 03:44:39 -07:00
This causes list to jump to the given item and show it
(by scrolling), if it is not fully visible.
2014-09-27 22:15:48 -07:00
2015-08-05 03:44:39 -07:00
This may use animation to do so and take a period of time.
2014-09-27 22:15:48 -07:00
2015-08-05 03:44:39 -07:00
If animation isn't wanted, @.show can be used.
]]
2014-09-27 22:15:48 -07:00
}
}
implements {
Efl.Object.constructor;
Elm.Widget.Item.disable;
Elm.Widget.Item.del_pre;
Elm.Widget.Item.signal_emit;
2018-02-14 18:14:52 -08:00
Elm.Widget.Item.item_focus { get; set; }
Elm.Widget.Item.part_text { get; set; }
Elm.Widget.Item.part_content { get; set; }
Elm.Widget.Item.part_content_unset;
Efl.Access.Object.i18n_name { get; }
Efl.Access.Object.state_set { get; }
2014-09-27 22:15:48 -07:00
}
}