Typedefs

typedef struct
_Elm_Toolbar_Item_State 
Elm_Toolbar_Item_State
 State of a Elm_Toolbar_Item.

Enumerations

enum  Elm_Toolbar_Shrink_Mode {
  ELM_TOOLBAR_SHRINK_NONE,
  ELM_TOOLBAR_SHRINK_HIDE,
  ELM_TOOLBAR_SHRINK_SCROLL,
  ELM_TOOLBAR_SHRINK_MENU,
  ELM_TOOLBAR_SHRINK_EXPAND,
  ELM_TOOLBAR_SHRINK_LAST
}
 Set toolbar's items display behavior, it can be scrollable, show a menu with exceeding items, or simply hide them. More...

Functions

Evas_Object * elm_toolbar_add (Evas_Object *parent)
 Add a new toolbar widget to the given parent Elementary (container) object.
void elm_toolbar_icon_size_set (Evas_Object *obj, int icon_size)
 Set the icon size, in pixels, to be used by toolbar items.
int elm_toolbar_icon_size_get (const Evas_Object *obj)
 Get the icon size, in pixels, to be used by toolbar items.
void elm_toolbar_icon_order_lookup_set (Evas_Object *obj, Elm_Icon_Lookup_Order order)
 Sets icon lookup order, for toolbar items' icons.
Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get (const Evas_Object *obj)
 Gets the icon lookup order.
Elm_Object_Itemelm_toolbar_item_append (Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data)
 Append item to the toolbar.
Elm_Object_Itemelm_toolbar_item_prepend (Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data)
 Prepend item to the toolbar.
Elm_Object_Itemelm_toolbar_item_insert_before (Evas_Object *obj, Elm_Object_Item *before, const char *icon, const char *label, Evas_Smart_Cb func, const void *data)
 Insert a new item into the toolbar object before item before.
Elm_Object_Itemelm_toolbar_item_insert_after (Evas_Object *obj, Elm_Object_Item *after, const char *icon, const char *label, Evas_Smart_Cb func, const void *data)
 Insert a new item into the toolbar object after item after.
Elm_Object_Itemelm_toolbar_first_item_get (const Evas_Object *obj)
 Get the first item in the given toolbar widget's list of items.
Elm_Object_Itemelm_toolbar_last_item_get (const Evas_Object *obj)
 Get the last item in the given toolbar widget's list of items.
Elm_Object_Itemelm_toolbar_item_next_get (const Elm_Object_Item *it)
 Get the item after item in toolbar.
Elm_Object_Itemelm_toolbar_item_prev_get (const Elm_Object_Item *it)
 Get the item before item in toolbar.
void elm_toolbar_item_priority_set (Elm_Object_Item *it, int priority)
 Set the priority of a toolbar item.
int elm_toolbar_item_priority_get (const Elm_Object_Item *it)
 Get the priority of a toolbar item.
Elm_Object_Itemelm_toolbar_item_find_by_label (const Evas_Object *obj, const char *label)
 Returns a pointer to a toolbar item by its label.
void elm_toolbar_item_selected_set (Elm_Object_Item *it, Eina_Bool selected)
 Set the selected state of an item.
Elm_Object_Itemelm_toolbar_selected_item_get (const Evas_Object *obj)
 Get the selected item.
Elm_Object_Itemelm_toolbar_more_item_get (const Evas_Object *obj)
 Get the more item.
void elm_toolbar_item_icon_set (Elm_Object_Item *it, const char *icon)
 Set the icon associated with item.
const char * elm_toolbar_item_icon_get (const Elm_Object_Item *it)
 Get the string used to set the icon of item.
Evas_Object * elm_toolbar_item_object_get (const Elm_Object_Item *it)
 Get the object of item.
Evas_Object * elm_toolbar_item_icon_object_get (Elm_Object_Item *it)
 Get the icon object of item.
Eina_Bool elm_toolbar_item_icon_memfile_set (Elm_Object_Item *it, const void *img, size_t size, const char *format, const char *key)
 Set the icon associated with item to an image in a binary buffer.
Eina_Bool elm_toolbar_item_icon_file_set (Elm_Object_Item *it, const char *file, const char *key)
 Set the icon associated with item to an image in a binary buffer.
void elm_toolbar_item_separator_set (Elm_Object_Item *it, Eina_Bool separator)
 Set or unset item as a separator.
