Ewl_Separator: A Visual Separator Between Widgets
Detailed Description
Defines the Ewl_Separator class used for drawing lines between widgets when visual separation is needed.
- Remarks:
- Inherits from Ewl_Widget.
Data Structures | |
| struct | Ewl_Separator |
| Inherits from Ewl_Widget to allow drawing a horizontal or vertical line between widgets, depending on the orientation the Ewl_Separator. More... | |
Defines | |
| #define | EWL_SEPARATOR(separator) ((Ewl_Separator *) separator) |
| #define | EWL_SEPARATOR_IS(w) (ewl_widget_type_is(EWL_WIDGET(w), EWL_SEPARATOR_TYPE)) |
| #define | EWL_SEPARATOR_TYPE "separator" |
Typedefs | |
| typedef Ewl_Separator | Ewl_Separator |
Functions | |
| Ewl_Widget * | ewl_hseparator_new (void) |
| Allocate a new separator widget with horizontal orientation. | |
| int | ewl_separator_init (Ewl_Separator *s) |
| Initialize the separator and inherited fields. | |
| Ewl_Widget * | ewl_separator_new (void) |
| Allocate a new separator widget with default (horizontal) orientation. | |
| Ewl_Orientation | ewl_separator_orientation_get (Ewl_Separator *s) |
| This retrieves the current orientation of the separator. | |
| void | ewl_separator_orientation_set (Ewl_Separator *s, Ewl_Orientation o) |
| Set the orientation of the separator. | |
| Ewl_Widget * | ewl_vseparator_new (void) |
| Allocate a new separator widget with vertical orientation. | |
Define Documentation
| #define EWL_SEPARATOR | ( | separator | ) | ((Ewl_Separator *) separator) |
Typecast a pointer to an Ewl_Separator pointer.
| #define EWL_SEPARATOR_IS | ( | w | ) | (ewl_widget_type_is(EWL_WIDGET(w), EWL_SEPARATOR_TYPE)) |
Returns TRUE if the widget is an Ewl_Separator, FALSE otherwise
| #define EWL_SEPARATOR_TYPE "separator" |
The type name for the Ewl_Separator widget
Typedef Documentation
| typedef struct Ewl_Separator Ewl_Separator |
Provides an Ewl_Widget to simply act as a separator between other Ewl_Widget's.
Function Documentation
| Ewl_Widget* ewl_hseparator_new | ( | void | ) |
Allocate a new separator widget with horizontal orientation.
- Returns:
- Returns pointer to new separator widget on success, NULL on failure.
| int ewl_separator_init | ( | Ewl_Separator * | s | ) |
Initialize the separator and inherited fields.
- Parameters:
-
s,: the separator to initialize
- Returns:
- Returns TRUE on success, FALSE on failure.
| Ewl_Widget* ewl_separator_new | ( | void | ) |
Allocate a new separator widget with default (horizontal) orientation.
- Returns:
- Returns pointer to new separator widget on success, NULL on failure.
| Ewl_Orientation ewl_separator_orientation_get | ( | Ewl_Separator * | s | ) |
This retrieves the current orientation of the separator.
- Parameters:
-
s,: The separator to get the orientation from
- Returns:
- Returns the orientation currently set on the separator
| void ewl_separator_orientation_set | ( | Ewl_Separator * | s, | |
| Ewl_Orientation | o | |||
| ) |
Set the orientation of the separator.
- Parameters:
-
s,: The separator to set the orientation on o,: The orientation to set on the separator
- Returns:
- Returns no value
| Ewl_Widget* ewl_vseparator_new | ( | void | ) |
Allocate a new separator widget with vertical orientation.
- Returns:
- Returns pointer to new separator widget on success, NULL on failure.