Download

Support

Ewl_Notebook: A notebook widget


Detailed Description

Defines a class for notebook layout

Remarks:
Inherits from Ewl_Box.

Tutorial


Data Structures

struct  Ewl_Notebook
 Inherits from Ewl_Box and extends to provide for a notebook style layout. More...

Defines

#define EWL_NOTEBOOK(n)   ((Ewl_Notebook *)n)
#define EWL_NOTEBOOK_IS(w)   (ewl_widget_type_is(EWL_WIDGET(w), EWL_NOTEBOOK_TYPE))
#define EWL_NOTEBOOK_TYPE   "notebook"

Typedefs

typedef struct Ewl_Notebook Ewl_Notebook

Functions

void ewl_notebook_cb_child_add (Ewl_Container *c, Ewl_Widget *w)
void ewl_notebook_cb_child_hide (Ewl_Container *c, Ewl_Widget *w)
void ewl_notebook_cb_child_remove (Ewl_Container *c, Ewl_Widget *w, int rem_idx)
void ewl_notebook_cb_child_show (Ewl_Container *c, Ewl_Widget *w)
void ewl_notebook_cb_tab_clicked (Ewl_Widget *w, void *ev, void *data)
int ewl_notebook_init (Ewl_Notebook *n)
 Initialize a notebook to default values and callbacks.
Ewl_Widgetewl_notebook_new (void)
 Create a new notebook widget.
const char * ewl_notebook_page_tab_text_get (Ewl_Notebook *n, Ewl_Widget *page)
 Get the text of the notebook page page.
void ewl_notebook_page_tab_text_set (Ewl_Notebook *n, Ewl_Widget *page, const char *text)
 Set the text of the tab for the page page to the text text.
Ewl_Widgetewl_notebook_page_tab_widget_get (Ewl_Notebook *n, Ewl_Widget *page)
 Retrieve the widget used as the tab for the page page.
void ewl_notebook_page_tab_widget_set (Ewl_Notebook *n, Ewl_Widget *page, Ewl_Widget *tab)
 Set the widget to use as the tab for the page page to widget tab.
unsigned int ewl_notebook_tabbar_alignment_get (Ewl_Notebook *n)
 Retrieves the alignment of the tabbar in the notebook widget.
void ewl_notebook_tabbar_alignment_set (Ewl_Notebook *n, unsigned int align)
 Set the alignment of the tabbar in the notebook widget.
unsigned int ewl_notebook_tabbar_homogeneous_get (Ewl_Notebook *n)
 Retrieves the homogeneous value of the notebook.
void ewl_notebook_tabbar_homogeneous_set (Ewl_Notebook *n, unsigned int h)
 Sets the tabs in the notebook to be the same size.
Ewl_Position ewl_notebook_tabbar_position_get (Ewl_Notebook *n)
 Get the position of the tabbar in the notebook widget.
void ewl_notebook_tabbar_position_set (Ewl_Notebook *n, Ewl_Position pos)
 Set the position of the tabbar in the notebook widget.
unsigned int ewl_notebook_tabbar_visible_get (Ewl_Notebook *n)
 Retrieve if the tabbar is visible.
void ewl_notebook_tabbar_visible_set (Ewl_Notebook *n, unsigned int visible)
 Set if the tabbar is visible.
Ewl_Widgetewl_notebook_visible_page_get (Ewl_Notebook *n)
 Get the current visible page of the notebook.
void ewl_notebook_visible_page_set (Ewl_Notebook *n, Ewl_Widget *page)
 Set the current visible page of the notebook.

Define Documentation

#define EWL_NOTEBOOK (  )     ((Ewl_Notebook *)n)

#define EWL_NOTEBOOK_IS (  )     (ewl_widget_type_is(EWL_WIDGET(w), EWL_NOTEBOOK_TYPE))

Returns TRUE if the widget is an Ewl_Notebook, FALSE otherwise


Typedef Documentation

typedef struct Ewl_Notebook Ewl_Notebook

Holds the notebook information


Function Documentation

Ewl_Widget* ewl_notebook_new ( void   ) 

Create a new notebook widget.

Returns:
Returns a newly allocated notebook on success. NULL on failure

References DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_NOTEBOOK, ewl_notebook_init(), ewl_widget_destroy(), and NEW.

const char* ewl_notebook_page_tab_text_get ( Ewl_Notebook n,
Ewl_Widget page 
)

Get the text of the notebook page page.

Parameters:
n,: The Ewl_Notebook to work with
page,: The page to get the tab text from
Returns:
Returns the text of the pages tab

References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_LABEL, ewl_label_text_get(), ewl_notebook_page_tab_widget_get(), EWL_NOTEBOOK_TYPE, and EWL_WIDGET_TYPE.