Eina_Bool elm_toolbar_item_separator_get (const Elm_Object_Item *it)
 Get a value whether item is a separator or not.
void elm_toolbar_shrink_mode_set (Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode)
 Set the shrink state of toolbar obj.
Elm_Toolbar_Shrink_Mode elm_toolbar_shrink_mode_get (const Evas_Object *obj)
 Get the shrink mode of toolbar obj.
void elm_toolbar_homogeneous_set (Evas_Object *obj, Eina_Bool homogeneous)
 Enable/disable homogeneous mode.
Eina_Bool elm_toolbar_homogeneous_get (const Evas_Object *obj)
 Get whether the homogeneous mode is enabled.
void elm_toolbar_menu_parent_set (Evas_Object *obj, Evas_Object *parent)
 Set the parent object of the toolbar items' menus.
Evas_Object * elm_toolbar_menu_parent_get (const Evas_Object *obj)
 Get the parent object of the toolbar items' menus.
void elm_toolbar_align_set (Evas_Object *obj, double align)
 Set the alignment of the items.
double elm_toolbar_align_get (const Evas_Object *obj)
 Get the alignment of the items.
void elm_toolbar_item_menu_set (Elm_Object_Item *it, Eina_Bool menu)
 Set whether the toolbar item opens a menu.
Evas_Object * elm_toolbar_item_menu_get (const Elm_Object_Item *it)
 Get toolbar item's menu.
Elm_Toolbar_Item_Stateelm_toolbar_item_state_add (Elm_Object_Item *it, const char *icon, const char *label, Evas_Smart_Cb func, const void *data)
 Add a new state to item.
Eina_Bool elm_toolbar_item_state_del (Elm_Object_Item *it, Elm_Toolbar_Item_State *state)
 Delete a previously added state to item.
Eina_Bool elm_toolbar_item_state_set (Elm_Object_Item *it, Elm_Toolbar_Item_State *state)
 Set state as the current state of it.
void elm_toolbar_item_state_unset (Elm_Object_Item *it)
 Unset the state of it.
Elm_Toolbar_Item_Stateelm_toolbar_item_state_get (const Elm_Object_Item *it)
 Get the current state of it.
Elm_Toolbar_Item_Stateelm_toolbar_item_state_next (Elm_Object_Item *it)
 Get the state after selected state in toolbar's item.
Elm_Toolbar_Item_Stateelm_toolbar_item_state_prev (Elm_Object_Item *it)
 Get the state before selected state in toolbar's item.
void elm_toolbar_horizontal_set (Evas_Object *obj, Eina_Bool horizontal)
 Change a toolbar's orientation.
Eina_Bool elm_toolbar_horizontal_get (const Evas_Object *obj)
 Get a toolbar's orientation.
unsigned int elm_toolbar_items_count (const Evas_Object *obj)
 Get the number of items in a toolbar.
void elm_toolbar_standard_priority_set (Evas_Object *obj, int priority)
 Set the standard priority of visible items in a toolbar.
int elm_toolbar_standard_priority_get (const Evas_Object *obj)
 Get the standard_priority of visible items in a toolbar.
void elm_toolbar_select_mode_set (Evas_Object *obj, Elm_Object_Select_Mode mode)
 Set the toolbar select mode.
Elm_Object_Select_Mode elm_toolbar_select_mode_get (const Evas_Object *obj)
 Get the toolbar select mode.

Detailed Description

preview-00.png
toolbar.png

A toolbar is a widget that displays a list of items inside a box. It can be scrollable, show a menu with items that don't fit to toolbar size or even crop them.

Only one item can be selected at a time.

Items can have multiple states, or show menus when selected by the user.

Smart callbacks one can listen to:

  • "clicked" - when the user clicks on a toolbar item and becomes selected.
  • "longpressed" - when the toolbar is pressed for a certain amount of time.
  • "language,changed" - when the program language changes.

Available styles for it:

  • "default"
  • "transparent" - no background or shadow, just show the content

Default text parts of the toolbar items that you can use for are:

  • "default" - label of the toolbar item

Supported elm_object_item common APIs.

List of examples:


Typedef Documentation

typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State

State of a Elm_Toolbar_Item.

Can be created with elm_toolbar_item_state_add() and removed with elm_toolbar_item_state_del().


Enumeration Type Documentation

Set toolbar's items display behavior, it can be scrollable, show a menu with exceeding items, or simply hide them.

