forked from enlightenment/efl
148 lines
5.8 KiB
Plaintext
148 lines
5.8 KiB
Plaintext
class Elm.Segment_Control (Efl.Ui.Layout, Efl.Ui.Focus.Composition)
|
|
{
|
|
[[Elementary segment control class]]
|
|
legacy_prefix: elm_segment_control;
|
|
eo_prefix: elm_obj_segment_control;
|
|
event_prefix: elm_segment_control;
|
|
methods {
|
|
@property item_count {
|
|
get {
|
|
[[Get the Segment items count from segment control.
|
|
|
|
It will just return the number of items added to segment control $obj.]]
|
|
return: int; [[Segment items count.]]
|
|
}
|
|
}
|
|
@property item_selected {
|
|
get {
|
|
[[Get the selected item.
|
|
|
|
The selected item can be unselected with function
|
|
elm_segment_control_item_selected_set().
|
|
|
|
The selected item always will be highlighted on segment control.]]
|
|
|
|
return: Elm.Widget.Item; [[The selected item or $NULL if none of segment items is selected.]]
|
|
|
|
}
|
|
}
|
|
item_label_get @const {
|
|
[[Get the label of item.
|
|
|
|
The return value is a pointer to the label associated to the item when
|
|
it was created, with function elm_segment_control_item_add(), or later
|
|
with function elm_object_item_text_set. If no label
|
|
was passed as argument, it will return $NULL.]]
|
|
|
|
return: string; [[The label of the item at $index.]]
|
|
params {
|
|
@in idx: int; [[The index of the segment item.]]
|
|
}
|
|
}
|
|
item_insert_at {
|
|
[[Insert a new item to the segment control object at specified position.
|
|
|
|
Index values must be between $0, when item will be prepended to
|
|
segment control, and items count, that can be get with
|
|
elm_segment_control_item_count_get(), case when item will be appended
|
|
to segment control, just like elm_segment_control_item_add().
|
|
|
|
Items created with this function can be deleted with function
|
|
elm_object_item_del() or elm_segment_control_item_del_at().
|
|
|
|
Note: $label set to $NULL is different from empty string "".
|
|
If an item
|
|
only has icon, it will be displayed bigger and centered. If it has
|
|
icon and label, even that an empty string, icon will be smaller and
|
|
positioned at left.]]
|
|
|
|
return: Elm.Widget.Item; [[The created item or $NULL upon failure.]]
|
|
params {
|
|
@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 label: string @optional; [[The label of the item.]]
|
|
@in idx: int; [[Item position. Value should be between 0 and items count.]]
|
|
}
|
|
}
|
|
item_get @const {
|
|
[[Get the item placed at specified index.
|
|
|
|
Index is the position of an item in segment control widget. Its
|
|
range is from $0 to <tt> count - 1 </tt>.
|
|
Count is the number of items, that can be get with
|
|
elm_segment_control_item_count_get().]]
|
|
|
|
return: Elm.Widget.Item; [[The segment control item or $NULL on failure.]]
|
|
params {
|
|
@in idx: int; [[The index of the segment item.]]
|
|
}
|
|
}
|
|
item_del_at {
|
|
[[Remove a segment control item at given index from its parent, deleting it.
|
|
|
|
Items can be added with elm_segment_control_item_add() or elm_segment_control_item_insert_at().]]
|
|
|
|
params {
|
|
@in idx: int; [[The position of the segment control item to be deleted.]]
|
|
}
|
|
}
|
|
item_add {
|
|
[[Append a new item to the segment control object.
|
|
|
|
A new item will be created and appended to the segment control, i.e., will
|
|
be set as last item.
|
|
|
|
If it should be inserted at another position,
|
|
elm_segment_control_item_insert_at() should be used instead.
|
|
|
|
Items created with this function can be deleted with function
|
|
elm_object_item_del() or elm_object_item_del_at().
|
|
|
|
Note: $label set to $NULL is different from empty string "".
|
|
If an item
|
|
only has icon, it will be displayed bigger and centered. If it has
|
|
icon and label, even that an empty string, icon will be smaller and
|
|
positioned at left.]]
|
|
|
|
/* FIXME-doc
|
|
Simple example:
|
|
@code
|
|
sc = elm_segment_control_add(win);
|
|
ic = elm_icon_add(win);
|
|
elm_image_file_set(ic, "path/to/image", NULL);
|
|
elm_icon_resizable_set(ic, true, true);
|
|
elm_segment_control_item_add(sc, ic, "label");
|
|
evas_object_show(sc);
|
|
@endcode */
|
|
|
|
return: Elm.Widget.Item; [[The created item or $NULL upon failure.]]
|
|
params {
|
|
@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 label: string @optional; [[The label of the item. Note that, NULL is different from empty string "".]]
|
|
}
|
|
}
|
|
item_icon_get @const {
|
|
[[Get the icon associated to the item.
|
|
|
|
The return value is a pointer to the icon associated to the item when
|
|
it was created, with function elm_segment_control_item_add(), or later
|
|
with function elm_object_item_part_content_set(). If no icon
|
|
was passed as argument, it will return $NULL.]]
|
|
return: Efl.Canvas.Object; [[The left side icon associated to the item at $index.]]
|
|
params {
|
|
@in idx: int; [[The index of the segment item.]]
|
|
}
|
|
}
|
|
}
|
|
implements {
|
|
class.constructor;
|
|
Efl.Object.constructor;
|
|
Elm.Widget.theme_apply;
|
|
Elm.Widget.on_access_update;
|
|
Elm.Widget.on_disabled_update;
|
|
Efl.Ui.Translatable.translation_update;
|
|
}
|
|
events {
|
|
changed; [[Called when segment control changed]]
|
|
}
|
|
}
|