Ewl_Freebox_MVC: A free layout widget

---

Detailed Description

Defines a class to layout data in a free form.

Remarks:

Inherits from Ewl_MVC.

Data Structures
struct	Ewl_Freebox_MVC
	Inherits from EWL_MVC and extends to provide a free layout widget. More...
Defines
#define	EWL_FREEBOX_MVC(box)   ((Ewl_Freebox_MVC *)box)
#define	EWL_FREEBOX_MVC_IS(w)   (ewl_widget_type_is(EWL_WIDGET(w), EWL_FREEBOX_MVC_TYPE))
#define	EWL_FREEBOX_MVC_TYPE   "freebox_mvc"
Typedefs
typedef struct Ewl_Freebox_MVC	Ewl_Freebox_MVC
Functions
void	ewl_freebox_mvc_cb_configure (Ewl_Widget *w, void *ev, void *data)
void	ewl_freebox_mvc_cb_item_clicked (Ewl_Widget *w, void *ev, void *data)
void	ewl_freebox_mvc_cb_selected_change (Ewl_MVC *mvc)
int	ewl_freebox_mvc_init (Ewl_Freebox_MVC *fb_mvc)
	Initializes an Ewl_Freebox_MVC widget to default values.
Ewl_Widget *	ewl_freebox_mvc_new (void)
	Creates and initializes an Ewl_Freebox_MVC widget.
Ewl_Orientation	ewl_freebox_mvc_orientation_get (Ewl_Freebox_MVC *fb_mvc)
void	ewl_freebox_mvc_orientation_set (Ewl_Freebox_MVC *fb_mvc, Ewl_Orientation orientation)
	Sets the orientation of the freebox mvc.
Ewl_Widget *	ewl_hfreebox_mvc_new (void)
	creates and initializes a new horizontal freebox mvc widget
Ewl_Widget *	ewl_vfreebox_mvc_new (void)
	creates and initializes a new vertical freebox mvc widget

---

Define Documentation

#define EWL_FREEBOX_MVC

(

box

)

((Ewl_Freebox_MVC *)box)

Typecasts a pointer to an Ewl_Freebox_MVC pointer

Referenced by ewl_freebox_mvc_cb_configure(), ewl_freebox_mvc_new(), and ewl_vfreebox_mvc_new().

#define EWL_FREEBOX_MVC_IS

(

w

)

(ewl_widget_type_is(EWL_WIDGET(w), EWL_FREEBOX_MVC_TYPE))

Returns TRUE if the widget is an Ewl_Freebox_MVC, otherwise FALSE

#define EWL_FREEBOX_MVC_TYPE   "freebox_mvc"

The type name of the Ewl_Freebox_MVC widget

Referenced by ewl_freebox_mvc_cb_configure(), ewl_freebox_mvc_cb_item_clicked(), ewl_freebox_mvc_cb_selected_change(), ewl_freebox_mvc_init(), ewl_freebox_mvc_orientation_get(), and ewl_freebox_mvc_orientation_set().

---

Typedef Documentation

typedef struct Ewl_Freebox_MVC Ewl_Freebox_MVC

The freebox_mvc structure

---

Function Documentation

void ewl_freebox_mvc_cb_configure	(	Ewl_Widget *	w,
		void *	ev,
		void *	data
	)

void ewl_freebox_mvc_cb_item_clicked	(	Ewl_Widget *	w,
		void *	ev,
		void *	data
	)

References Ewl_Model::count, DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, DRETURN, DWARNING, ewl_callback_call_with_event_data(), EWL_CALLBACK_MVC_CLICKED, EWL_CONTAINER, ewl_container_child_index_get(), EWL_FREEBOX_MVC_TYPE, EWL_MVC, ewl_mvc_data_get(), ewl_mvc_model_get(), ewl_mvc_selection_mode_get(), EWL_SELECTION_MODE_NONE, EWL_WIDGET, and EWL_WIDGET_TYPE.

Referenced by ewl_freebox_mvc_cb_configure().

void ewl_freebox_mvc_cb_selected_change

(

Ewl_MVC *

mvc

)

References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_CONTAINER, EWL_FREEBOX_MVC_TYPE, and ewl_mvc_highlight().

Referenced by ewl_freebox_mvc_cb_configure(), and ewl_freebox_mvc_init().

int ewl_freebox_mvc_init

(

Ewl_Freebox_MVC *

fb_mvc

)

Initializes an Ewl_Freebox_MVC widget to default values.

Parameters:

fb_mvc,:

The fb_mvc to initialize

Returns:

Returns TRUE on success or FALSE on failure

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, ewl_callback_append(), EWL_CALLBACK_CONFIGURE, EWL_CONTAINER, ewl_container_child_append(), ewl_container_redirect_set(), ewl_freebox_mvc_cb_configure(), ewl_freebox_mvc_cb_selected_change(), EWL_FREEBOX_MVC_TYPE, ewl_hfreebox_new(), EWL_MVC, ewl_mvc_init(), ewl_mvc_selected_change_cb_set(), EWL_WIDGET, ewl_widget_appearance_set(), ewl_widget_inherit(), ewl_widget_show(), and freebox.

Referenced by ewl_freebox_mvc_new().

Ewl_Widget* ewl_freebox_mvc_new

(

void

)

Creates and initializes an Ewl_Freebox_MVC widget.

Returns:

Returns a new Ewl_Widget on success or NULL on failure

References DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_FREEBOX_MVC, ewl_freebox_mvc_init(), ewl_widget_destroy(), and NEW.

Referenced by ewl_hfreebox_mvc_new(), and ewl_vfreebox_mvc_new().

Ewl_Orientation ewl_freebox_mvc_orientation_get

(

Ewl_Freebox_MVC *

fb_mvc

)

Parameters:

fb_mvc,:

The freebox mvc to use

Returns:

Returns the orientation of the freebox mvc brief Retrieve the current orientation of the freebox mvc

References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_FREEBOX, EWL_FREEBOX_MVC_TYPE, ewl_freebox_orientation_get(), EWL_ORIENTATION_HORIZONTAL, and freebox.

void ewl_freebox_mvc_orientation_set	(	Ewl_Freebox_MVC *	fb_mvc,
		Ewl_Orientation	orientation
	)

Sets the orientation of the freebox mvc.

Parameters:

	fb_mvc,:	The freebox mvc to use
	orientation,:	The orientation to set

Returns:

Returns no value

References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_FREEBOX, EWL_FREEBOX_MVC_TYPE, ewl_freebox_orientation_set(), and freebox.

Ewl_Widget* ewl_hfreebox_mvc_new

(

void

)

creates and initializes a new horizontal freebox mvc widget

Returns:

Returns a new horizontal Ewl_Freebox_MVC widget or NULL on failure

References DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, and ewl_freebox_mvc_new().

Ewl_Widget* ewl_vfreebox_mvc_new

(

void

)

creates and initializes a new vertical freebox mvc widget

Returns:

Returns a new vertical Ewl_Freebox_MVC widget or NULL on failure

References DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_FREEBOX, EWL_FREEBOX_MVC, ewl_freebox_mvc_new(), ewl_freebox_orientation_set(), and EWL_ORIENTATION_VERTICAL.