Ewl_Menubar: A menu bar widget
Detailed Description
Defines a class for displaying menu bars
- Remarks:
- Inherits from Ewl_Box.
Tutorial
Data Structures | |
| struct | Ewl_Menubar |
| Inherits from the Ewl_Box class and extends it to provide for a menubar. More... | |
| struct | Ewl_Menubar_Info |
| Provides a simple menu structure for the menubar. More... | |
Defines | |
| #define | EWL_MENUBAR(menubar) ((Ewl_Menubar *) menubar) |
| #define | EWL_MENUBAR_IS(w) (ewl_widget_type_is(EWL_WIDGET(w), EWL_MENUBAR_TYPE)) |
| #define | EWL_MENUBAR_TYPE "menubar" |
Typedefs | |
| typedef Ewl_Menubar | Ewl_Menubar |
| typedef Ewl_Menubar_Info | Ewl_Menubar_Info |
Functions | |
| Ewl_Widget * | ewl_hmenubar_new (void) |
| Creates a new Ewl_Menubar in a horizontal orientation. | |
| void | ewl_menubar_cb_child_add (Ewl_Container *c, Ewl_Widget *w) |
| void | ewl_menubar_from_info (Ewl_Menubar *mb, Ewl_Menubar_Info *info) |
| Sets up the menubar mb with the given info. | |
| int | ewl_menubar_init (Ewl_Menubar *mb) |
| Initialize a menubar to default values. | |
| Ewl_Widget * | ewl_menubar_new (void) |
| Allocate and initialize a new menubar widget. | |
| Ewl_Orientation | ewl_menubar_orientation_get (Ewl_Menubar *mb) |
| Gets the orientation of the menubar. | |
| void | ewl_menubar_orientation_set (Ewl_Menubar *mb, Ewl_Orientation o) |
| Sets the orientation of the menubar. | |
| Ewl_Widget * | ewl_vmenubar_new (void) |
| Creates a new Ewl_Menubar in a vertical orientation. | |
Define Documentation
| #define EWL_MENUBAR | ( | menubar | ) | ((Ewl_Menubar *) menubar) |
Typecasts a pointer to a Ewl_Menubar pointer
| #define EWL_MENUBAR_IS | ( | w | ) | (ewl_widget_type_is(EWL_WIDGET(w), EWL_MENUBAR_TYPE)) |
Returns TRUE if the widget is an Ewl_Menubar, FALSE otherwise
| #define EWL_MENUBAR_TYPE "menubar" |
The type name for the Ewl_Menubar widget
Typedef Documentation
| typedef struct Ewl_Menubar Ewl_Menubar |
The Ewl_Menubar widget
| typedef struct Ewl_Menubar_Info Ewl_Menubar_Info |
Function Documentation
| Ewl_Widget* ewl_hmenubar_new | ( | void | ) |
Creates a new Ewl_Menubar in a horizontal orientation.
- Returns:
- Returns NULL on failure or a pointer to a new horizontal menubar on success
| void ewl_menubar_cb_child_add | ( | Ewl_Container * | c, | |
| Ewl_Widget * | w | |||
| ) |
| void ewl_menubar_from_info | ( | Ewl_Menubar * | mb, | |
| Ewl_Menubar_Info * | info | |||
| ) |
Sets up the menubar mb with the given info.
- Parameters:
-
mb,: The menubar to work with info,: The menubar info to work with
- Returns:
- Returns no value
| int ewl_menubar_init | ( | Ewl_Menubar * | mb | ) |
Initialize a menubar to default values.
- Parameters:
-
mb,: the menubar to initialize
- Returns:
- Returns TRUE on success and FALSE on failure
| Ewl_Widget* ewl_menubar_new | ( | void | ) |
Allocate and initialize a new menubar widget.
- Returns:
- Returns NULL on failure, or a pointer to a new menubar on success.
| Ewl_Orientation ewl_menubar_orientation_get | ( | Ewl_Menubar * | mb | ) |
Gets the orientation of the menubar.
- Parameters:
-
mb,: The menubar to get the orientation from
- Returns:
- Returns the orientation of the menubar
| void ewl_menubar_orientation_set | ( | Ewl_Menubar * | mb, | |
| Ewl_Orientation | o | |||
| ) |
Sets the orientation of the menubar.
- Parameters:
-
mb,: The menubar to set the orientation on o,: The orientation to set onto the menubar
- Returns:
- Returns no value.
| Ewl_Widget* ewl_vmenubar_new | ( | void | ) |
Creates a new Ewl_Menubar in a vertical orientation.
- Returns:
- Returns NULL on failure or a pointer to a new vertical menubar on success