Ewl_View: A data view
Detailed Description
Defines the callbacks for setting up the widgets based on the data returned from the Model. Create widgets, set data on widgets, calculate sizing, minimize number of widgets.
Data Structures | |
struct | Ewl_View |
The view function pointers. More... | |
Defines | |
#define | EWL_VIEW(view) ((Ewl_View *)view) |
#define | EWL_VIEW_EXPANSION_VIEW_FETCH_GET(f) ((Ewl_View_Expansion_View_Fetch)f) |
#define | EWL_VIEW_HEADER_GET(f) ((Ewl_View_Header_Fetch)f) |
#define | EWL_VIEW_WIDGET_FETCH(f) ((Ewl_View_Widget_Fetch)f) |
Typedefs | |
typedef struct Ewl_View | Ewl_View |
typedef Ewl_View *(* | Ewl_View_Expansion_View_Fetch )(void *data, unsigned int row) |
typedef Ewl_Widget *(* | Ewl_View_Header_Fetch )(void *data, unsigned int column) |
typedef Ewl_Widget *(* | Ewl_View_Widget_Fetch )(void *data, unsigned int row, unsigned int col) |
Functions | |
Ewl_View * | ewl_view_clone (const Ewl_View *src) |
Creates a new Ewl_View object. | |
Ewl_View_Expansion_View_Fetch | ewl_view_expansion_view_fetch_get (const Ewl_View *v) |
Gets the expansion view fetch callback from the view. | |
void | ewl_view_expansion_view_fetch_set (Ewl_View *v, Ewl_View_Expansion_View_Fetch f) |
Sets the expansion view fetch callback into the view. | |
Ewl_View_Header_Fetch | ewl_view_header_fetch_get (const Ewl_View *v) |
Gets the header fetch callback from the view. | |
void | ewl_view_header_fetch_set (Ewl_View *v, Ewl_View_Header_Fetch f) |
Sets the header fetch callback into the view. | |
int | ewl_view_init (Ewl_View *view) |
Initializes an Ewl_View object to default values. | |
Ewl_View * | ewl_view_new (void) |
Creates a new Ewl_View object. | |
Ewl_View_Widget_Fetch | ewl_view_widget_fetch_get (const Ewl_View *view) |
Get the constructor set on this view. | |
void | ewl_view_widget_fetch_set (Ewl_View *view, Ewl_View_Widget_Fetch construct) |
This will set the given widget fetch callback into the view. |
Define Documentation
#define EWL_VIEW_EXPANSION_VIEW_FETCH_GET | ( | f | ) | ((Ewl_View_Expansion_View_Fetch)f) |
View callback to get a view for expanded data on a row
#define EWL_VIEW_HEADER_GET | ( | f | ) | ((Ewl_View_Header_Fetch)f) |
View callback to get the header for a given column
#define EWL_VIEW_WIDGET_FETCH | ( | f | ) | ((Ewl_View_Widget_Fetch)f) |
View callback for the constructor for a data row
Typedef Documentation
typedef Ewl_View*(* Ewl_View_Expansion_View_Fetch)(void *data, unsigned int row) |
A typedef to shorten the definition of the view_expansion_view_fetch callbacks.
typedef Ewl_Widget*(* Ewl_View_Header_Fetch)(void *data, unsigned int column) |
A typedef to shorten the definition of the view_header_fetch callbacks.
typedef Ewl_Widget*(* Ewl_View_Widget_Fetch)(void *data, unsigned int row, unsigned int col) |
A typedef to shorten the definition of the view_widget_fetch callbacks.
Function Documentation
Creates a new Ewl_View object.
- Parameters:
-
src,: An existing view to copy as a basis for a new view
- Returns:
- Returns a new Ewl_View object on success or NULL on failure
References DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, ewl_view_init(), FREE, and NEW.
Ewl_View_Expansion_View_Fetch ewl_view_expansion_view_fetch_get | ( | const Ewl_View * | v | ) |
Gets the expansion view fetch callback from the view.
- Parameters:
-
v,: The Ewl_View to get the Ewl_View_Expansion_View_Fetch function from
- Returns:
- Returns the Ewl_View_Expansion_View_Fetch callback set on the view, or NULL on failure.
References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, and expansion.
void ewl_view_expansion_view_fetch_set | ( | Ewl_View * | v, | |
Ewl_View_Expansion_View_Fetch | f | |||
) |
Sets the expansion view fetch callback into the view.
- Parameters:
-
v,: The Ewl_View to set the expansion_view_fetch callback on f,: The Ewl_View_Expansion_View_Fetch callback
- Returns:
- Returns no value.
References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, and expansion.
Ewl_View_Header_Fetch ewl_view_header_fetch_get | ( | const Ewl_View * | v | ) |
Gets the header fetch callback from the view.
- Parameters:
-
v,: The Ewl_View to get the Ewl_View_Header_Fetch function from
- Returns:
- Returns the Ewl_View_Header_Fetch callback set on the view, or NULL on failure.
References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, and header_fetch.
void ewl_view_header_fetch_set | ( | Ewl_View * | v, | |
Ewl_View_Header_Fetch | f | |||
) |
Sets the header fetch callback into the view.
- Parameters:
-
v,: The Ewl_View to set the header_fetch callback on f,: The Ewl_View_Header_Fetch callback
- Returns:
- Returns no value.
References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, and header_fetch.
Referenced by ewl_button_view_get(), ewl_checkbutton_view_get(), ewl_entry_view_get(), ewl_filepicker_init(), ewl_image_view_get(), and ewl_label_view_get().
int ewl_view_init | ( | Ewl_View * | view | ) |
Initializes an Ewl_View object to default values.
- Parameters:
-
view,: The Ewl_View to initialize
- Returns:
- Returns TRUEE on success or FALSE on failure
References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, and DRETURN_INT.
Referenced by ewl_view_clone(), and ewl_view_new().
Ewl_View* ewl_view_new | ( | void | ) |
Creates a new Ewl_View object.
- Returns:
- Returns a new Ewl_View object on success or NULL on failure
References DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, ewl_view_init(), FREE, and NEW.
Referenced by ewl_button_view_get(), ewl_checkbutton_view_get(), ewl_entry_view_get(), ewl_image_view_get(), ewl_label_view_get(), ewl_tree_view_freebox_get(), ewl_tree_view_plain_get(), and ewl_tree_view_scrolled_get().
Ewl_View_Widget_Fetch ewl_view_widget_fetch_get | ( | const Ewl_View * | v | ) |
Get the constructor set on this view.
- Parameters:
-
v,: The Ewl_View to get the constructor from
- Returns:
- Returns the Ewl_View_Constructor set into the view or NULL if none set.
References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, and fetch.
void ewl_view_widget_fetch_set | ( | Ewl_View * | v, | |
Ewl_View_Widget_Fetch | fetch | |||
) |
This will set the given widget fetch callback into the view.
- Parameters:
-
v,: The Ewl_View to set the widget fetch callback into fetch,: The Ewl_View_Widget_Fetch to set into the view
- Returns:
- Returns no value.
References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, and fetch.
Referenced by ewl_button_view_get(), ewl_checkbutton_view_get(), ewl_entry_view_get(), ewl_image_view_get(), ewl_label_view_get(), ewl_tree_view_freebox_get(), ewl_tree_view_plain_get(), and ewl_tree_view_scrolled_get().