Etk
Main Page Object Hierarchy Data Structures Related Pages
Etk

Etk_Toolbar


Detailed Description

The Etk_Toolbar is a widget that can contain widgets, mainly buttons, packed in one direction (horizontal of vertical).


Data Structures

struct  Etk_Toolbar
 [Widget] A widget that can contain widgets, mainly buttons, packed in one direction More...

Defines

#define ETK_TOOLBAR_TYPE   (etk_toolbar_type_get())
#define ETK_TOOLBAR(obj)   (ETK_OBJECT_CAST((obj), ETK_TOOLBAR_TYPE, Etk_Toolbar))
#define ETK_IS_TOOLBAR(obj)   (ETK_OBJECT_CHECK_TYPE((obj), ETK_TOOLBAR_TYPE))

Enumerations

enum  Etk_Toolbar_Orientation {
  ETK_TOOLBAR_HORIZ,
  ETK_TOOLBAR_VERT
}
 The orientation of a toolbar. More...
enum  Etk_Toolbar_Style {
  ETK_TOOLBAR_DEFAULT,
  ETK_TOOLBAR_ICON,
  ETK_TOOLBAR_TEXT,
  ETK_TOOLBAR_BOTH_HORIZ,
  ETK_TOOLBAR_BOTH_VERT
}
 The style of the toolbar's buttons (icon, text, both vertically, both horizontally). More...

Functions

Etk_Type * etk_toolbar_type_get (void)
 Gets the type of an Etk_Toolbar.
Etk_Widget * etk_toolbar_new (void)
 Creates a new toolbar (horizontal by default).
void etk_toolbar_append (Etk_Toolbar *toolbar, Etk_Widget *widget, Etk_Box_Group group)
 Appends an item to the start of the toolbar.
void etk_toolbar_prepend (Etk_Toolbar *toolbar, Etk_Widget *widget, Etk_Box_Group group)
 Prepends an item to the end of the toolbar.
void etk_toolbar_insert_at (Etk_Toolbar *toolbar, Etk_Widget *widget, Etk_Box_Group group, int pos)
 Adds an item to the toolbar at a specified position.
void etk_toolbar_orientation_set (Etk_Toolbar *toolbar, Etk_Toolbar_Orientation orientation)
 Sets the toolbar's orientation (horizontal or vertical).
Etk_Toolbar_Orientation etk_toolbar_orientation_get (Etk_Toolbar *toolbar)
 Gets the toolbar's orientation (horizontal or vertical).
void etk_toolbar_style_set (Etk_Toolbar *toolbar, Etk_Toolbar_Style style)
 Sets the style of toolbar's tool-buttons (icon, text, both vertically, both horizontally).
Etk_Toolbar_Style etk_toolbar_style_get (Etk_Toolbar *toolbar)
 Gets the style of toolbar's tool-buttons (icon, text, both vertically, both horizontally).
void etk_toolbar_stock_size_set (Etk_Toolbar *toolbar, Etk_Stock_Size size)
 Sets the stock-size of the toolbar's tool-buttons.
Etk_Stock_Size etk_toolbar_stock_size_get (Etk_Toolbar *toolbar)
 Gets the stock-size of the toolbar's tool-buttons.


Define Documentation

#define ETK_TOOLBAR_TYPE   (etk_toolbar_type_get())

Gets the type of a toolbar

Referenced by etk_toolbar_new().

#define ETK_TOOLBAR ( obj   )     (ETK_OBJECT_CAST((obj), ETK_TOOLBAR_TYPE, Etk_Toolbar))

Casts the object to an Etk_Toolbar

#define ETK_IS_TOOLBAR ( obj   )     (ETK_OBJECT_CHECK_TYPE((obj), ETK_TOOLBAR_TYPE))

Checks if the object is an Etk_Toolbar


Enumeration Type Documentation

enum Etk_Toolbar_Orientation

The orientation of a toolbar.

Enumerator:
ETK_TOOLBAR_HORIZ  The toolbar is horizontal
ETK_TOOLBAR_VERT  The toolbar is vertical

enum Etk_Toolbar_Style

The style of the toolbar's buttons (icon, text, both vertically, both horizontally).

Enumerator:
ETK_TOOLBAR_DEFAULT  Use Etk's default policy
ETK_TOOLBAR_ICON  Only the icon is visible
ETK_TOOLBAR_TEXT  Only the label is visible
ETK_TOOLBAR_BOTH_HORIZ  Both the icon and the label are visible, the icon is at the left of the label
ETK_TOOLBAR_BOTH_VERT  Both the icon and the label are visible, the icon is above the label


Function Documentation

Etk_Type * etk_toolbar_type_get ( void   ) 

Gets the type of an Etk_Toolbar.