Note:
Default value is ELM_TOOLBAR_SHRINK_MENU. It reads value from elm config.

Values don't work as bitmask, only one can be chosen.

See also:
elm_toolbar_shrink_mode_set()
elm_toolbar_shrink_mode_get()
Enumerator:
ELM_TOOLBAR_SHRINK_NONE 

Set toolbar minimum size to fit all the items.

ELM_TOOLBAR_SHRINK_HIDE 

Hide exceeding items.

ELM_TOOLBAR_SHRINK_SCROLL 

Allow accessing exceeding items through a scroller.

ELM_TOOLBAR_SHRINK_MENU 

Inserts a button to pop up a menu with exceeding items.

ELM_TOOLBAR_SHRINK_EXPAND 

Expand all items according the size of the toolbar.

ELM_TOOLBAR_SHRINK_LAST 

Indicates error if returned by elm_toolbar_shrink_mode_get()


Function Documentation

Evas_Object* elm_toolbar_add ( Evas_Object *  parent)

Add a new toolbar widget to the given parent Elementary (container) object.

Parameters:
parentThe parent object.
Returns:
a new toolbar widget handle or NULL, on errors.

This function inserts a new toolbar widget on the canvas.

References ELM_ICON_LOOKUP_THEME_FDO, elm_layout_add(), elm_layout_theme_set(), elm_object_part_content_set(), elm_toolbar_icon_order_lookup_set(), elm_toolbar_shrink_mode_set(), and ELM_TOOLBAR_SHRINK_NONE.

double elm_toolbar_align_get ( const Evas_Object *  obj)

Get the alignment of the items.

Parameters:
objThe toolbar object.
Returns:
toolbar items alignment, a float between 0.0 and 1.0 .
See also:
elm_toolbar_align_set() for details.
void elm_toolbar_align_set ( Evas_Object *  obj,
double  align 
)

Set the alignment of the items.

Parameters:
objThe toolbar object.
alignThe new alignment, a float between 0.0 and 1.0 .

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.

See also:
elm_toolbar_align_get()
Elm_Object_Item* elm_toolbar_first_item_get ( const Evas_Object *  obj)

Get the first item in the given toolbar widget's list of items.

Parameters:
objThe toolbar object
Returns:
The first item or NULL, if it has no items (and on errors)
See also:
elm_toolbar_item_append()
elm_toolbar_last_item_get()
Eina_Bool elm_toolbar_homogeneous_get ( const Evas_Object *  obj)

Get whether the homogeneous mode is enabled.

Parameters:
objThe toolbar object.
Returns:
Assume the items within the toolbar are of the same height and width (EINA_TRUE = on, EINA_FALSE = off).
See also:
elm_toolbar_homogeneous_set()
void elm_toolbar_homogeneous_set ( Evas_Object *  obj,
Eina_Bool  homogeneous 
)

Enable/disable homogeneous mode.

Parameters:
objThe toolbar object
homogeneousAssume the items within the toolbar are of the same size (EINA_TRUE = on, EINA_FALSE = off). Default is EINA_FALSE.

This will enable the homogeneous mode where items are of the same size.

See also:
elm_toolbar_homogeneous_get()

References elm_toolbar_shrink_mode_set(), and ELM_TOOLBAR_SHRINK_NONE.

Referenced by elm_toolbar_shrink_mode_set().

Eina_Bool elm_toolbar_horizontal_get ( const Evas_Object *  obj)

Get a toolbar's orientation.

Parameters:
objThe toolbar object
Returns:
If EINA_TRUE, the toolbar is horizontal By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
void elm_toolbar_horizontal_set ( Evas_Object *  obj,
Eina_Bool  horizontal 
)

Change a toolbar's orientation.

Parameters:
objThe toolbar object
horizontalIf EINA_TRUE, the toolbar is horizontal By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get ( const Evas_Object *  obj)

Gets the icon lookup order.

Parameters:
objThe toolbar object.
Returns:
The icon lookup order.
See also:
elm_toolbar_icon_order_lookup_set() for details.

References ELM_ICON_LOOKUP_THEME_FDO.

void elm_toolbar_icon_order_lookup_set ( Evas_Object *  obj,
Elm_Icon_Lookup_Order  order 
)

Sets icon lookup order, for toolbar items' icons.

Parameters:
objThe toolbar object.
orderThe icon lookup order.

