Ewl_Floater: A Floating Container
Detailed Description
Defines a widget for layering above other widgets in EWL's drawing area, with the ability to follow the movement of another widget.
- Remarks:
- Inherits from Ewl_Box.
Tutorial
Data Structures | |
| struct | Ewl_Floater |
| Inherits from Ewl_Box for layout purposes. Provides a means to layer above other widgets and to follow the movement of another widget. More... | |
Defines | |
| #define | EWL_FLOATER(floater) ((Ewl_Floater *) floater) |
| #define | EWL_FLOATER_IS(w) (ewl_widget_type_is(EWL_WIDGET(w), EWL_FLOATER_TYPE)) |
| #define | EWL_FLOATER_TYPE "floater" |
Typedefs | |
| typedef Ewl_Floater | Ewl_Floater |
Functions | |
| void | ewl_floater_cb_destroy (Ewl_Widget *w, void *ev_data, void *user_data) |
| void | ewl_floater_cb_follow_configure (Ewl_Widget *w, void *ev_data, void *user_data) |
| void | ewl_floater_cb_follow_destroy (Ewl_Widget *w, void *ev_data, void *user_data) |
| Ewl_Widget * | ewl_floater_follow_get (Ewl_Floater *f) |
| Get the widget we are following. | |
| void | ewl_floater_follow_set (Ewl_Floater *f, Ewl_Widget *p) |
| Set the widget to follow. | |
| int | ewl_floater_init (Ewl_Floater *f) |
| Initialize a floater to default values. | |
| Ewl_Widget * | ewl_floater_new (void) |
| Allocate a new floater widget. | |
| void | ewl_floater_position_set (Ewl_Floater *parent, int x, int y) |
| Set the start x/y position of the floater. | |
Define Documentation
| #define EWL_FLOATER | ( | floater | ) | ((Ewl_Floater *) floater) |
Typecasts a pointer to an Ewl_Floater pointer.
| #define EWL_FLOATER_IS | ( | w | ) | (ewl_widget_type_is(EWL_WIDGET(w), EWL_FLOATER_TYPE)) |
Returns TRUE if the widget is an Ewl_Floater, FALSE otherwise
| #define EWL_FLOATER_TYPE "floater" |
The type name for the Ewl_Floater widget
Typedef Documentation
| typedef struct Ewl_Floater Ewl_Floater |
The floater is a container for widgets that need to be drawn on top of multiple widgets (ie. dropdownbox)
Function Documentation
| void ewl_floater_cb_destroy | ( | Ewl_Widget * | w, | |
| void * | ev_data, | |||
| void * | user_data | |||
| ) |
| void ewl_floater_cb_follow_configure | ( | Ewl_Widget * | w, | |
| void * | ev_data, | |||
| void * | user_data | |||
| ) |
| void ewl_floater_cb_follow_destroy | ( | Ewl_Widget * | w, | |
| void * | ev_data, | |||
| void * | user_data | |||
| ) |
| Ewl_Widget* ewl_floater_follow_get | ( | Ewl_Floater * | f | ) |
Get the widget we are following.
- Parameters:
-
f,: The Floater to get the follow from
- Returns:
- Returns the widget the floater is following, or NULL
| void ewl_floater_follow_set | ( | Ewl_Floater * | f, | |
| Ewl_Widget * | p | |||
| ) |
Set the widget to follow.
- Parameters:
-
f,: The Ewl_Floater to set the follow into p,: The widget to follow
- Returns:
- Returns no value
| int ewl_floater_init | ( | Ewl_Floater * | f | ) |
Initialize a floater to default values.
- Parameters:
-
f,: the floater widget
- Returns:
- Returns no value.
| Ewl_Widget* ewl_floater_new | ( | void | ) |
Allocate a new floater widget.
- Returns:
- Returns NULL on failure, or the new floater widget on success.
| void ewl_floater_position_set | ( | Ewl_Floater * | f, | |
| int | x, | |||
| int | y | |||
| ) |
Set the start x/y position of the floater.
- Parameters:
-
f,: Ewl_Floater * - the floater widget x,: int - start x coordinate from the top y,: int - start y coordinate from the top
- Returns:
- Returns no value