wxToolBarCustomisationInfo Class Reference

#include <toolbarcust/toolbarcust.h>

List of all members.

Public Member Functions
	wxToolBarCustomisationInfo (const wxString &toolbarName=wxEmptyString)
	wxToolBarCustomisationInfo (const wxToolBarCustomisationInfo &info)
	~wxToolBarCustomisationInfo ()
void	Init ()
	Initialises the class.
void	Clear ()
	Clears the items.
void	Copy (const wxToolBarCustomisationInfo &info)
	Copies the object.
wxToolBarCustomisationInfoItem &	AddTool (int toolid, const wxString &name, const wxString &label, const wxBitmap &bitmap, const wxBitmap &bmpDisabled, wxItemKind kind=wxITEM_NORMAL, const wxString &shortHelp=wxEmptyString, const wxString &longHelp=wxEmptyString, int style=wxTOOL_STYLE_BUTTON)
	Adds a tool.
wxToolBarCustomisationInfoItem &	AddButton (int toolid, const wxString &name, const wxString &label, const wxBitmap &bitmap, const wxString &shortHelp=wxEmptyString, const wxString &longHelp=wxEmptyString)
	Adds a normal button tool.
wxToolBarCustomisationInfoItem &	AddCheckButton (int toolid, const wxString &name, const wxString &label, const wxBitmap &bitmap, const wxString &shortHelp=wxEmptyString, const wxString &longHelp=wxEmptyString)
	Adds a check button tool.
wxToolBarCustomisationInfoItem &	AddRadioButton (int toolid, const wxString &name, const wxString &label, const wxBitmap &bitmap, const wxString &shortHelp=wxEmptyString, const wxString &longHelp=wxEmptyString)
	Adds a radio button tool.
wxToolBarCustomisationInfoItem &	AddControl (int toolid, const wxString &name, const wxString &shortHelp=wxEmptyString, const wxString &longHelp=wxEmptyString)
	Adds a control.
wxToolBarCustomisationInfoItem &	AddSeparator ()
	Adds a separator.
bool	Save (const wxString &path, wxConfigBase &config)
	Saves enabled status to config.
bool	Load (const wxString &path, wxConfigBase &config)
	Load enabled status from config.
bool	Reset (wxToolBarBase *toolBar)
	To be used when iterating through items. Only iterates through enabled items.
bool	GetNextItem ()
	Call at the beginning of the loop.
bool	CreateTool ()
	Creates a tool using the current info.
bool	CreateTool (wxControl *control)
	Creates a tool using the current info.
const wxToolBarCustomisationInfoItem &	GetCurrentItem () const
	Gets the current item.
wxToolBarCustomisationInfoItem &	GetCurrentItem ()
bool	IsControl () const
	True if the current tool is a control.
bool	IsSeparator () const
	True if the current tool is a separator.
bool	IsButton () const
	True if the current tool is a button.
bool	IsEnabled () const
	True if the current tool is enabled.
bool	IsToolBarEnabled () const
	Get/set toolbar enabled flag.
void	SetToolBarEnabled (bool enabled)
bool	GetCanHaveLabels () const
	Get/set can have labels.
void	SetCanHaveLabels (bool labels)
bool	GetUseLabels () const
	Get/set labels.
void	SetUseLabels (bool useLabels)
int	GetTotalItemCount () const
	Get total number of items.
int	GetEnabledItemCount () const
	Get number of enabled items.
const wxToolBarCustomisationInfoItem &	GetItem (int n) const
	Gets the nth item.
wxToolBarCustomisationInfoItem &	GetItem (int n)
wxToolBarCustomisationInfoItem *	Find (const wxString &name) const
	Finds a tool by name.
wxToolBarCustomisationInfoItem *	Find (int id) const
	Finds a tool by id.
void	SetName (const wxString &name)
	Set/get name.
const wxString &	GetName () const
wxString	GetKey (const wxString &prefix, const wxString &key) const
	Implementation.
Protected Attributes
wxString	m_name
wxList	m_toolbarItems
int	m_currentTool
bool	m_needsSeparator
int	m_createdCount
bool	m_toolbarEnabled
bool	m_canHaveLabels
bool	m_useLabels
wxToolBarBase *	m_currentToolBar

---

Detailed Description

wxToolBarCustomisationInfo stores customisation information about a single toolbar.

---

Constructor & Destructor Documentation

wxToolBarCustomisationInfo::wxToolBarCustomisationInfo

(

const wxString &

toolbarName = wxEmptyString

)

wxToolBarCustomisationInfo stores customisation information about a single toolbar.

wxToolBarCustomisationInfo::wxToolBarCustomisationInfo

(

const wxToolBarCustomisationInfo &

info

)

wxToolBarCustomisationInfo::~wxToolBarCustomisationInfo

(

)

---

Member Function Documentation

wxToolBarCustomisationInfoItem & wxToolBarCustomisationInfo::AddButton	(	int	toolid,
		const wxString &	name,
		const wxString &	label,
		const wxBitmap &	bitmap,
		const wxString &	shortHelp = wxEmptyString,
		const wxString &	longHelp = wxEmptyString
	)

Adds a normal button tool.

wxToolBarCustomisationInfoItem & wxToolBarCustomisationInfo::AddCheckButton	(	int	toolid,
		const wxString &	name,
		const wxString &	label,
		const wxBitmap &	bitmap,
		const wxString &	shortHelp = wxEmptyString,
		const wxString &	longHelp = wxEmptyString
	)

Adds a check button tool.

wxToolBarCustomisationInfoItem & wxToolBarCustomisationInfo::AddControl	(	int	toolid,
		const wxString &	name,
		const wxString &	shortHelp = wxEmptyString,
		const wxString &	longHelp = wxEmptyString
	)

