AxChoiceMenuItem Class Reference
[Basic AxTk UI classes]

This menu item shows a modal choice menu when activated. More...

#include <ax/ax_menu_choice.h>

Inheritance diagram for AxChoiceMenuItem:

List of all members.

Public Member Functions
	AxChoiceMenuItem (const AxChoiceMenuItem &item)
	AxChoiceMenuItem ()
	AxChoiceMenuItem (const wxString &label, const wxString &description, const wxString &id, const wxArrayString &labels, const wxArrayString &ids, const wxArrayString &descriptions, int selection=0)
bool	Create (const wxString &label, const wxString &description, const wxString &id, const wxArrayString &labels, const wxArrayString &ids, const wxArrayString &descriptions, int selection=0)
void	Init ()
	Member initialisation.
void	Copy (const AxChoiceMenuItem &item)
virtual AxMenuItem *	Clone () const
	Override this function for derived classes.
wxString	GetSelectionLabel () const
	Get current selected label.
wxString	GetSelectionId () const
	Get current selected id.
int	GetSelection () const
	Get current selected index.
virtual void	SetSelection (int i)
	Set current selection.
virtual void	SetSelectionByLabel (const wxString &label)
	Set current selection.
virtual void	SetSelectionById (const wxString &id)
	Set current selection.
virtual wxString	CreateString (const wxString &spec, bool isLabel)
	Create menu label or description.
void	SetLabels (const wxArrayString &labels)
const wxArrayString &	GetLabels () const
void	SetIds (const wxArrayString &ids)
const wxArrayString &	GetIds () const
void	SetDescriptions (const wxArrayString &descriptions)
const wxArrayString &	GetDescriptions () const
void	SetLabelSpec (const wxString &spec)
	Set menu item label spec, if any.
wxString	GetLabelSpec () const
	Get menu item label spec, if any.
void	SetDescriptionSpec (const wxString &spec)
	Set menu item description spec, if any.
wxString	GetDescriptionSpec () const
	Get menu item description spec, if any.
Protected Attributes
wxArrayString	m_labels
wxArrayString	m_ids
wxArrayString	m_descriptions
int	m_selection

---

Detailed Description

This menu item shows a modal choice menu when activated.

label and description can both contain the VALUE% keyword, which will be substituted with the current value.

When the value is changed, a wxEVT_COMMAND_CHOICE_SELECTED event is generated.

---

Constructor & Destructor Documentation

AxChoiceMenuItem::AxChoiceMenuItem

(

const AxChoiceMenuItem &

item

)

[inline]

AxChoiceMenuItem::AxChoiceMenuItem

(

)

[inline]

AxChoiceMenuItem::AxChoiceMenuItem	(	const wxString &	label,
		const wxString &	description,
		const wxString &	id,
		const wxArrayString &	labels,
		const wxArrayString &	ids,
		const wxArrayString &	descriptions,
		int	selection = 0
	)

---

Member Function Documentation

virtual AxMenuItem* AxChoiceMenuItem::Clone

(

)

const [inline, virtual]

Override this function for derived classes.

Reimplemented from AxMenuItem.

void AxChoiceMenuItem::Copy

(

const AxChoiceMenuItem &

item

)

bool AxChoiceMenuItem::Create	(	const wxString &	label,
		const wxString &	description,
		const wxString &	id,
		const wxArrayString &	labels,
		const wxArrayString &	ids,
		const wxArrayString &	descriptions,
		int	selection = 0
	)

virtual wxString AxChoiceMenuItem::CreateString	(	const wxString &	spec,
		bool	isLabel
	)			[virtual]

Create menu label or description.

const wxArrayString& AxChoiceMenuItem::GetDescriptions

(

)

const [inline]

wxString AxChoiceMenuItem::GetDescriptionSpec

(

)

const

Get menu item description spec, if any.

Reimplemented from AxMenuItem.

const wxArrayString& AxChoiceMenuItem::GetIds

(

)

const [inline]

const wxArrayString& AxChoiceMenuItem::GetLabels

(

)

const [inline]

wxString AxChoiceMenuItem::GetLabelSpec

(

)

const

Get menu item label spec, if any.

Reimplemented from AxMenuItem.

int AxChoiceMenuItem::GetSelection

(

)

const [inline]

Get current selected index.

wxString AxChoiceMenuItem::GetSelectionId

(

)

const

Get current selected id.

wxString AxChoiceMenuItem::GetSelectionLabel

(

)

const

Get current selected label.

void AxChoiceMenuItem::Init

(

)

Member initialisation.

Reimplemented from AxMenuItem.

void AxChoiceMenuItem::SetDescriptions

(

const wxArrayString &

descriptions

)

[inline]

void AxChoiceMenuItem::SetDescriptionSpec

(

const wxString &

spec

)

Set menu item description spec, if any.

Reimplemented from AxMenuItem.

void AxChoiceMenuItem::SetIds

(

const wxArrayString &

ids

)

[inline]

void AxChoiceMenuItem::SetLabels

(

const wxArrayString &

labels

)

[inline]

void AxChoiceMenuItem::SetLabelSpec

(

const wxString &

spec

)

Set menu item label spec, if any.

Reimplemented from AxMenuItem.

void AxChoiceMenuItem::SetSelection

(

int

i

)

[virtual]

Set current selection.

Reimplemented in AxColourMenuItem.

void AxChoiceMenuItem::SetSelectionById

(

const wxString &

id

)

[virtual]

Set current selection.

void AxChoiceMenuItem::SetSelectionByLabel

(

const wxString &

label

)

[virtual]

Set current selection.

---

Member Data Documentation

wxArrayString AxChoiceMenuItem::m_descriptions [protected]

wxArrayString AxChoiceMenuItem::m_ids [protected]

wxArrayString AxChoiceMenuItem::m_labels [protected]

int AxChoiceMenuItem::m_selection [protected]

---

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

• include/ax/ax_menu_choice.h
• src/ax/ax_menu_choice.cpp