Icons added before calling this function will not be affected. The default lookup order is ELM_ICON_LOOKUP_THEME_FDO.

See also:
elm_toolbar_icon_order_lookup_get()

References elm_icon_order_lookup_set().

Referenced by elm_toolbar_add().

int elm_toolbar_icon_size_get ( const Evas_Object *  obj)

Get the icon size, in pixels, to be used by toolbar items.

Parameters:
objThe toolbar object.
Returns:
The icon size in pixels.
See also:
elm_toolbar_icon_size_set() for details.
void elm_toolbar_icon_size_set ( Evas_Object *  obj,
int  icon_size 
)

Set the icon size, in pixels, to be used by toolbar items.

Parameters:
objThe toolbar object
icon_sizeThe icon size in pixels
Note:
Default value is 32. It reads value from elm config.
See also:
elm_toolbar_icon_size_get()
Elm_Object_Item* elm_toolbar_item_append ( Evas_Object *  obj,
const char *  icon,
const char *  label,
Evas_Smart_Cb  func,
const void *  data 
)

Append item to the toolbar.

Parameters:
objThe toolbar object.
iconA string with icon name or the absolute path of an image file.
labelThe label of the item.
funcThe function to call when the item is clicked.
dataThe data to associate with the item for related callbacks.
Returns:
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.

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 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.

See also:
elm_toolbar_item_icon_set()
elm_object_item_del()
Elm_Object_Item* elm_toolbar_item_find_by_label ( const Evas_Object *  obj,
const char *  label 
)

Returns a pointer to a toolbar item by its label.

Parameters:
objThe toolbar object.
labelThe label of the item to find.
Returns:
The pointer to the toolbar item matching label or NULL on failure.
Eina_Bool elm_toolbar_item_icon_file_set ( Elm_Object_Item it,
const char *  file,
const char *  key 
)

Set the icon associated with item to an image in a binary buffer.

Parameters:
itThe toolbar item.
fileThe file that contains the image
keyOptional key of img to pass to the image loader (eg. if img is an edje file)
Returns:
(EINA_TRUE = success, EINA_FALSE = error)
Note:
The icon image set by this function can be changed by elm_toolbar_item_icon_set().

References elm_icon_add(), and elm_image_file_set().

const char* elm_toolbar_item_icon_get ( const Elm_Object_Item it)

Get the string used to set the icon of item.

Parameters:
itThe toolbar item.
Returns:
The string associated with the icon object.
See also:
elm_toolbar_item_icon_set() for details.
Eina_Bool elm_toolbar_item_icon_memfile_set ( Elm_Object_Item it,
const void *  img,
size_t  size,
const char *  format,
const char *  key 
)

Set the icon associated with item to an image in a binary buffer.

Parameters:
itThe toolbar item.
imgThe binary data that will be used as an image
sizeThe size of binary data img
formatOptional format of img to pass to the image loader
keyOptional key of img to pass to the image loader (eg. if img is an edje file)
Returns:
(EINA_TRUE = success, EINA_FALSE = error)
Note:
The icon image set by this function can be changed by elm_toolbar_item_icon_set().

References elm_icon_add(), and elm_image_memfile_set().

Evas_Object* elm_toolbar_item_icon_object_get ( Elm_Object_Item it)

Get the icon object of item.

Parameters:
itThe toolbar item.
Returns:
The icon object
See also:
elm_toolbar_item_icon_set(), elm_toolbar_item_icon_file_set(), or elm_toolbar_item_icon_memfile_set() for details.
void elm_toolbar_item_icon_set ( Elm_Object_Item it,
const char *  icon 
)

Set the icon associated with item.

Parameters:
itThe toolbar item.
iconA string with icon name or the absolute path of an image 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.

See also:
elm_toolbar_icon_order_lookup_set()
elm_toolbar_icon_order_lookup_get()

References elm_icon_add().

Elm_Object_Item* elm_toolbar_item_insert_after ( Evas_Object *  obj,
Elm_Object_Item after,
const char *  icon,
const char *  label,
Evas_Smart_Cb  func,
const void *  data 
)

Insert a new item into the toolbar object after item after.

Parameters:
objThe toolbar object.
afterThe toolbar item to insert after.
iconA string with icon name or the absolute path of an image file.
labelThe label of the item.
funcThe function to call when the item is clicked.
dataThe data to associate with the item for related callbacks.
Returns:
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.

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 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.