Adds a control.

wxToolBarCustomisationInfoItem & wxToolBarCustomisationInfo::AddRadioButton	(	int	toolid,
		const wxString &	name,
		const wxString &	label,
		const wxBitmap &	bitmap,
		const wxString &	shortHelp = wxEmptyString,
		const wxString &	longHelp = wxEmptyString
	)

Adds a radio button tool.

wxToolBarCustomisationInfoItem & wxToolBarCustomisationInfo::AddSeparator

(

)

Adds a separator.

wxToolBarCustomisationInfoItem & wxToolBarCustomisationInfo::AddTool	(	int	toolid,
		const wxString &	name,
		const wxString &	label,
		const wxBitmap &	bitmap,
		const wxBitmap &	bmpDisabled,
		wxItemKind	kind = wxITEM_NORMAL,
		const wxString &	shortHelp = wxEmptyString,
		const wxString &	longHelp = wxEmptyString,
		int	style = wxTOOL_STYLE_BUTTON
	)

Adds a tool.

void wxToolBarCustomisationInfo::Clear

(

)

Clears the items.

void wxToolBarCustomisationInfo::Copy

(

const wxToolBarCustomisationInfo &

info

)

Copies the object.

bool wxToolBarCustomisationInfo::CreateTool

(

wxControl *

control

)

Creates a tool using the current info.

Also implicitly creates a separator if appropriate.

Also implicitly creates a separator if appropriate.

bool wxToolBarCustomisationInfo::CreateTool

(

)

Creates a tool using the current info.

Also implicitly creates a separator if appropriate.

Also implicitly creates a separator if appropriate.

wxToolBarCustomisationInfoItem * wxToolBarCustomisationInfo::Find

(

int

id

)

const

Finds a tool by id.

wxToolBarCustomisationInfoItem * wxToolBarCustomisationInfo::Find

(

const wxString &

name

)

const

Finds a tool by name.

bool wxToolBarCustomisationInfo::GetCanHaveLabels

(

)

const [inline]

Get/set can have labels.

wxToolBarCustomisationInfoItem & wxToolBarCustomisationInfo::GetCurrentItem

(

)

const wxToolBarCustomisationInfoItem & wxToolBarCustomisationInfo::GetCurrentItem

(

)

const

Gets the current item.

int wxToolBarCustomisationInfo::GetEnabledItemCount

(

)

const

Get number of enabled items.

wxToolBarCustomisationInfoItem & wxToolBarCustomisationInfo::GetItem

(

int

n

)

const wxToolBarCustomisationInfoItem & wxToolBarCustomisationInfo::GetItem

(

int

n

)

const

Gets the nth item.

wxString wxToolBarCustomisationInfo::GetKey	(	const wxString &	prefix,
		const wxString &	key
	)			const

Implementation.

Returns the key with "prefix/" prepended if non-empty.

Returns the key with "prefix/" prepended if non-empty

const wxString& wxToolBarCustomisationInfo::GetName

(

)

const [inline]

bool wxToolBarCustomisationInfo::GetNextItem

(

)

Call at the beginning of the loop.

int wxToolBarCustomisationInfo::GetTotalItemCount

(

)

const

Get total number of items.

bool wxToolBarCustomisationInfo::GetUseLabels

(

)

const [inline]

Get/set labels.

void wxToolBarCustomisationInfo::Init

(

)

Initialises the class.

bool wxToolBarCustomisationInfo::IsButton

(

)

const

True if the current tool is a button.

bool wxToolBarCustomisationInfo::IsControl

(

)

const

True if the current tool is a control.

bool wxToolBarCustomisationInfo::IsEnabled

(

)

const

True if the current tool is enabled.

bool wxToolBarCustomisationInfo::IsSeparator

(

)

const

True if the current tool is a separator.

bool wxToolBarCustomisationInfo::IsToolBarEnabled

(

)

const [inline]

Get/set toolbar enabled flag.

bool wxToolBarCustomisationInfo::Load	(	const wxString &	path,
		wxConfigBase &	config
	)

Load enabled status from config.

bool wxToolBarCustomisationInfo::Reset

(

wxToolBarBase *

toolBar

)

To be used when iterating through items. Only iterates through enabled items.

Reset to beginning of info, to be called before iterating.

Reset to beginning of info, to be called before iterating

bool wxToolBarCustomisationInfo::Save	(	const wxString &	path,
		wxConfigBase &	config
	)

Saves enabled status to config.

void wxToolBarCustomisationInfo::SetCanHaveLabels

(

bool

labels

)

[inline]

void wxToolBarCustomisationInfo::SetName

(

const wxString &

name

)

[inline]

Set/get name.

void wxToolBarCustomisationInfo::SetToolBarEnabled

(

bool

enabled

)

[inline]

void wxToolBarCustomisationInfo::SetUseLabels

(

bool

useLabels

)

[inline]

---

Member Data Documentation

bool wxToolBarCustomisationInfo::m_canHaveLabels [protected]

int wxToolBarCustomisationInfo::m_createdCount [protected]

int wxToolBarCustomisationInfo::m_currentTool [protected]

wxToolBarBase* wxToolBarCustomisationInfo::m_currentToolBar [protected]

wxString wxToolBarCustomisationInfo::m_name [protected]

bool wxToolBarCustomisationInfo::m_needsSeparator [protected]

bool wxToolBarCustomisationInfo::m_toolbarEnabled [protected]

wxList wxToolBarCustomisationInfo::m_toolbarItems [protected]

bool wxToolBarCustomisationInfo::m_useLabels [protected]

---

The documentation for this class was generated from the following files:

• include/toolbarcust/toolbarcust.h
• src/toolbarcust/toolbarcust.cpp