Typedefs | Functions
Toolbar

Typedefs

typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State
 State of a Elm_Toolbar_Item. More...
 

Functions

void elm_toolbar_item_state_unset (Elm_Object_Item *it)
 Unset the state of it. More...
 
Evas_Object * elm_toolbar_add (Evas_Object *parent)
 Add a new toolbar widget to the given parent Elementary (container) object. More...
 
void elm_toolbar_reorder_mode_set (Evas_Object *obj, Eina_Bool reorder_mode)
 Set reorder mode. More...
 
Eina_Bool elm_toolbar_reorder_mode_get (const Evas_Object *obj)
 Get the reorder mode. More...
 
void elm_toolbar_transverse_expanded_set (Evas_Object *obj, Eina_Bool transverse_expanded)
 Set the item's transverse expansion of a given toolbar widget obj. More...
 
Eina_Bool elm_toolbar_transverse_expanded_get (const Evas_Object *obj)
 Get the transverse expansion of toolbar obj. More...
 

Detailed Description

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

This widget implements the elm-scrollable-interface interface, so that all (non-deprecated) functions for the base Scroller widget also work for toolbars (since 1.8)

Smart callbacks one can listen to:

Available styles for it:

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

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

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_config_scale_get(), elm_icon_add(), and elm_image_file_set().

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.

Referenced by elm_toolbar_transverse_expanded_get().

Eina_Bool elm_toolbar_reorder_mode_get ( const Evas_Object *  obj)

Get the reorder mode.

Parameters
objThe toolbar object
Returns
The reorder mode (EINA_TRUE = on, EINA_FALSE = off)
void elm_toolbar_reorder_mode_set ( Evas_Object *  obj,
Eina_Bool  reorder_mode 
)

Set reorder mode.

Parameters
objThe toolbar object
reorder_modeThe reorder mode (EINA_TRUE = on, EINA_FALSE = off)
Eina_Bool elm_toolbar_transverse_expanded_get ( const Evas_Object *  obj)

Get the transverse expansion of toolbar obj.

Parameters
objThe toolbar object.
Returns
The transverse expansion of the item. (EINA_TRUE = on, EINA_FALSE = off, default = EINA_FALSE)
See also
elm_toolbar_transverse_expand_set() for details.

References elm_icon_add(), elm_menu_parent_set(), and elm_toolbar_item_state_unset().

void elm_toolbar_transverse_expanded_set ( Evas_Object *  obj,
Eina_Bool  transverse_expanded 
)

Set the item's transverse expansion of a given toolbar widget obj.

Parameters
objThe toolbar object.
transverse_expandedThe transverse expansion of the item. (EINA_TRUE = on, EINA_FALSE = off, default = EINA_FALSE)

This will expand the transverse length of the item according the transverse length of the toolbar. The default is what the transverse length of the item is set according its min value.