Ewl_Dialog: A dialog window
Detailed Description
Defines the Ewl_Dialog class which extends the Ewl_Window class.
- Remarks:
- Inherits from Ewl_Window.
Tutorial
Data Structures | |
| struct | Ewl_Dialog |
| Inherits from Ewl_Window and extends to provide a dialog widget. More... | |
Defines | |
| #define | EWL_DIALOG(dialog) ((Ewl_Dialog *) dialog) |
| #define | EWL_DIALOG_IS(w) (ewl_widget_type_is(EWL_WIDGET(w), EWL_DIALOG_TYPE)) |
| #define | EWL_DIALOG_TYPE "dialog" |
Typedefs | |
| typedef Ewl_Dialog | Ewl_Dialog |
Functions | |
| unsigned int | ewl_dialog_action_alignment_get (Ewl_Dialog *dialog) |
| Checks the alignment of the action area. | |
| void | ewl_dialog_action_alignment_set (Ewl_Dialog *d, unsigned int a) |
| Changes the action area's alignment for the dialog. | |
| unsigned int | ewl_dialog_action_fill_policy_get (Ewl_Dialog *dialog) |
| Checks the fill policy of the action area. | |
| void | ewl_dialog_action_fill_policy_set (Ewl_Dialog *d, unsigned int pol) |
| Changes the action area's fill policy for the dialog. | |
| Ewl_Position | ewl_dialog_action_position_get (Ewl_Dialog *dialog) |
| Checks the action area position for a dialog. | |
| void | ewl_dialog_action_position_set (Ewl_Dialog *d, Ewl_Position pos) |
| Changes the action area position for a dialog. | |
| Ewl_Position | ewl_dialog_active_area_get (Ewl_Dialog *d) |
| Retrieve the location of the dialog widgets will be packed into. | |
| void | ewl_dialog_active_area_set (Ewl_Dialog *d, Ewl_Position pos) |
| Sets the section of the dialog that will have widgets packed into it. | |
| unsigned int | ewl_dialog_has_separator_get (Ewl_Dialog *dialog) |
| Checks if dialog has a separator or not. | |
| void | ewl_dialog_has_separator_set (Ewl_Dialog *dialog, unsigned int has_sep) |
| Sets the separator of dialog. | |
| int | ewl_dialog_init (Ewl_Dialog *dialog) |
| Initialize an internal dialog to starting values. | |
| Ewl_Widget * | ewl_dialog_new (void) |
| Create a new internal dialog. | |
Define Documentation
| #define EWL_DIALOG | ( | dialog | ) | ((Ewl_Dialog *) dialog) |
Typecasts a pointer to an Ewl_Dialog pointer.
| #define EWL_DIALOG_IS | ( | w | ) | (ewl_widget_type_is(EWL_WIDGET(w), EWL_DIALOG_TYPE)) |
Returns TRUE if the widget is an Ewl_Dialog, FALSE otherwise
| #define EWL_DIALOG_TYPE "dialog" |
The type name for the Ewl_Dialog widget
Typedef Documentation
| typedef struct Ewl_Dialog Ewl_Dialog |
The dialog structure is a window with two areas: a box (vbox) to hold messages and another box (action_area) to put buttons (usually). These boxes can be separated by a line.
Function Documentation
| unsigned int ewl_dialog_action_alignment_get | ( | Ewl_Dialog * | d | ) |
Checks the alignment of the action area.
- Parameters:
-
d,: dialog to check the alignment of the action area
- Returns:
- Returns the current alignment of the action area.
| void ewl_dialog_action_alignment_set | ( | Ewl_Dialog * | d, | |
| unsigned int | align | |||
| ) |
Changes the action area's alignment for the dialog.
- Parameters:
-
d,: dialog to change the alignment of the action area position align,: The new alignment to set
- Returns:
- Returns no value.
| unsigned int ewl_dialog_action_fill_policy_get | ( | Ewl_Dialog * | d | ) |
Checks the fill policy of the action area.
- Parameters:
-
d,: dialog to check the fill policy of the action area
- Returns:
- Returns the current fill policy of the action area.
| void ewl_dialog_action_fill_policy_set | ( | Ewl_Dialog * | d, | |
| unsigned int | pol | |||
| ) |
Changes the action area's fill policy for the dialog.
- Parameters:
-
d,: dialog to change fill policy of the action area position pol,: The new fill policy to set
- Returns:
- Returns no value.
| Ewl_Position ewl_dialog_action_position_get | ( | Ewl_Dialog * | d | ) |
Checks the action area position for a dialog.
- Parameters:
-
d,: dialog to check action area position
- Returns:
- Returns the current action area position.
| void ewl_dialog_action_position_set | ( | Ewl_Dialog * | d, | |
| Ewl_Position | pos | |||
| ) |
Changes the action area position for a dialog.
- Parameters:
-
d,: dialog to change action area position pos,: the new position for the new action area
- Returns:
- Returns no value.
| Ewl_Position ewl_dialog_active_area_get | ( | Ewl_Dialog * | d | ) |
Retrieve the location of the dialog widgets will be packed into.
- Parameters:
-
d,: The Ewl_Dialog to get the active area from
- Returns:
- Returns the active portion of the dialog
| void ewl_dialog_active_area_set | ( | Ewl_Dialog * | d, | |
| Ewl_Position | pos | |||
| ) |
Sets the section of the dialog that will have widgets packed into it.
- Parameters:
-
d,: The Ewl_Dialog to work with pos,: The area of the dialog to set active
- Returns:
- Returns no value
| unsigned int ewl_dialog_has_separator_get | ( | Ewl_Dialog * | dialog | ) |
Checks if dialog has a separator or not.
- Parameters:
-
dialog,: the dialog.
- Returns:
- Returns TRUE if dialog has a separator.
| void ewl_dialog_has_separator_set | ( | Ewl_Dialog * | dialog, | |
| unsigned int | has_sep | |||
| ) |
Sets the separator of dialog.
- Parameters:
-
dialog,: the dialog. has_sep,: TRUE to draw the separator, FALSE to hide it.
- Returns:
- Returns no value.
| int ewl_dialog_init | ( | Ewl_Dialog * | dialog | ) |
Initialize an internal dialog to starting values.
- Parameters:
-
dialog,: the dialog to initialize.
- Returns:
- Return TRUE on success, FALSE otherwise.
| Ewl_Widget* ewl_dialog_new | ( | void | ) |
Create a new internal dialog.
- Returns:
- Returns a pointer to a new dialog on success, NULL on failure.