See also:
elm_toolbar_item_icon_set()
elm_object_item_del()
Elm_Object_Item* elm_toolbar_item_insert_before ( Evas_Object *  obj,
Elm_Object_Item before,
const char *  icon,
const char *  label,
Evas_Smart_Cb  func,
const void *  data 
)

Insert a new item into the toolbar object before item before.

Parameters:
objThe toolbar object.
beforeThe toolbar item to insert before.
iconA string with icon name or the absolute path of an image file.
labelThe label of the item.
funcThe function to call when the item is clicked.
dataThe data to associate with the item for related callbacks.
Returns:
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.

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 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.

See also:
elm_toolbar_item_icon_set()
elm_object_item_del()
Evas_Object* elm_toolbar_item_menu_get ( const Elm_Object_Item it)

Get toolbar item's menu.

Parameters:
itThe toolbar item.
Returns:
Item's menu object or NULL on failure.

If item wasn't set as menu item with elm_toolbar_item_menu_set(), this function will set it.

See also:
elm_toolbar_item_menu_set() for details.
void elm_toolbar_item_menu_set ( Elm_Object_Item it,
Eina_Bool  menu 
)

Set whether the toolbar item opens a menu.

Parameters:
itThe toolbar item.
menuIf EINA_TRUE, item will opens a menu when selected.

A toolbar item can be set to be a menu, using this function.

Once it is set to be a menu, it can be manipulated through the menu-like function elm_toolbar_menu_parent_set() and the other elm_menu functions, using the Evas_Object menu returned by elm_toolbar_item_menu_get().

So, items to be displayed in this item's menu should be added with elm_menu_item_add().

The following code exemplifies the most basic usage:

 tb = elm_toolbar_add(win)
 item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
 elm_toolbar_item_menu_set(item, EINA_TRUE);
 elm_toolbar_menu_parent_set(tb, win);
 menu = elm_toolbar_item_menu_get(item);
 elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
 menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
 NULL);
See also:
elm_toolbar_item_menu_get()
Elm_Object_Item* elm_toolbar_item_next_get ( const Elm_Object_Item it)

Get the item after item in toolbar.

Parameters:
itThe toolbar item.
Returns:
The item after item, or NULL if none or on failure.
Note:
If it is the last item, NULL will be returned.
See also:
elm_toolbar_item_append()
Evas_Object* elm_toolbar_item_object_get ( const Elm_Object_Item it)

Get the object of item.

Parameters:
itThe toolbar item.
Returns:
The object
Elm_Object_Item* elm_toolbar_item_prepend ( Evas_Object *  obj,
const char *  icon,
const char *  label,
Evas_Smart_Cb  func,
const void *  data 
)

Prepend item to the toolbar.

Parameters:
objThe toolbar object.
iconA string with icon name or the absolute path of an image file.
labelThe label of the item.
funcThe function to call when the item is clicked.
dataThe data to associate with the item for related callbacks.
Returns:
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.

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 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.

See also:
elm_toolbar_item_icon_set()
elm_object_item_del()
Elm_Object_Item* elm_toolbar_item_prev_get ( const Elm_Object_Item it)

Get the item before item in toolbar.

Parameters:
itThe toolbar item.
Returns:
The item before item, or NULL if none or on failure.
Note:
If it is the first item, NULL will be returned.
See also:
elm_toolbar_item_prepend()
int elm_toolbar_item_priority_get ( const Elm_Object_Item it)

Get the priority of a toolbar item.

Parameters:
itThe toolbar item.
Returns:
The item priority, or 0 on failure.
See also:
elm_toolbar_item_priority_set() for details.
void elm_toolbar_item_priority_set ( Elm_Object_Item it,
int  priority 
)

Set the priority of a toolbar item.

Parameters:
itThe toolbar item.
priorityThe item priority. The default is zero.

This is used only when the toolbar shrink mode is set to ELM_TOOLBAR_SHRINK_MENU or ELM_TOOLBAR_SHRINK_HIDE. When space is less than required, items with low priority will be removed from the toolbar and added to a dynamically-created menu, while items with higher priority will remain on the toolbar, with the same order they were added.

See also:
elm_toolbar_item_priority_get()
void elm_toolbar_item_selected_set ( Elm_Object_Item it,
Eina_Bool  selected 
)

Set the selected state of an item.

