440 lines
20 KiB
Plaintext
440 lines
20 KiB
Plaintext
import elm_general;
|
|
|
|
class Elm.List extends Efl.Ui.Layout implements Elm.Interface_Scrollable,
|
|
Efl.Access.Widget.Action, Efl.Access.Selection, Efl.Access.Object,
|
|
Efl.Ui.Clickable, Efl.Ui.Selectable, Efl.Ui.Legacy
|
|
{
|
|
[[Elementary list class]]
|
|
legacy_prefix: elm_list;
|
|
eo_prefix: elm_obj_list;
|
|
event_prefix: elm_list;
|
|
methods {
|
|
@property horizontal {
|
|
[[Control horizontal mode on the list object.
|
|
|
|
Note: Vertical mode is set by default.
|
|
|
|
On horizontal mode items are displayed on list from left to right,
|
|
instead of from top to bottom. Also, the list will scroll horizontally.
|
|
Each item will presents left icon on top and right icon, or end, at
|
|
the bottom.]]
|
|
set {
|
|
}
|
|
get {
|
|
}
|
|
values {
|
|
horizontal: bool; [[$true to enable horizontal or $false to disable it, i.e., to enable vertical mode.]]
|
|
}
|
|
}
|
|
@property select_mode {
|
|
[[Control the list select mode.
|
|
|
|
elm_list_select_mode_set() changes item select mode in the list widget.
|
|
- #ELM_OBJECT_SELECT_MODE_DEFAULT : Items will only call their selection func and
|
|
callback when first becoming selected. Any further clicks will
|
|
do nothing, unless you set always select mode.
|
|
- #ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected,
|
|
every click will make the selected callbacks be called.
|
|
- #ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select items
|
|
entirely and they will neither appear selected nor call selected
|
|
callback functions.]]
|
|
set {
|
|
}
|
|
get {
|
|
}
|
|
values {
|
|
mode: Elm.Object.Select_Mode(Elm.Object.Select_Mode.max); [[The select mode]]
|
|
}
|
|
}
|
|
@property focus_on_selection {
|
|
[[Control focus upon items selection mode
|
|
|
|
When enabled, every selection of an item inside the genlist will automatically set focus to
|
|
its first focusable widget from the left. This is true of course if the selection was made by
|
|
clicking an unfocusable area in an item or selecting it with a key movement. Clicking on a
|
|
focusable widget inside an item will cause this particular item to get focus as usual.]]
|
|
set {
|
|
}
|
|
get {
|
|
}
|
|
values {
|
|
enabled: bool; [[The tree effect status ($true = enabled, $false = disabled)]]
|
|
}
|
|
}
|
|
@property multi_select {
|
|
[[Control multiple items selection on the list object.
|
|
|
|
Disabled by default. If disabled, the user can select a single item of
|
|
the list each time. Selected items are highlighted on list.
|
|
If enabled, many items can be selected.
|
|
|
|
If a selected item is selected again, it will be unselected.]]
|
|
set {
|
|
}
|
|
get {
|
|
}
|
|
values {
|
|
multi: bool; [[$true to enable multi selection or $false to disable it.]]
|
|
}
|
|
}
|
|
@property multi_select_mode {
|
|
[[Control the list multi select mode.
|
|
|
|
- #ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT : select/unselect items whenever each
|
|
item is clicked.
|
|
- #ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL : Only one item will be selected
|
|
although multi-selection is enabled, if clicked without pressing control
|
|
key. This mode is only available with multi-selection.
|
|
|
|
See: @.multi_select
|
|
|
|
@since 1.8]]
|
|
set {
|
|
}
|
|
get {
|
|
}
|
|
values {
|
|
mode: Elm.Object.Multi_Select_Mode(Elm.Object.Multi_Select_Mode.max); [[The multi select mode]]
|
|
}
|
|
}
|
|
@property mode {
|
|
[[Control which mode to use for the list object.
|
|
|
|
Set list's resize behavior, transverse axis scroll and
|
|
items cropping. See each mode's description for more details.
|
|
|
|
Note: Default value is #ELM_LIST_SCROLL.
|
|
|
|
Only one mode at a time can be set. If a previous one was set, it
|
|
will be changed by the new mode after this call. Bitmasks won't
|
|
work here as well.
|
|
|
|
Warning: This function's behavior will clash with those of
|
|
elm_scroller_content_min_limit(), so use either one of them, but
|
|
not both.]]
|
|
set {
|
|
}
|
|
get {
|
|
}
|
|
values {
|
|
mode: Elm.List.Mode(Elm.List.Mode.last); [[One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL, #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.]]
|
|
}
|
|
}
|
|
@property selected_item {
|
|
get {
|
|
[[Get the selected item.
|
|
|
|
The selected item can be unselected with function
|
|
elm_list_item_selected_set().
|
|
|
|
The selected item always will be highlighted on list.]]
|
|
|
|
return: Elm.Widget.Item; [[The selected list item.]]
|
|
}
|
|
}
|
|
@property items {
|
|
get {
|
|
[[Get a list of all the list items.]]
|
|
|
|
return: const(list<Elm.Widget.Item>); [[A $list of list items, #Elm.Widget.Item, or $NULL on failure.]]
|
|
}
|
|
}
|
|
@property first_item {
|
|
get {
|
|
[[Get the first item in the list
|
|
|
|
This returns the first item in the list.]]
|
|
|
|
return: Elm.Widget.Item; [[The first item, or NULL if none]]
|
|
}
|
|
}
|
|
@property selected_items {
|
|
get {
|
|
[[Return a list of the currently selected list items.
|
|
|
|
Multiple items can be selected if multi select is enabled. It can be
|
|
done with elm_list_multi_select_set().]]
|
|
|
|
return: const(list<Elm.Widget.Item>); [[An $list of list items, #Elm.Widget.Item, or $NULL on failure.]]
|
|
}
|
|
}
|
|
@property last_item {
|
|
get {
|
|
[[Get the last item in the list
|
|
|
|
This returns the last item in the list.]]
|
|
|
|
return: Elm.Widget.Item; [[The last item, or NULL if none]]
|
|
}
|
|
}
|
|
item_insert_before {
|
|
[[Insert a new item into the list object before item $before.
|
|
|
|
A new item will be created and added to the list. Its position in
|
|
this list will be just before item $before.
|
|
|
|
Items created with this method can be deleted with elm_object_item_del().
|
|
|
|
Associated $data can be properly freed when item is deleted if a
|
|
callback function is set with elm_object_item_del_cb_set().
|
|
|
|
If a function is passed as argument, it will be called every time this item
|
|
is selected, i.e., the user clicks over an unselected item.
|
|
If always select is enabled it will call this function every time
|
|
user clicks over an item (already selected or not).
|
|
If such function isn't needed, just passing
|
|
$NULL as $func is enough. The same should be done for $data.
|
|
|
|
Note: Remember that the label parameter is copied inside the list. So if an
|
|
application dynamically allocated the label, the application should free the
|
|
label after this call.]]
|
|
|
|
return: Elm.Widget.Item; [[The created item or $NULL upon failure.]]
|
|
params {
|
|
@in before: Elm.Widget.Item; [[The list item to insert before.]]
|
|
@in label: string; [[The label of the list item.]]
|
|
@in icon: Efl.Canvas.Object @optional; [[The icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().]]
|
|
@in end: Efl.Canvas.Object @optional; [[The icon object to use for the right side of the item. An icon can be any Evas object.]]
|
|
@in func: Evas_Smart_Cb @optional; [[The function to call when the item is clicked.]]
|
|
@in data: const(void_ptr) @optional; [[The data to associate with the item for related callbacks.]]
|
|
}
|
|
}
|
|
go {
|
|
[[Starts the list.
|
|
|
|
Note: Call before running show() on the list object.
|
|
Warning: If not called, it won't display the list properly.]]
|
|
|
|
/* FIXME-doc
|
|
@code
|
|
li = elm_list_add(win);
|
|
elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
|
|
elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
|
|
elm_list_go(li);
|
|
evas_object_show(li);
|
|
@endcode */
|
|
}
|
|
item_insert_after {
|
|
[[Insert a new item into the list object after item $after.
|
|
|
|
A new item will be created and added to the list. Its position in
|
|
this list will be just after item $after.
|
|
|
|
Items created with this method can be deleted with elm_object_item_del().
|
|
|
|
Associated $data can be properly freed when item is deleted if a
|
|
callback function is set with elm_object_item_del_cb_set().
|
|
|
|
If a function is passed as argument, it will be called every time this item
|
|
is selected, i.e., the user clicks over an unselected item.
|
|
If always select is enabled it will call this function every time
|
|
user clicks over an item (already selected or not).
|
|
If such function isn't needed, just passing
|
|
$NULL as $func is enough. The same should be done for $data.
|
|
|
|
Note: Remember that the label parameter is copied inside the list. So if an
|
|
application dynamically allocated the label, the application should free the
|
|
label after this call.]]
|
|
|
|
return: Elm.Widget.Item; [[The created item or $NULL upon failure.]]
|
|
params {
|
|
@in after: Elm.Widget.Item; [[The list item to insert after.]]
|
|
@in label: string; [[The label of the list item.]]
|
|
@in icon: Efl.Canvas.Object @optional; [[The icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().]]
|
|
@in end: Efl.Canvas.Object @optional; [[The icon object to use for the right side of the item. An icon can be any Evas object.]]
|
|
@in func: Evas_Smart_Cb @optional; [[The function to call when the item is clicked.]]
|
|
@in data: const(void_ptr) @optional; [[The data to associate with the item for related callbacks.]]
|
|
}
|
|
}
|
|
at_xy_item_get @const {
|
|
[[Get the item that is at the x, y canvas coords.
|
|
|
|
This returns the item at the given coordinates (which are canvas
|
|
relative, not object-relative). If an item is at that coordinate,
|
|
that item handle is returned, and if $posret is not NULL, the
|
|
integer pointed to is set to a value of -1, 0 or 1, depending if
|
|
the coordinate is on the upper portion of that item (-1), on the
|
|
middle section (0) or on the lower part (1). If NULL is returned as
|
|
an item (no item found there), then posret may indicate -1 or 1
|
|
based if the coordinate is above or below all items respectively in
|
|
the list.]]
|
|
|
|
return: Elm.Widget.Item; [[The item at the coordinates or NULL if none]]
|
|
params {
|
|
@in x: int; [[The input x coordinate]]
|
|
@in y: int; [[The input y coordinate]]
|
|
@out posret: int; [[The position relative to the item returned here]]
|
|
}
|
|
}
|
|
item_append {
|
|
[[Append a new item to the list object.
|
|
|
|
A new item will be created and appended to the list, i.e., will
|
|
be set as last item.
|
|
|
|
Items created with this method can be deleted with elm_object_item_del().
|
|
|
|
Associated $data can be properly freed when item is deleted if a
|
|
callback function is set with elm_object_item_del_cb_set().
|
|
|
|
If a function is passed as argument, it will be called every time this item
|
|
is selected, i.e., the user clicks over an unselected item.
|
|
If always select is enabled it will call this function every time
|
|
user clicks over an item (already selected or not).
|
|
If such function isn't needed, just passing
|
|
$NULL as $func is enough. The same should be done for $data.
|
|
|
|
Note: Remember that the label parameter is copied inside the list. So if an
|
|
application dynamically allocated the label, the application should free the
|
|
label after this call.]]
|
|
|
|
/* FIXME-doc
|
|
Simple example (with no function callback or data associated):
|
|
@code
|
|
li = elm_list_add(win);
|
|
ic = elm_icon_add(win);
|
|
elm_image_file_set(ic, "path/to/image", NULL);
|
|
elm_icon_resizable_set(ic, true, true);
|
|
elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
|
|
elm_list_go(li);
|
|
evas_object_show(li);
|
|
@endcode
|
|
|
|
@see elm_list_select_mode_set()
|
|
@see elm_object_item_del()
|
|
@see elm_object_item_del_cb_set()
|
|
@see elm_list_clear()
|
|
@see elm_icon_add()
|
|
*/
|
|
|
|
return: Elm.Widget.Item; [[The created item or $NULL upon failure.]]
|
|
params {
|
|
@in label: string; [[The label of the list item.]]
|
|
@in icon: Efl.Canvas.Object @optional; [[The icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().]]
|
|
@in end: Efl.Canvas.Object @optional; [[The icon object to use for the right side of the item. An icon can be any Evas object.]]
|
|
@in func: Evas_Smart_Cb @optional; [[The function to call when the item is clicked.]]
|
|
@in data: const(void_ptr) @optional; [[The data to associate with the item for related callbacks.]]
|
|
}
|
|
}
|
|
item_prepend {
|
|
[[Prepend a new item to the list object.
|
|
|
|
A new item will be created and prepended to the list, i.e., will
|
|
be set as first item.
|
|
|
|
Items created with this method can be deleted with elm_object_item_del().
|
|
|
|
Associated $data can be properly freed when item is deleted if a
|
|
callback function is set with elm_object_item_del_cb_set().
|
|
|
|
If a function is passed as argument, it will be called every time this item
|
|
is selected, i.e., the user clicks over an unselected item.
|
|
If always select is enabled it will call this function every time
|
|
user clicks over an item (already selected or not).
|
|
If such function isn't needed, just passing
|
|
$NULL as $func is enough. The same should be done for $data.
|
|
|
|
Note: Remember that the label parameter is copied inside the list. So if an
|
|
application dynamically allocated the label, the application should free the
|
|
label after this call.]]
|
|
|
|
return: Elm.Widget.Item; [[The created item or $NULL upon failure.]]
|
|
params {
|
|
@in label: string; [[The label of the list item.]]
|
|
@in icon: Efl.Canvas.Object @optional; [[The icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().]]
|
|
@in end: Efl.Canvas.Object @optional; [[The icon object to use for the right side of the item. An icon can be any Evas object.]]
|
|
@in func: Evas_Smart_Cb @optional; [[The function to call when the item is clicked.]]
|
|
@in data: const(void_ptr) @optional; [[The data to associate with the item for related callbacks.]]
|
|
}
|
|
}
|
|
clear {
|
|
[[Remove all list's items.]]
|
|
}
|
|
item_sorted_insert {
|
|
[[Insert a new item into the sorted list object.
|
|
|
|
Note: This function inserts values into a list object assuming it was
|
|
sorted and the result will be sorted.
|
|
|
|
A new item will be created and added to the list. Its position in
|
|
this list will be found comparing the new item with previously inserted
|
|
items using function $cmp_func.
|
|
|
|
Items created with this method can be deleted with elm_object_item_del().
|
|
|
|
Associated $data can be properly freed when item is deleted if a
|
|
callback function is set with elm_object_item_del_cb_set().
|
|
|
|
If a function is passed as argument, it will be called every time this item
|
|
is selected, i.e., the user clicks over an unselected item.
|
|
If always select is enabled it will call this function every time
|
|
user clicks over an item (already selected or not).
|
|
If such function isn't needed, just passing
|
|
$NULL as $func is enough. The same should be done for $data.
|
|
|
|
Note: Remember that the label parameter is copied inside the list. So if an
|
|
application dynamically allocated the label, the application should free the
|
|
label after this call.]]
|
|
|
|
return: Elm.Widget.Item; [[The created item or $NULL upon failure.]]
|
|
params {
|
|
@in label: string; [[The label of the list item.]]
|
|
@in icon: Efl.Canvas.Object @optional; [[The icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().]]
|
|
@in end: Efl.Canvas.Object @optional; [[The icon object to use for the right side of the item. An icon can be any Evas object.]]
|
|
@in func: Evas_Smart_Cb @optional; [[The function to call when the item is clicked.]]
|
|
@in data: const(void_ptr) @optional; [[The data to associate with the item for related callbacks.]]
|
|
@in cmp_func: Eina_Compare_Cb; [[The comparing function to be used to sort list
|
|
items by #Elm.Widget.Item item handles. This function will
|
|
receive two items and compare them, returning a non-negative integer
|
|
if the second item should be place after the first, or negative value
|
|
if should be placed before.]]
|
|
}
|
|
}
|
|
}
|
|
implements {
|
|
class.constructor;
|
|
Efl.Object.constructor;
|
|
Efl.Gfx.Entity.position { set; }
|
|
Efl.Gfx.Entity.size { set; }
|
|
Efl.Canvas.Group.group_member_add;
|
|
Efl.Ui.Widget.theme_apply;
|
|
Efl.Ui.Widget.on_access_update;
|
|
Efl.Ui.Widget.focus_highlight_geometry { get; }
|
|
Efl.Ui.Widget.on_disabled_update;
|
|
Efl.Ui.Focus.Object.on_focus_update;
|
|
Efl.Ui.L10n.translation_update;
|
|
Efl.Ui.Widget.widget_sub_object_del;
|
|
Efl.Ui.Widget.widget_event;
|
|
Efl.Ui.Widget.focused_item { get; }
|
|
Efl.Ui.Widget.focus_state_apply;
|
|
Elm.Interface_Scrollable.item_loop_enabled { get; set; }
|
|
Elm.Interface_Scrollable.policy { set; }
|
|
Efl.Access.Widget.Action.elm_actions { get; }
|
|
Efl.Access.Object.access_children { get; }
|
|
Efl.Access.Selection.selected_children_count { get; }
|
|
Efl.Access.Selection.selected_child { get; }
|
|
Efl.Access.Selection.selected_child_deselect;
|
|
Efl.Access.Selection.child_select;
|
|
Efl.Access.Selection.child_deselect;
|
|
Efl.Access.Selection.is_child_selected;
|
|
Efl.Access.Selection.all_children_select;
|
|
Efl.Access.Selection.access_selection_clear;
|
|
}
|
|
events {
|
|
activated: Efl.Object; [[Called when activated]]
|
|
edge,top: void; [[Called when top edge was reached]]
|
|
edge,bottom: void; [[Called when bottom edge was reached]]
|
|
edge,left: void; [[Called when left edge was reached]]
|
|
edge,right: void; [[Called when right edge was reached]]
|
|
swipe: Efl.Object; [[Called when swipe is detected]]
|
|
highlighted: Efl.Object; [[Called when highlighted]]
|
|
unhighlighted: Efl.Object; [[Called when no longer highlighted]]
|
|
item,focused: Efl.Object; [[Called when item got focus]]
|
|
item,unfocused: Efl.Object; [[Called when item no longer has focus]]
|
|
/* FIXME: Nobody emits these
|
|
item,reorder,anim,start; [[Called when item reorder animation started]]
|
|
item,reorder,anim,stop; [[Called when item reorder animation stopped]]
|
|
*/
|
|
}
|
|
}
|