void ewl_notebook_page_tab_text_set ( Ewl_Notebook n,
Ewl_Widget page,
const char *  text 
)

Set the text of the tab for the page page to the text text.

Parameters:
n,: The Ewl_Notebook to set the tab text in
page,: The page to associate the tab text too
text,: The text to set in the tab
Returns:
Returns no value.

References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_LABEL, ewl_label_new(), ewl_label_text_set(), ewl_notebook_page_tab_widget_set(), EWL_NOTEBOOK_TYPE, ewl_widget_show(), and EWL_WIDGET_TYPE.

Ewl_Widget* ewl_notebook_page_tab_widget_get ( Ewl_Notebook n,
Ewl_Widget page 
)

Retrieve the widget used as the tab for the page page.

Parameters:
n,: The Ewl_Notebook to get the tab widget from
page,: The page to get the tab from
Returns:
Returns the tab widget associated with the given page

References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, DWARNING, ewl_attach_widget_association_get, EWL_CONTAINER, ewl_container_child_get(), EWL_NOTEBOOK_TYPE, and EWL_WIDGET_TYPE.

Referenced by ewl_notebook_page_tab_text_get().

unsigned int ewl_notebook_tabbar_alignment_get ( Ewl_Notebook n  ) 

Retrieves the alignment of the tabbar in the notebook widget.

Parameters:
n,: The Ewl_Notebook to get the alignment from
Returns:
Returns the current alignment values of the widget

References body, DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_NOTEBOOK_TYPE, EWL_OBJECT, ewl_object_alignment_get(), and tabbar.

void ewl_notebook_tabbar_alignment_set ( Ewl_Notebook n,
unsigned int  align 
)

Set the alignment of the tabbar in the notebook widget.

Parameters:
n,: The Ewl_Notebook to set the tabbar alignment of
align,: The Ewl_Alignment to set the alignment too
Returns:
Returns no value.

References body, DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_NOTEBOOK_TYPE, EWL_OBJECT, ewl_object_alignment_set(), and tabbar.

unsigned int ewl_notebook_tabbar_homogeneous_get ( Ewl_Notebook n  ) 

Retrieves the homogeneous value of the notebook.

Parameters:
n,: The Ewl_Notebook to check for homogeneous
Returns:
Returns the homgeneous value of the notebook n

References body, DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_BOX, ewl_box_homogeneous_get(), EWL_NOTEBOOK_TYPE, and tabbar.

void ewl_notebook_tabbar_homogeneous_set ( Ewl_Notebook n,
unsigned int  h 
)

Sets the tabs in the notebook to be the same size.

Parameters:
n,: The Ewl_Notebook to make homogeneous
h,: Boolean value to set the notebook's homogeneous value
Returns:
Returns no value

References body, DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_BOX, ewl_box_homogeneous_set(), EWL_NOTEBOOK_TYPE, and tabbar.

Ewl_Position ewl_notebook_tabbar_position_get ( Ewl_Notebook n  ) 

Get the position of the tabbar in the notebook widget.

Parameters:
n,: The Ewl_Notebook to get the tabbar position of
Returns:
Returns the current Ewl_Position of the tabbar

References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_NOTEBOOK_TYPE, EWL_POSITION_TOP, and tabbar_position.

unsigned int ewl_notebook_tabbar_visible_get ( Ewl_Notebook n  ) 

Retrieve if the tabbar is visible.

Parameters:
n,: The Ewl_Notebook to get the tabbar visiblity of
Returns:
Returns the visibility of the tabbar

References body, DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_NOTEBOOK_TYPE, tabbar, and VISIBLE.

void ewl_notebook_tabbar_visible_set ( Ewl_Notebook n,
unsigned int  visible 
)

Set if the tabbar is visible.

Parameters:
n,: The Ewl_Notebook to set the visible flag of the tabbar
visible,: The flag to set for the tabbar visibility
Returns:
Returns no value.

References body, DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_NOTEBOOK_TYPE, EWL_STATE_PERSISTENT, EWL_WIDGET, ewl_widget_hide(), ewl_widget_show(), ewl_widget_state_set(), pages, and tabbar.

Ewl_Widget* ewl_notebook_visible_page_get ( Ewl_Notebook n  ) 

Get the current visible page of the notebook.

Parameters:
n,: The Ewl_Notebook to get the visible page of
Returns:
Returns the visible page of the notebook

References cur_page, DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, and EWL_NOTEBOOK_TYPE.

void ewl_notebook_visible_page_set ( Ewl_Notebook n,
Ewl_Widget page 
)


Copyright © Enlightenment.org

Enlightened Widget Library Documentation Generated: Sat May 17 16:51:10 2008