Parameters:
itThe toolbar item
selectedThe selected state

This sets the selected state of the given item it. EINA_TRUE for selected, EINA_FALSE for not selected.

If a new item is selected the previously selected will be unselected. Previously selected item can be get with function elm_toolbar_selected_item_get().

Selected items will be highlighted.

See also:
elm_toolbar_item_selected_get()
elm_toolbar_selected_item_get()
Eina_Bool elm_toolbar_item_separator_get ( const Elm_Object_Item it)

Get a value whether item is a separator or not.

Parameters:
itThe toolbar item.
Returns:
EINA_TRUE means item it is a separator. EINA_FALSE indicates it's not. If it is NULL, EINA_FALSE is returned.
See also:
elm_toolbar_item_separator_set() for details.
void elm_toolbar_item_separator_set ( Elm_Object_Item it,
Eina_Bool  separator 
)

Set or unset item as a separator.

Parameters:
itThe toolbar item.
separatorEINA_TRUE to set item item as separator or EINA_FALSE to unset, i.e., item will be used as a regular item.

Items aren't set as separator by default.

If set as separator it will display separator theme, so won't display icons or label.

See also:
elm_toolbar_item_separator_get()
Elm_Toolbar_Item_State* elm_toolbar_item_state_add ( Elm_Object_Item it,
const char *  icon,
const char *  label,
Evas_Smart_Cb  func,
const void *  data 
)

Add a new state to item.

Parameters:
itThe toolbar item.
iconA string with icon name or the absolute path of an image file.
labelThe label of the new state.
funcThe function to call when the item is clicked when this state is selected.
dataThe data to associate with the state.
Returns:
The toolbar item state, or NULL upon failure.

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.

States created with this function can be removed with elm_toolbar_item_state_del().

See also:
elm_toolbar_item_state_del()
elm_toolbar_item_state_sel()
elm_toolbar_item_state_get()

References elm_icon_add(), and elm_icon_order_lookup_set().

Eina_Bool elm_toolbar_item_state_del ( Elm_Object_Item it,
Elm_Toolbar_Item_State state 
)

Delete a previously added state to item.

Parameters:
itThe toolbar item.
stateThe state to be deleted.
Returns:
EINA_TRUE on success or EINA_FALSE on failure.
See also:
elm_toolbar_item_state_add()

References elm_toolbar_item_state_unset().

Elm_Toolbar_Item_State* elm_toolbar_item_state_get ( const Elm_Object_Item it)

Get the current state of it.

Parameters:
itThe toolbar item.
Returns:
The selected state or NULL if none is selected or on failure.
See also:
elm_toolbar_item_state_set() for details.
elm_toolbar_item_state_unset()
elm_toolbar_item_state_add()
Elm_Toolbar_Item_State* elm_toolbar_item_state_next ( Elm_Object_Item it)

Get the state after selected state in toolbar's item.

Parameters:
itThe toolbar item to change state.
Returns:
The state after current state, or NULL on failure.

If last state is selected, this function will return first state.

See also:
elm_toolbar_item_state_set()
elm_toolbar_item_state_add()
Elm_Toolbar_Item_State* elm_toolbar_item_state_prev ( Elm_Object_Item it)

Get the state before selected state in toolbar's item.

Parameters:
itThe toolbar item to change state.
Returns:
The state before current state, or NULL on failure.

If first state is selected, this function will return last state.

See also:
elm_toolbar_item_state_set()
elm_toolbar_item_state_add()
Eina_Bool elm_toolbar_item_state_set ( Elm_Object_Item it,
Elm_Toolbar_Item_State state 
)

Set state as the current state of it.

Parameters:
itThe toolbar item.
stateThe state to use.
Returns:
EINA_TRUE on success or EINA_FALSE on failure.

If state is NULL, it won't select any state and the default item's icon and label will be used. It's the same behaviour than elm_toolbar_item_state_unset().

See also:
elm_toolbar_item_state_unset()

Referenced by elm_toolbar_item_state_unset().

void elm_toolbar_item_state_unset ( Elm_Object_Item it)

Unset the state of it.

Parameters:
itThe toolbar item.

The default icon and label from this item will be displayed.

See also:
elm_toolbar_item_state_set() for more details.

References elm_toolbar_item_state_set().

Referenced by elm_toolbar_item_state_del().

unsigned int elm_toolbar_items_count ( const Evas_Object *  obj)

