Ewl_Expansion: The Expansion node for Tree
Detailed Description
Defines a widget for tree's expansion node
- Remarks:
- Inherits from Ewl_Check.
Data Structures | |
struct | Ewl_Expansion |
Inherits from Ewl_Check and extends it to provide a expanded state. More... | |
Defines | |
#define | EWL_EXPANSION(c) ((Ewl_Expansion *)c) |
#define | EWL_EXPANSION_IS(w) (ewl_widget_type_is(EWL_WIDGET(w), EWL_EXPANSION_TYPE)) |
#define | EWL_EXPANSION_TYPE "expansion" |
Typedefs | |
typedef struct Ewl_Expansion | Ewl_Expansion |
Functions | |
void | ewl_expansion_cb_reveal (Ewl_Widget *w, void *ev_data, void *user_data) |
void | ewl_expansion_expandable_set (Ewl_Expansion *c, int expandable) |
Change the expandable status of the expansion. | |
int | ewl_expansion_init (Ewl_Expansion *c) |
Initialize the members and callbacks of a expansion. | |
int | ewl_expansion_is_expandable (Ewl_Expansion *c) |
Determine the expandable state of the expansion. | |
Ewl_Widget * | ewl_expansion_new (void) |
Allocate and initialize a new expansion. |
Define Documentation
#define EWL_EXPANSION | ( | c | ) | ((Ewl_Expansion *)c) |
Typecasts a pointer to an Ewl_Expansion pointer.
Referenced by ewl_expansion_cb_reveal(), ewl_expansion_new(), ewl_tree_node_expandable_get(), and ewl_tree_node_expandable_set().
#define EWL_EXPANSION_IS | ( | w | ) | (ewl_widget_type_is(EWL_WIDGET(w), EWL_EXPANSION_TYPE)) |
Returns TRUE if the widget is an Ewl_Expansion, FALSE otherwise
#define EWL_EXPANSION_TYPE "expansion" |
- Widget Theme Keys:
- /expansion/group
Referenced by ewl_expansion_cb_reveal(), ewl_expansion_expandable_set(), ewl_expansion_init(), and ewl_expansion_is_expandable().
Typedef Documentation
typedef struct Ewl_Expansion Ewl_Expansion |
A tree expansion handle.
Function Documentation
void ewl_expansion_cb_reveal | ( | Ewl_Widget * | w, | |
void * | ev_data, | |||
void * | user_data | |||
) |
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_EXPANSION, and EWL_EXPANSION_TYPE.
Referenced by ewl_expansion_init().
void ewl_expansion_expandable_set | ( | Ewl_Expansion * | cb, | |
int | c | |||
) |
Change the expandable status of the expansion.
- Parameters:
-
cb,: the expansion to change the status c,: the new status of the expansion
- Returns:
- Returns no value. Changes the expandable status of the expansion and updates it's appearance to reflect the change.
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_EXPANSION_TYPE, and expandable.
Referenced by ewl_tree_node_expandable_set().
int ewl_expansion_init | ( | Ewl_Expansion * | cb | ) |
Initialize the members and callbacks of a expansion.
- Parameters:
-
cb,: the expansion to initialize
- Returns:
- Returns TRUE on success, FALSE on failure. The internal structures and callbacks of the expansion are initialized to default values.
References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, ewl_callback_append(), EWL_CALLBACK_REVEAL, EWL_CHECK, ewl_check_init(), ewl_expansion_cb_reveal(), EWL_EXPANSION_TYPE, EWL_FLAG_ALIGN_TOP, EWL_FLAG_FILL_NONE, EWL_OBJECT, ewl_object_alignment_set(), ewl_object_fill_policy_set(), EWL_WIDGET, ewl_widget_appearance_set(), and ewl_widget_inherit().
Referenced by ewl_expansion_new().
int ewl_expansion_is_expandable | ( | Ewl_Expansion * | cb | ) |
Determine the expandable state of the expansion.
- Parameters:
-
cb,: the expansion to examine for it's expandable state
- Returns:
- Returns TRUE if the expansion is expandable, FALSE if not.
References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_EXPANSION_TYPE, and expandable.
Referenced by ewl_tree_node_expandable_get().
Ewl_Widget* ewl_expansion_new | ( | void | ) |
Allocate and initialize a new expansion.
- Returns:
- Returns the newly allocated expansion on success, NULL on failure.
References DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_EXPANSION, ewl_expansion_init(), EWL_WIDGET, ewl_widget_destroy(), and NEW.
Referenced by ewl_tree_node_expandable_set().