Ewl_Statusbar: A status bar widget
Detailed Description
Defines a class for displaying status bars
- Remarks:
- Inherits from Ewl_Box.
Tutorial
Data Structures | |
| struct | Ewl_Statusbar |
| Inherits from the Ewl_Box class and extends it to provide for a simple status bar. More... | |
Defines | |
| #define | EWL_STATUSBAR(statusbar) ((Ewl_Statusbar *) statusbar) |
| #define | EWL_STATUSBAR_IS(w) (ewl_widget_type_is(EWL_WIDGET(w), EWL_STATUSBAR_TYPE)) |
| #define | EWL_STATUSBAR_TYPE "statusbar" |
Typedefs | |
| typedef Ewl_Statusbar | Ewl_Statusbar |
Functions | |
| void | ewl_statusbar_active_set (Ewl_Statusbar *sb, Ewl_Position pos) |
| Sets the active statusbar container. | |
| void | ewl_statusbar_cb_destroy (Ewl_Widget *w, void *ev, void *data) |
| int | ewl_statusbar_init (Ewl_Statusbar *sb) |
| Initialize a statusbar to default values. | |
| void | ewl_statusbar_left_append (Ewl_Statusbar *sb, Ewl_Widget *w) |
| pack the given widget w into the statusbar sb into right of the left box. | |
| void | ewl_statusbar_left_hide (Ewl_Statusbar *sb) |
| hide the box on the left of the status bar | |
| void | ewl_statusbar_left_prepend (Ewl_Statusbar *sb, Ewl_Widget *w) |
| pack the given widget w into the statusbar sb into the left of the left box | |
| void | ewl_statusbar_left_show (Ewl_Statusbar *sb) |
| show the box on the left of the status bar | |
| Ewl_Widget * | ewl_statusbar_new (void) |
| Allocate and initialize a new statusbar widget. | |
| void | ewl_statusbar_pop (Ewl_Statusbar *sb) |
| Removes the most recent status message and displays the one before it. | |
| void | ewl_statusbar_push (Ewl_Statusbar *sb, const char *txt) |
| Displays the given status message on the statusbar. | |
| void | ewl_statusbar_right_append (Ewl_Statusbar *sb, Ewl_Widget *w) |
| pack the given widget w into the statusbar sb into the right of the right box | |
| void | ewl_statusbar_right_hide (Ewl_Statusbar *sb) |
| hide the box on the right of the status bar | |
| void | ewl_statusbar_right_prepend (Ewl_Statusbar *sb, Ewl_Widget *w) |
| pack the given widget w into the statusbar sb into the left of the right box | |
| void | ewl_statusbar_right_show (Ewl_Statusbar *sb) |
| show the box on the right of the status bar | |
Define Documentation
| #define EWL_STATUSBAR | ( | statusbar | ) | ((Ewl_Statusbar *) statusbar) |
Typecasts a pointer to a Ewl_Statusbar pointer
| #define EWL_STATUSBAR_IS | ( | w | ) | (ewl_widget_type_is(EWL_WIDGET(w), EWL_STATUSBAR_TYPE)) |
Returns TRUE if the widget is an Ewl_Statusbar, FALSE otherwise
| #define EWL_STATUSBAR_TYPE "statusbar" |
The type name for the Ewl_Statusbar widget
Typedef Documentation
| typedef struct Ewl_Statusbar Ewl_Statusbar |
The Ewl_Statusbar
Function Documentation
| void ewl_statusbar_active_set | ( | Ewl_Statusbar * | sb, | |
| Ewl_Position | pos | |||
| ) |
Sets the active statusbar container.
- Parameters:
-
sb,: The status bar to work on pos,: The side of the statusbar to set active either EWL_POSITION_LEFT or EWL_POSITION_RIGHT
- Returns:
- Returns no value
| void ewl_statusbar_cb_destroy | ( | Ewl_Widget * | w, | |
| void * | ev, | |||
| void * | data | |||
| ) |
| int ewl_statusbar_init | ( | Ewl_Statusbar * | sb | ) |
Initialize a statusbar to default values.
- Parameters:
-
sb,: the statusbar to initialize
- Returns:
- Returns 1 on success and 0 on failure
| void ewl_statusbar_left_append | ( | Ewl_Statusbar * | sb, | |
| Ewl_Widget * | w | |||
| ) |
pack the given widget w into the statusbar sb into right of the left box.
- Parameters:
-
sb,: The statusbar to operate on w,: The widget to add to the container
- Returns:
- Returns no value
| void ewl_statusbar_left_hide | ( | Ewl_Statusbar * | sb | ) |
hide the box on the left of the status bar
- Parameters:
-
sb,: The statusbar to work on
- Returns:
- Returns no value
| void ewl_statusbar_left_prepend | ( | Ewl_Statusbar * | sb, | |
| Ewl_Widget * | w | |||
| ) |
pack the given widget w into the statusbar sb into the left of the left box
- Parameters:
-
sb,: The statusbar to operate on w,: The widget to add to the container
- Returns:
- Returns no value
| void ewl_statusbar_left_show | ( | Ewl_Statusbar * | sb | ) |
show the box on the left of the status bar
- Parameters:
-
sb,: The statusbar to work on
- Returns:
- Returns no value
| Ewl_Widget* ewl_statusbar_new | ( | void | ) |
Allocate and initialize a new statusbar widget.
- Returns:
- Returns NULL on failure, or a pointer to a new statusbar on success.
| void ewl_statusbar_pop | ( | Ewl_Statusbar * | sb | ) |
Removes the most recent status message and displays the one before it.
- Parameters:
-
sb,: the status bar to remove the status mesasge from
- Returns:
- Returns no value
| void ewl_statusbar_push | ( | Ewl_Statusbar * | sb, | |
| const char * | txt | |||
| ) |
Displays the given status message on the statusbar.
- Parameters:
-
sb,: the statusbar to add the message too txt,: the status message to display
- Returns:
- Returns no value
| void ewl_statusbar_right_append | ( | Ewl_Statusbar * | sb, | |
| Ewl_Widget * | w | |||
| ) |
pack the given widget w into the statusbar sb into the right of the right box
- Parameters:
-
sb,: The statusbar to operate on w,: The widget to add to the container
- Returns:
- Returns no value
| void ewl_statusbar_right_hide | ( | Ewl_Statusbar * | sb | ) |
hide the box on the right of the status bar
- Parameters:
-
sb,: The statusbar to work on
- Returns:
- Returns no value
| void ewl_statusbar_right_prepend | ( | Ewl_Statusbar * | sb, | |
| Ewl_Widget * | w | |||
| ) |
pack the given widget w into the statusbar sb into the left of the right box
- Parameters:
-
sb,: The statusbar to operate on w,: The widget to add to the container
- Returns:
- Returns no value
| void ewl_statusbar_right_show | ( | Ewl_Statusbar * | sb | ) |
show the box on the right of the status bar
- Parameters:
-
sb,: The statusbar to work on
- Returns:
- Returns no value