Get the number of items in a toolbar.

Parameters:
objThe toolbar object
Returns:
The number of items in obj toolbar
Elm_Object_Item* elm_toolbar_last_item_get ( const Evas_Object *  obj)

Get the last item in the given toolbar widget's list of items.

Parameters:
objThe toolbar object
Returns:
The last item or NULL, if it has no items (and on errors)
See also:
elm_toolbar_item_prepend()
elm_toolbar_first_item_get()
Evas_Object* elm_toolbar_menu_parent_get ( const Evas_Object *  obj)

Get the parent object of the toolbar items' menus.

Parameters:
objThe toolbar object.
Returns:
The parent of the menu objects.
See also:
elm_toolbar_menu_parent_set() for details.
void elm_toolbar_menu_parent_set ( Evas_Object *  obj,
Evas_Object *  parent 
)

Set the parent object of the toolbar items' menus.

Parameters:
objThe toolbar object.
parentThe parent of the menu objects.

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 also:
elm_menu_parent_set() for details.
elm_toolbar_item_menu_set() for details.

References elm_menu_parent_set().

Elm_Object_Item* elm_toolbar_more_item_get ( const Evas_Object *  obj)

Get the more item.

Parameters:
objThe toolbar object.
Returns:
The toolbar more item.

The more item can be changed with function elm_object_item_text_set() and elm_object_item_content_set.

Elm_Object_Select_Mode elm_toolbar_select_mode_get ( const Evas_Object *  obj)

Get the toolbar select mode.

Parameters:
objThe toolbar object
Returns:
The select mode (If getting mode is failed, it returns ELM_OBJECT_SELECT_MODE_MAX)
See also:
elm_toolbar_select_mode_set()
void elm_toolbar_select_mode_set ( Evas_Object *  obj,
Elm_Object_Select_Mode  mode 
)

Set the toolbar select mode.

Parameters:
objThe toolbar object
modeThe 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 also:
elm_toolbar_select_mode_get()

References ELM_OBJECT_SELECT_MODE_ALWAYS.

Elm_Object_Item* elm_toolbar_selected_item_get ( const Evas_Object *  obj)

Get the selected item.

Parameters:
objThe toolbar object.
Returns:
The selected toolbar item.

The selected item can be unselected with function elm_toolbar_item_selected_set().

The selected item always will be highlighted on toolbar.

See also:
elm_toolbar_selected_items_get()
Elm_Toolbar_Shrink_Mode elm_toolbar_shrink_mode_get ( const Evas_Object *  obj)

Get the shrink mode of toolbar obj.

Parameters:
objThe toolbar object.
Returns:
Toolbar's items display behavior.
See also:
elm_toolbar_shrink_mode_set() for details.

References ELM_TOOLBAR_SHRINK_NONE.

void elm_toolbar_shrink_mode_set ( Evas_Object *  obj,
Elm_Toolbar_Shrink_Mode  shrink_mode 
)

Set the shrink state of toolbar obj.

Parameters:
objThe toolbar object.
shrink_modeToolbar's items display behavior.

The toolbar won't scroll if ELM_TOOLBAR_SHRINK_NONE, but will enforce a minimum size so all the items will fit, won't scroll and won't show the items that don't fit if ELM_TOOLBAR_SHRINK_HIDE, will scroll if ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to pop up excess elements with ELM_TOOLBAR_SHRINK_MENU.

References elm_toolbar_homogeneous_set(), ELM_TOOLBAR_SHRINK_EXPAND, ELM_TOOLBAR_SHRINK_HIDE, ELM_TOOLBAR_SHRINK_MENU, and ELM_TOOLBAR_SHRINK_SCROLL.

Referenced by elm_toolbar_add(), and elm_toolbar_homogeneous_set().

int elm_toolbar_standard_priority_get ( const Evas_Object *  obj)

Get the standard_priority of visible items in a toolbar.

Parameters:
objThe toolbar object
Returns:
The standard priority of items in obj toolbar
See also:
elm_toolbar_standard_priority_set()
Since:
1.7
void elm_toolbar_standard_priority_set ( Evas_Object *  obj,
int  priority 
)

Set the standard priority of visible items in a toolbar.

Parameters:
objThe toolbar object
priorityThe standard_priority of visible items

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 also:
elm_toolbar_standard_priority_get()
Since:
1.7