wex::notebook Class Reference

Offers a notebook with page access using keys, and that interfaces with wex::managed_frame. More...

#include <wex/notebook.h>

Inherits wxAuiNotebook.

Public Member Functions
	notebook (const window_data &data=window_data().style(wxAUI_NB_DEFAULT_STYLE))
	Other methods. More...
wxWindow *	add_page (wxWindow *page, const std::string &key, const std::string &caption=std::string(), bool select=false, const wxBitmap &bitmap=wxNullBitmap)
	Adds the page with given key and fills the keys. More...
const std::string	change_selection (const std::string &key)
	Changes the selection for the given page, returning the previous selection. More...
void	config_get ()
	Sets the configurable parameters to values currently in config.
const std::string	current_page_key ()
	Returns key for the current page.
bool	delete_page (const std::string &key)
	Deletes the page with the given key. More...
template<class T >
bool	for_each (int id)
	Do something for each page in the notebook. More...
wxWindow *	insert_page (size_t page_idx, wxWindow *page, const std::string &key, const std::string &caption=std::string(), bool select=false, const wxBitmap &bitmap=wxNullBitmap)
	Inserts the page with given key and fills the keys. More...
const std::string	key_by_page (wxWindow *page) const
	Returns the key specified by the given page. More...
wxWindow *	page_by_key (const std::string &key) const
	Returns the page specified by the given key. More...
int	page_index_by_key (const std::string &key) const
	Returns the page index specified by the given key. More...
void	rearrange (int direction)
	Rearranges all pages. More...
bool	set_page_text (const std::string &key, const std::string &new_key, const std::string &caption, const wxBitmap &bitmap=wxNullBitmap)
	Sets the pagetext for the given new key, on the page for the given key. More...
wxWindow *	set_selection (const std::string &key)
	Selects (and returns) the page specified by the given key. More...
bool	split (const std::string &key, int direction)
	Split performs a split operation programmatically. More...

Static Public Member Functions
static int	config_dialog (const window_data &data=window_data())
	Static interface. More...

Detailed Description

Offers a notebook with page access using keys, and that interfaces with wex::managed_frame.

Constructor & Destructor Documentation

notebook()

wex::notebook::notebook

(

const window_data &

data = window_data().style(wxAUI_NB_DEFAULT_STYLE)

)

Other methods.

Default constructor.

Member Function Documentation

add_page()

wxWindow* wex::notebook::add_page	(	wxWindow *	page,
		const std::string &	key,
		const std::string &	caption = std::string(),
		bool	select = false,
		const wxBitmap &	bitmap = wxNullBitmap
	)

Adds the page with given key and fills the keys.

Parameters

page	page to add
key	key for the page
caption	caption for the page, if empty uses key as caption
select	select the page after it is inserted
bitmap	bitmap for the page

change_selection()

const std::string wex::notebook::change_selection

(

const std::string &

key

)

Changes the selection for the given page, returning the previous selection.

If the key does not exist an empty string is returned.

config_dialog()

static int wex::notebook::config_dialog ( const window_data &  data = window_data() )

static

Static interface.

Shows a dialog with options, returns dialog return code. If used modeless, it uses the dialog id as specified, so you can use that id in frame::on_command_item_dialog.

delete_page()

bool wex::notebook::delete_page

(

const std::string &

key

)

Deletes the page with the given key.

Returns true if page could be deleted.

for_each()

template<class T >

bool wex::notebook::for_each ( int  id )

inline

Do something for each page in the notebook.

The id should be inbetween ID_ALL_LOWEST and ID_ALL_HIGHEST. Cannot be const as it can call delete_page.

insert_page()

wxWindow* wex::notebook::insert_page	(	size_t	page_idx,
		wxWindow *	page,
		const std::string &	key,
		const std::string &	caption = std::string(),
		bool	select = false,
		const wxBitmap &	bitmap = wxNullBitmap
	)

Inserts the page with given key and fills the keys.

Parameters

page_idx	index fo the page
page	page to add
key	key for the pagw
caption	caption for the page, if empty uses key as caption
select	select the page after it is inserted
bitmap	bitmap for the page

key_by_page()

const std::string wex::notebook::key_by_page ( wxWindow *  page ) const

inline

Returns the key specified by the given page.

If the page does not exist or is nullptr an empty string is returned.

page_by_key()

wxWindow* wex::notebook::page_by_key ( const std::string &  key ) const

inline

Returns the page specified by the given key.

If the key does not exist nullptr is returned.

page_index_by_key()

int wex::notebook::page_index_by_key ( const std::string &  key ) const

inline

Returns the page index specified by the given key.

If the key does not exist wxNOT_FOUND is returned.

rearrange()

void wex::notebook::rearrange

(

int

direction

)

Rearranges all pages.

Parameters

direction

Specify where the pane should go. It should be one of the following: wxTOP wxBOTTOM wxLEFT wxRIGHT

set_page_text()

bool wex::notebook::set_page_text	(	const std::string &	key,
		const std::string &	new_key,
		const std::string &	caption,
		const wxBitmap &	bitmap = wxNullBitmap
	)

Sets the pagetext for the given new key, on the page for the given key.

If the key does not exist false is returned.

set_selection()

wxWindow* wex::notebook::set_selection

(

const std::string &

key

)

Selects (and returns) the page specified by the given key.

If the key does not exist nullptr is returned.

split()

bool wex::notebook::split	(	const std::string &	key,
		int	direction
	)

Split performs a split operation programmatically.

If the key does not exist false is returned.

Parameters

key	The page that will be split off. This page will also become the active page after the split.
direction	Specify where the pane should go. It should be one of the following: wxTOP wxBOTTOM wxLEFT wxRIGHT