forked from enlightenment/efl
Toolbar: migrate docs.
This commit is contained in:
parent
078185b2cb
commit
0ebe02213b
|
@ -30,493 +30,329 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
|
|||
eo_prefix: elm_obj_toolbar;
|
||||
methods {
|
||||
@property homogeneous {
|
||||
[[Control homogeneous mode.
|
||||
|
||||
This will enable the homogeneous mode where items are of the same size.]]
|
||||
set {
|
||||
/*@
|
||||
Enable/disable homogeneous mode.
|
||||
|
||||
This will enable the homogeneous mode where items are of the same size.
|
||||
@see elm_toolbar_homogeneous_get()
|
||||
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
Get whether the homogeneous mode is enabled.
|
||||
|
||||
@return Assume the items within the toolbar are of the same height
|
||||
and width (true = on, false = off).
|
||||
|
||||
@see elm_toolbar_homogeneous_set()
|
||||
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
values {
|
||||
homogeneous: bool; /*@ Assume the items within the toolbar are of the
|
||||
same size (true = on, false = off). Default is $false. */
|
||||
homogeneous: bool; [[Assume the items within the toolbar are of the same size (true = on, false = off). Default is $false.]]
|
||||
}
|
||||
}
|
||||
@property align {
|
||||
[[Control the alignment of the items.
|
||||
|
||||
Alignment of toolbar items, from 0.0 to indicates to align
|
||||
left, to 1.0, to align to right. 0.5 centralize
|
||||
items.
|
||||
|
||||
Centered items by default.]]
|
||||
set {
|
||||
/*@
|
||||
Set the alignment of the items.
|
||||
|
||||
Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
|
||||
left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
|
||||
items.
|
||||
|
||||
Centered items by default.
|
||||
|
||||
@see elm_toolbar_align_get()
|
||||
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
Get the alignment of the items.
|
||||
|
||||
@return toolbar items alignment, a float between <tt> 0.0 </tt> and
|
||||
<tt> 1.0 </tt>.
|
||||
|
||||
@see elm_toolbar_align_set() for details.
|
||||
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
values {
|
||||
align: double; /*@ The new alignment, a float between <tt> 0.0 </tt>
|
||||
and <tt> 1.0 </tt>. */
|
||||
align: double; [[The new alignment, a float between 0.0 and 1.0.]]
|
||||
}
|
||||
}
|
||||
@property select_mode {
|
||||
[[Control the toolbar select mode.
|
||||
|
||||
elm_toolbar_select_mode_set() changes item select mode in the toolbar 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 {
|
||||
/*@
|
||||
Set the toolbar select mode.
|
||||
|
||||
elm_toolbar_select_mode_set() changes item select mode in the toolbar 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.
|
||||
|
||||
@see elm_toolbar_select_mode_get()
|
||||
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
Get the toolbar select mode.
|
||||
|
||||
@return The select mode
|
||||
(If getting mode fails, it returns #ELM_OBJECT_SELECT_MODE_MAX)
|
||||
|
||||
@see elm_toolbar_select_mode_set()
|
||||
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
values {
|
||||
mode: Elm.Object.Select_Mode(Elm.Object.Select_Mode.max); /*@ The select mode */
|
||||
mode: Elm.Object.Select_Mode(Elm.Object.Select_Mode.max); [[The select mode If getting mode fails, it returns #ELM_OBJECT_SELECT_MODE_MAX]]
|
||||
}
|
||||
}
|
||||
@property icon_size {
|
||||
[[Control the icon size, in pixels, to be used by toolbar items.
|
||||
|
||||
Note: Default value is $32. It reads value from elm config.]]
|
||||
set {
|
||||
/*@
|
||||
Set the icon size, in pixels, to be used by toolbar items.
|
||||
|
||||
@note Default value is $32. It reads value from elm config.
|
||||
|
||||
@see elm_toolbar_icon_size_get()
|
||||
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
Get the icon size, in pixels, to be used by toolbar items.
|
||||
|
||||
@return The icon size in pixels.
|
||||
|
||||
@see elm_toolbar_icon_size_set() for details.
|
||||
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
values {
|
||||
icon_size: int; /*@ The icon size in pixels */
|
||||
icon_size: int; [[The icon size in pixels]]
|
||||
}
|
||||
}
|
||||
@property horizontal {
|
||||
[[Change a toolbar's orientation
|
||||
|
||||
By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.]]
|
||||
set {
|
||||
/*@
|
||||
Change a toolbar's orientation
|
||||
By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
Get a toolbar's orientation
|
||||
@return If $true, the toolbar is horizontal
|
||||
By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
values {
|
||||
horizontal: bool; /*@ If $true, the toolbar is horizontal */
|
||||
horizontal: bool; [[If $true, the toolbar is horizontal.]]
|
||||
}
|
||||
}
|
||||
@property icon_order_lookup {
|
||||
[[Sets icon lookup order, for toolbar items' icons.
|
||||
|
||||
Icons added before calling this function will not be affected.
|
||||
The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.]]
|
||||
set {
|
||||
/*@
|
||||
Sets icon lookup order, for toolbar items' icons.
|
||||
|
||||
Icons added before calling this function will not be affected.
|
||||
The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
|
||||
|
||||
@see elm_toolbar_icon_order_lookup_get()
|
||||
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
Get the icon lookup order.
|
||||
|
||||
@return The icon lookup order.
|
||||
(If getting the icon order loopup fails, it returns #ELM_ICON_LOOKUP_THEME_FDO)
|
||||
|
||||
@see elm_toolbar_icon_order_lookup_set() for details.
|
||||
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
values {
|
||||
order: Elm_Icon_Lookup_Order(1); /*@ The icon lookup order. */
|
||||
order: Elm_Icon_Lookup_Order(1); [[The icon lookup order. (If getting the icon order loopup fails, it returns #ELM_ICON_LOOKUP_THEME_FDO)]]
|
||||
}
|
||||
}
|
||||
@property shrink_mode {
|
||||
[[Control the item displaying mode of a given toolbar widget $obj.
|
||||
|
||||
The toolbar won't scroll under #ELM_TOOLBAR_SHRINK_NONE mode, but
|
||||
it will enforce a minimum size, so that all the items will fit
|
||||
inside it. It won't scroll and won't show the items that don't fit
|
||||
under #ELM_TOOLBAR_SHRINK_HIDE mode. Finally, it'll scroll under
|
||||
#ELM_TOOLBAR_SHRINK_SCROLL mode, and it will create a button to
|
||||
aggregate items which didn't fit with the #ELM_TOOLBAR_SHRINK_MENU
|
||||
mode.
|
||||
|
||||
Warning: This function's behavior will clash with those of
|
||||
elm_scroller_policy_set(), so use either one of them, but not both.]]
|
||||
set {
|
||||
/*@
|
||||
Set the item displaying mode of a given toolbar widget $obj.
|
||||
|
||||
The toolbar won't scroll under #ELM_TOOLBAR_SHRINK_NONE mode, but
|
||||
it will enforce a minimum size, so that all the items will fit
|
||||
inside it. It won't scroll and won't show the items that don't fit
|
||||
under #ELM_TOOLBAR_SHRINK_HIDE mode. Finally, it'll scroll under
|
||||
#ELM_TOOLBAR_SHRINK_SCROLL mode, and it will create a button to
|
||||
aggregate items which didn't fit with the #ELM_TOOLBAR_SHRINK_MENU
|
||||
mode.
|
||||
|
||||
@warning This function's behavior will clash with those of
|
||||
elm_scroller_policy_set(), so use either one of them, but not both.
|
||||
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
Get the shrink mode of toolbar $obj.
|
||||
|
||||
@return Toolbar's items display behavior.
|
||||
|
||||
@see elm_toolbar_shrink_mode_set() for details.
|
||||
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
values {
|
||||
shrink_mode: Elm.Toolbar.Shrink_Mode; /*@ Toolbar's items display behavior */
|
||||
shrink_mode: Elm.Toolbar.Shrink_Mode; [[Toolbar's items display behavior]]
|
||||
}
|
||||
}
|
||||
@property menu_parent {
|
||||
[[Control the parent object of the toolbar items' menus.
|
||||
|
||||
Each item can be set as item menu, with elm_toolbar_item_menu_set().
|
||||
|
||||
For more details about setting the parent for toolbar menus, see
|
||||
elm_menu_parent_set().
|
||||
|
||||
See: elm_menu_parent_set() for details.
|
||||
See: elm_toolbar_item_menu_set() for details.]]
|
||||
set {
|
||||
/*@
|
||||
Set the parent object of the toolbar items' menus.
|
||||
|
||||
Each item can be set as item menu, with elm_toolbar_item_menu_set().
|
||||
|
||||
For more details about setting the parent for toolbar menus, see
|
||||
elm_menu_parent_set().
|
||||
|
||||
@see elm_menu_parent_set() for details.
|
||||
@see elm_toolbar_item_menu_set() for details.
|
||||
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
Get the parent object of the toolbar items' menus.
|
||||
|
||||
@return The parent of the menu objects.
|
||||
|
||||
@see elm_toolbar_menu_parent_set() for details.
|
||||
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
values {
|
||||
parent: Evas.Object *; /*@ The parent of the menu objects. */
|
||||
parent: Evas.Object *; [[The parent of the menu objects.]]
|
||||
}
|
||||
}
|
||||
@property standard_priority {
|
||||
[[Set the standard priority of visible items in a toolbar
|
||||
|
||||
If the priority of the item is up to standard priority, it is shown in basic panel.
|
||||
The other items are located in more menu or panel. The more menu or panel can be shown when the more item is clicked.
|
||||
|
||||
@since 1.7]]
|
||||
set {
|
||||
/*@
|
||||
Set the standard priority of visible items in a toolbar
|
||||
If the priority of the item is up to standard priority, it is shown in basic panel.
|
||||
The other items are located in more menu or panel. The more menu or panel can be shown when the more item is clicked.
|
||||
|
||||
@see elm_toolbar_standard_priority_get()
|
||||
|
||||
@since 1.7
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
Get the standard_priority of visible items in a toolbar
|
||||
@return The standard priority of items in $obj toolbar
|
||||
|
||||
@see elm_toolbar_standard_priority_set()
|
||||
|
||||
@since 1.7
|
||||
@ingroup Toolbar */
|
||||
}
|
||||
values {
|
||||
priority: int; /*@ The standard_priority of visible items */
|
||||
priority: int; [[The standard_priority of visible items]]
|
||||
}
|
||||
}
|
||||
@property selected_item {
|
||||
get {
|
||||
/*@
|
||||
Get the selected item.
|
||||
[[Get the selected item.
|
||||
|
||||
@return The selected toolbar item.
|
||||
The selected item can be unselected with function
|
||||
elm_toolbar_item_selected_set().
|
||||
|
||||
The selected item can be unselected with function
|
||||
elm_toolbar_item_selected_set().
|
||||
The selected item always will be highlighted on toolbar.]]
|
||||
|
||||
The selected item always will be highlighted on toolbar.
|
||||
|
||||
@ingroup Toolbar */
|
||||
return: Elm.Widget_Item *;
|
||||
return: Elm.Widget_Item *; [[The selected toolbar item.]]
|
||||
}
|
||||
}
|
||||
@property first_item {
|
||||
get {
|
||||
/*@
|
||||
Get the first item in the given toolbar widget's list of
|
||||
items.
|
||||
[[Get the first item in the given toolbar widget's list of items.
|
||||
|
||||
@return The first item or $NULL, if it has no items (and on
|
||||
errors)
|
||||
See: @.item_append and @.last_item]]
|
||||
|
||||
@see elm_toolbar_item_append()
|
||||
@see elm_toolbar_last_item_get()
|
||||
|
||||
@ingroup Toolbar */
|
||||
return: Elm.Widget_Item *;
|
||||
return: Elm.Widget_Item *; [[The first item or $NULL, if it has no items (and on errors)]]
|
||||
}
|
||||
}
|
||||
@property more_item {
|
||||
get {
|
||||
/*@
|
||||
Get the more item which is auto-generated by toolbar.
|
||||
[[Get the more item which is auto-generated by toolbar.
|
||||
|
||||
@return The toolbar more item.
|
||||
Toolbar generates 'more' item when there is no more space to fit items in
|
||||
and toolbar is in #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_EXPAND mode.
|
||||
The more item can be manipulated by elm_object_item_text_set() and
|
||||
elm_object_item_content_set.]]
|
||||
|
||||
Toolbar generates 'more' item when there is no more space to fit items in
|
||||
and toolbar is in #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_EXPAND mode.
|
||||
The more item can be manipulated by elm_object_item_text_set() and
|
||||
elm_object_item_content_set.
|
||||
|
||||
@ingroup Toolbar */
|
||||
return: Elm.Widget_Item *;
|
||||
return: Elm.Widget_Item *; [[The toolbar more item.]]
|
||||
}
|
||||
}
|
||||
@property last_item {
|
||||
get {
|
||||
/*@
|
||||
Get the last item in the given toolbar widget's list of
|
||||
items.
|
||||
[[Get the last item in the given toolbar widget's list of items.
|
||||
|
||||
@return The last item or $NULL, if it has no items (and on
|
||||
errors)
|
||||
|
||||
@see elm_toolbar_item_prepend()
|
||||
@see elm_toolbar_first_item_get()
|
||||
|
||||
@ingroup Toolbar */
|
||||
return: Elm.Widget_Item *;
|
||||
See: @.item_prepend and @.first_item]]
|
||||
return: Elm.Widget_Item *; [[The last item or $NULL, if it has no items (and on errors)]]
|
||||
}
|
||||
}
|
||||
item_insert_before {
|
||||
/*@
|
||||
Insert a new item into the toolbar object before item $before.
|
||||
[[Insert a new item into the toolbar object before item $before.
|
||||
|
||||
@return The created item or $NULL upon failure.
|
||||
A new item will be created and added to the toolbar. Its position in
|
||||
this toolbar will be just before item $before.
|
||||
|
||||
A new item will be created and added to the toolbar. Its position in
|
||||
this toolbar will be just before item $before.
|
||||
Items created with this method can be deleted with
|
||||
elm_object_item_del().
|
||||
|
||||
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().
|
||||
|
||||
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 such function isn't needed, just passing
|
||||
$NULL as $func is enough. The same should be done for $data.
|
||||
|
||||
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 such function isn't needed, just passing
|
||||
$NULL as $func is enough. The same should be done for $data.
|
||||
Toolbar will load icon image from fdo or current theme.
|
||||
This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
|
||||
If an absolute path is provided it will load it direct from a file.
|
||||
|
||||
Toolbar will load icon image from fdo or current theme.
|
||||
This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
|
||||
If an absolute path is provided it will load it direct from a file.
|
||||
Note: This function does not accept relative icon path.
|
||||
|
||||
@note This function does not accept relative icon path.
|
||||
See: elm_toolbar_item_icon_set()]]
|
||||
|
||||
@see elm_toolbar_item_icon_set()
|
||||
@see elm_object_item_del()
|
||||
|
||||
@ingroup Toolbar */
|
||||
|
||||
return: Elm.Widget_Item *;
|
||||
return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
|
||||
params {
|
||||
@in before: Elm.Widget_Item *; /*@ The toolbar item to insert before. */
|
||||
@in icon: const(char)* @optional; /*@ A string with icon name or the absolute path of an image file. */
|
||||
@in label: const(char)*; /*@ The label of the item. */
|
||||
@in func: Evas_Smart_Cb @optional; /*@ The function to call when the item is clicked. */
|
||||
@in data: const(void)* @optional; /*@ The data to associate with the item for related callbacks. */
|
||||
@in before: Elm.Widget_Item *; [[The toolbar item to insert before.]]
|
||||
@in icon: const(char)* @optional; [[A string with icon name or the absolute path of an image file.]]
|
||||
@in label: const(char)*; [[The label of the item.]]
|
||||
@in func: Evas_Smart_Cb @optional; [[The function to call when the item is clicked.]]
|
||||
@in data: const(void)* @optional; [[The data to associate with the item for related callbacks.]]
|
||||
}
|
||||
}
|
||||
item_insert_after {
|
||||
/*@
|
||||
Insert a new item into the toolbar object after item $after.
|
||||
[[Insert a new item into the toolbar object after item $after.
|
||||
|
||||
@return The created item or $NULL upon failure.
|
||||
A new item will be created and added to the toolbar. Its position in
|
||||
this toolbar will be just after item $after.
|
||||
|
||||
A new item will be created and added to the toolbar. Its position in
|
||||
this toolbar will be just after item $after.
|
||||
Items created with this method can be deleted with
|
||||
elm_object_item_del().
|
||||
|
||||
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().
|
||||
|
||||
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 such function isn't needed, just passing
|
||||
$NULL as $func is enough. The same should be done for $data.
|
||||
|
||||
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 such function isn't needed, just passing
|
||||
$NULL as $func is enough. The same should be done for $data.
|
||||
Toolbar will load icon image from fdo or current theme.
|
||||
This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
|
||||
If an absolute path is provided it will load it direct from a file.
|
||||
|
||||
Toolbar will load icon image from fdo or current theme.
|
||||
This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
|
||||
If an absolute path is provided it will load it direct from a file.
|
||||
Note: This function does not accept relative icon path.
|
||||
|
||||
@note This function does not accept relative icon path.
|
||||
See: elm_toolbar_item_icon_set()]]
|
||||
|
||||
@see elm_toolbar_item_icon_set()
|
||||
@see elm_object_item_del()
|
||||
|
||||
@ingroup Toolbar */
|
||||
|
||||
return: Elm.Widget_Item *;
|
||||
return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
|
||||
params {
|
||||
@in after: Elm.Widget_Item *; /*@ The toolbar item to insert after. */
|
||||
@in icon: const(char)* @optional; /*@ A string with icon name or the absolute path of an image file. */
|
||||
@in label: const(char)*; /*@ The label of the item. */
|
||||
@in func: Evas_Smart_Cb @optional; /*@ The function to call when the item is clicked. */
|
||||
@in data: const(void)* @optional; /*@ The data to associate with the item for related callbacks. */
|
||||
@in after: Elm.Widget_Item *; [[The toolbar item to insert after.]]
|
||||
@in icon: const(char)* @optional; [[A string with icon name or the absolute path of an image file.]]
|
||||
@in label: const(char)*; [[The label of the item.]]
|
||||
@in func: Evas_Smart_Cb @optional; [[The function to call when the item is clicked.]]
|
||||
@in data: const(void)* @optional; [[The data to associate with the item for related callbacks.]]
|
||||
}
|
||||
}
|
||||
item_append {
|
||||
/*@
|
||||
Append item to the toolbar.
|
||||
[[Append item to the toolbar.
|
||||
|
||||
@return The created item or $NULL upon failure.
|
||||
A new item will be created and appended to the toolbar, i.e., will
|
||||
be set as last item.
|
||||
|
||||
A new item will be created and appended to the toolbar, i.e., will
|
||||
be set as @b last item.
|
||||
Items created with this method can be deleted with
|
||||
elm_object_item_del().
|
||||
|
||||
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().
|
||||
|
||||
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 such function isn't needed, just passing
|
||||
$NULL as $func is enough. The same should be done for $data.
|
||||
|
||||
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 such function isn't needed, just passing
|
||||
$NULL as $func is enough. The same should be done for $data.
|
||||
Toolbar will load icon image from fdo or current theme.
|
||||
This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
|
||||
If an absolute path is provided it will load it direct from a file.
|
||||
|
||||
Toolbar will load icon image from fdo or current theme.
|
||||
This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
|
||||
If an absolute path is provided it will load it direct from a file.
|
||||
Note: This function does not accept relative icon path.
|
||||
|
||||
@note This function does not accept relative icon path.
|
||||
See: elm_toolbar_item_icon_set()]]
|
||||
|
||||
@see elm_toolbar_item_icon_set()
|
||||
@see elm_object_item_del()
|
||||
|
||||
@ingroup Toolbar */
|
||||
|
||||
return: Elm.Widget_Item *;
|
||||
return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
|
||||
params {
|
||||
@in icon: const(char)* @optional; /*@ A string with icon name or the absolute path of an image file. */
|
||||
@in label: const(char)*; /*@ The label of the item. */
|
||||
@in func: Evas_Smart_Cb @optional; /*@ The function to call when the item is clicked. */
|
||||
@in data: const(void)* @optional; /*@ The data to associate with the item for related callbacks. */
|
||||
@in icon: const(char)* @optional; [[A string with icon name or the absolute path of an image file.]]
|
||||
@in label: const(char)*; [[The label of the item.]]
|
||||
@in func: Evas_Smart_Cb @optional; [[The function to call when the item is clicked.]]
|
||||
@in data: const(void)* @optional; [[The data to associate with the item for related callbacks.]]
|
||||
}
|
||||
}
|
||||
items_count @const {
|
||||
/*@
|
||||
Get the number of items in a toolbar
|
||||
@return The number of items in $obj toolbar
|
||||
@ingroup Toolbar */
|
||||
return: uint;
|
||||
[[Get the number of items in a toolbar]]
|
||||
return: uint; [[The number of items in $obj toolbar]]
|
||||
}
|
||||
item_prepend {
|
||||
/*@
|
||||
Prepend item to the toolbar.
|
||||
[[Prepend item to the toolbar.
|
||||
|
||||
@return The created item or $NULL upon failure.
|
||||
A new item will be created and prepended to the toolbar, i.e., will
|
||||
be set as first item.
|
||||
|
||||
A new item will be created and prepended to the toolbar, i.e., will
|
||||
be set as @b first item.
|
||||
Items created with this method can be deleted with
|
||||
elm_object_item_del().
|
||||
|
||||
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().
|
||||
|
||||
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 such function isn't needed, just passing
|
||||
$NULL as $func is enough. The same should be done for $data.
|
||||
|
||||
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 such function isn't needed, just passing
|
||||
$NULL as $func is enough. The same should be done for $data.
|
||||
Toolbar will load icon image from fdo or current theme.
|
||||
This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
|
||||
If an absolute path is provided it will load it direct from a file.
|
||||
|
||||
Toolbar will load icon image from fdo or current theme.
|
||||
This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
|
||||
If an absolute path is provided it will load it direct from a file.
|
||||
Note: This function does not accept relative icon path.
|
||||
|
||||
@note This function does not accept relative icon path.
|
||||
See: elm_toolbar_item_icon_set()]]
|
||||
|
||||
@see elm_toolbar_item_icon_set()
|
||||
@see elm_object_item_del()
|
||||
|
||||
@ingroup Toolbar */
|
||||
|
||||
return: Elm.Widget_Item *;
|
||||
return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
|
||||
params {
|
||||
@in icon: const(char)* @optional; /*@ A string with icon name or the absolute path of an image file. */
|
||||
@in label: const(char)*; /*@ The label of the item. */
|
||||
@in func: Evas_Smart_Cb @optional; /*@ The function to call when the item is clicked. */
|
||||
@in data: const(void)* @optional; /*@ The data to associate with the item for related callbacks. */
|
||||
@in icon: const(char)* @optional; [[A string with icon name or the absolute path of an image file.]]
|
||||
@in label: const(char)*; [[The label of the item.]]
|
||||
@in func: Evas_Smart_Cb @optional; [[The function to call when the item is clicked.]]
|
||||
@in data: const(void)* @optional; [[The data to associate with the item for related callbacks.]]
|
||||
}
|
||||
}
|
||||
item_find_by_label @const {
|
||||
/*@
|
||||
Returns a pointer to a toolbar item by its label.
|
||||
[[Returns a pointer to a toolbar item by its label.]]
|
||||
|
||||
@return The pointer to the toolbar item matching $label or $NULL
|
||||
on failure.
|
||||
|
||||
@ingroup Toolbar */
|
||||
return: Elm.Widget_Item *;
|
||||
return: Elm.Widget_Item *; [[The pointer to the toolbar item matching $label or $NULL on failure.]]
|
||||
params {
|
||||
@in label: const(char)*; /*@ The label of the item to find. */
|
||||
@in label: const(char)*; [[The label of the item to find.]]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue