Home News About Download

Main Page Widgets Data Structures Related Pages Index

Support Contribute Contact Tracker

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 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_Widget *	ewl_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_Widget *	ewl_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_Widget *	ewl_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

(

n

)

((Ewl_Notebook *)n)

Typecasts a pointer to an Ewl_Notebook pointer.

#define EWL_NOTEBOOK_IS

(

w

)

(ewl_widget_type_is(EWL_WIDGET(w), EWL_NOTEBOOK_TYPE))

Returns TRUE if the widget is an Ewl_Notebook, FALSE otherwise

#define EWL_NOTEBOOK_TYPE   "notebook"

The type name for the Ewl_Notebook widget

---

Typedef Documentation

typedef struct Ewl_Notebook Ewl_Notebook

Holds the notebook information

---

Function Documentation

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.

Parameters:

n,:

The Ewl_Notebook widget to initialize

Returns:

Returns TRUE on success or NULL on failure.

Ewl_Widget* ewl_notebook_new

(

void

)

Create a new notebook widget.

Returns:

Returns a newly allocated notebook on success. NULL on failure

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

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.

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

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.

Parameters:

	n,:	The Ewl_Notebook to set the tab into
	page,:	The page to associate the tab with
	tab,:	The contents of the tab

Returns:

Returns no value.

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

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.

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

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

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

void ewl_notebook_tabbar_position_set	(	Ewl_Notebook *	n,
		Ewl_Position	pos
	)

Set the position of the tabbar in the notebook widget.

Parameters:

	n,:	The Ewl_Notebook to set the tabbar position of
	pos,:	The Ewl_Position to put the tabbar in

Returns:

Returns no value.

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

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.

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

void ewl_notebook_visible_page_set	(	Ewl_Notebook *	n,
		Ewl_Widget *	page
	)

Set the current visible page of the notebook.

Parameters:

	n,:	The Ewl_Notebook to set the visible page of
	page,:	The page to set visible in the tabbar

Returns:

Returns no value.

---

Copyright © Enlightenment.org

Enlightened Widget Library Documentation Generated: Sun Sep 27 01:49:47 2009