Returns:
Returns the type of an Etk_Toolbar

References ETK_CONSTRUCTOR, ETK_CONTAINER_TYPE, ETK_PROPERTY_INT, ETK_PROPERTY_READABLE_WRITABLE, etk_property_value_int(), ETK_TOOLBAR_BOTH_VERT, ETK_TOOLBAR_HORIZ, etk_type_new(), etk_type_property_add(), Etk_Type::property_get, and Etk_Type::property_set.

Etk_Widget * etk_toolbar_new ( void   ) 

Creates a new toolbar (horizontal by default).

Returns:
Returns the new toolbar

References ETK_TOOLBAR_TYPE, and etk_widget_new().

void etk_toolbar_append ( Etk_Toolbar *  toolbar,
Etk_Widget *  widget,
Etk_Box_Group  group 
)

Appends an item to the start of the toolbar.

Parameters:
toolbar a toolbar
widget the item to append

References box, ETK_BOX, etk_box_append(), and ETK_BOX_NONE.

Referenced by etk_toolbar_orientation_set().

void etk_toolbar_prepend ( Etk_Toolbar *  toolbar,
Etk_Widget *  widget,
Etk_Box_Group  group 
)

Prepends an item to the end of the toolbar.

Parameters:
toolbar a toolbar
widget the item to append

References box, ETK_BOX, ETK_BOX_NONE, and etk_box_prepend().

void etk_toolbar_insert_at ( Etk_Toolbar *  toolbar,
Etk_Widget *  widget,
Etk_Box_Group  group,
int  pos 
)

Adds an item to the toolbar at a specified position.

Parameters:
toolbar a toolbar
widget the item to add
pos the position to add the item at

References box, ETK_BOX, etk_box_insert_at(), and ETK_BOX_NONE.

void etk_toolbar_orientation_set ( Etk_Toolbar *  toolbar,
Etk_Toolbar_Orientation  orientation 
)

Sets the toolbar's orientation (horizontal or vertical).

Parameters:
toolbar a toolbar
orientation the orientation to set

References box, ETK_BOX_START, ETK_CALLBACK, ETK_CONTAINER, etk_container_children_get(), etk_hbox_new(), ETK_OBJECT, etk_object_destroy(), etk_object_notify(), etk_toolbar_append(), ETK_TOOLBAR_VERT, etk_vbox_new(), ETK_WIDGET, etk_widget_internal_set(), etk_widget_parent_set(), etk_widget_show(), etk_widget_theme_group_set(), orientation, and reorientating.

Etk_Toolbar_Orientation etk_toolbar_orientation_get ( Etk_Toolbar *  toolbar  ) 

Gets the toolbar's orientation (horizontal or vertical).

Parameters:
toolbar a toolbar
Returns:
Returns the orientation of the toolbar

References orientation.

void etk_toolbar_style_set ( Etk_Toolbar *  toolbar,
Etk_Toolbar_Style  style 
)

Sets the style of toolbar's tool-buttons (icon, text, both vertically, both horizontally).

Parameters:
toolbar a toolbar
style the style to set

References box, ETK_BUTTON, ETK_BUTTON_BOTH_HORIZ, ETK_BUTTON_BOTH_VERT, ETK_BUTTON_ICON, etk_button_style_set(), ETK_BUTTON_TEXT, ETK_CONTAINER, etk_container_children_get(), ETK_OBJECT, etk_object_notify(), ETK_TOOLBAR_BOTH_HORIZ, ETK_TOOLBAR_BOTH_VERT, ETK_TOOLBAR_ICON, ETK_TOOLBAR_TEXT, and style.

Etk_Toolbar_Style etk_toolbar_style_get ( Etk_Toolbar *  toolbar  ) 

Gets the style of toolbar's tool-buttons (icon, text, both vertically, both horizontally).

Parameters:
toolbar a toolbar
Returns:
Returns the style of toolbar's tool-buttons

References ETK_TOOLBAR_DEFAULT, and style.

void etk_toolbar_stock_size_set ( Etk_Toolbar *  toolbar,
Etk_Stock_Size  size 
)

Sets the stock-size of the toolbar's tool-buttons.

Parameters:
toolbar a toolbar
size the stock-size to use

References box, ETK_BUTTON, etk_button_stock_size_set(), ETK_CONTAINER, etk_container_children_get(), ETK_OBJECT, etk_object_notify(), and stock_size.

Etk_Stock_Size etk_toolbar_stock_size_get ( Etk_Toolbar *  toolbar  ) 

Gets the stock-size of the toolbar's tool-buttons.

Parameters:
toolbar a toolbar
Returns:
Returns the stock-size of the toolbar's tool-buttons

References stock_size.