Ewl_Toolbar: A toolbar widget
Detailed Description
Defines a widget to contain a toolbar.
- Remarks:
- Inherits from Ewl_Menubar.
Tutorial
Data Structures | |
| struct | Ewl_Toolbar |
| Inherits from Ewl_Menubar and extends to provide a toolbar layout. More... | |
Defines | |
| #define | EWL_TOOLBAR(toolbar) ((Ewl_Toolbar *) toolbar) |
| #define | EWL_TOOLBAR_IS(w) (ewl_widget_type_is(EWL_WIDGET(w), EWL_TOOLBAR_TYPE)) |
| #define | EWL_TOOLBAR_TYPE "toolbar" |
Typedefs | |
| typedef Ewl_Toolbar | Ewl_Toolbar |
Functions | |
| Ewl_Widget * | ewl_htoolbar_new (void) |
| Allocate a new toolbar widget with horizontal orientation. | |
| void | ewl_toolbar_cb_child_add (Ewl_Container *c, Ewl_Widget *w) |
| Ewl_Icon_Part | ewl_toolbar_icon_part_hidden_get (Ewl_Toolbar *t) |
| Retrieve the hidden part. | |
| void | ewl_toolbar_icon_part_hide (Ewl_Toolbar *t, Ewl_Icon_Part part) |
| Hide the given icon part. | |
| int | ewl_toolbar_init (Ewl_Toolbar *t) |
| Initialize the toolbar and inherited fields. | |
| Ewl_Widget * | ewl_toolbar_new (void) |
| Allocate a new toolbar widget with default (horizontal) orientation. | |
| Ewl_Orientation | ewl_toolbar_orientation_get (Ewl_Toolbar *t) |
| This retrieves the current orientation of the toolbar. | |
| void | ewl_toolbar_orientation_set (Ewl_Toolbar *t, Ewl_Orientation o) |
| Set the orientation of the toolbar. | |
| Ewl_Widget * | ewl_vtoolbar_new (void) |
| Allocate a new toolbar widget with vertical orientation. | |
Define Documentation
| #define EWL_TOOLBAR | ( | toolbar | ) | ((Ewl_Toolbar *) toolbar) |
Typecast a pointer to an Ewl_Toolbar pointer.
| #define EWL_TOOLBAR_IS | ( | w | ) | (ewl_widget_type_is(EWL_WIDGET(w), EWL_TOOLBAR_TYPE)) |
Returns TRUE if the widget is an Ewl_Toolbar, FALSE otherwise
| #define EWL_TOOLBAR_TYPE "toolbar" |
The type name for the Ewl_Toolbar widget
Typedef Documentation
| typedef struct Ewl_Toolbar Ewl_Toolbar |
Function Documentation
| Ewl_Widget* ewl_htoolbar_new | ( | void | ) |
Allocate a new toolbar widget with horizontal orientation.
- Returns:
- Returns pointer to new toolbar widget on success, NULL on failure.
| void ewl_toolbar_cb_child_add | ( | Ewl_Container * | c, | |
| Ewl_Widget * | w | |||
| ) |
| Ewl_Icon_Part ewl_toolbar_icon_part_hidden_get | ( | Ewl_Toolbar * | t | ) |
Retrieve the hidden part.
- Parameters:
-
t,: The toolbar to get the hidden part
- Returns:
- Returns the hidden icon part
| void ewl_toolbar_icon_part_hide | ( | Ewl_Toolbar * | t, | |
| Ewl_Icon_Part | part | |||
| ) |
Hide the given icon part.
- Parameters:
-
t,: The toolbar to set the hidden part part,: The Ewl_Icon_Part to hide
- Returns:
- Returns no value
| int ewl_toolbar_init | ( | Ewl_Toolbar * | t | ) |
Initialize the toolbar and inherited fields.
- Parameters:
-
t,: the toolbar to initialize
- Returns:
- Returns TRUE on success, FALSE on failure.
| Ewl_Widget* ewl_toolbar_new | ( | void | ) |
Allocate a new toolbar widget with default (horizontal) orientation.
- Returns:
- Returns pointer to new toolbar widget on success, NULL on failure.
| Ewl_Orientation ewl_toolbar_orientation_get | ( | Ewl_Toolbar * | t | ) |
This retrieves the current orientation of the toolbar.
- Parameters:
-
t,: The toolbar to get the orientation from
- Returns:
- Returns the orientation currently set on the toolbar
| void ewl_toolbar_orientation_set | ( | Ewl_Toolbar * | t, | |
| Ewl_Orientation | o | |||
| ) |
Set the orientation of the toolbar.
- Parameters:
-
t,: The toolbar to set the orientation on o,: The orientation to set on the toolbar
- Returns:
- Returns no value
| Ewl_Widget* ewl_vtoolbar_new | ( | void | ) |
Allocate a new toolbar widget with vertical orientation.
- Returns:
- Returns pointer to new toolbar widget on success, NULL on failure.