AxContainerCtrl Class Reference
[Basic AxTk UI classes]

This class offers a predefined user interface for AxTk applications. More...

#include <ax/ax_containerctrl.h>

List of all members.

Public Types
enum	{ ID_AXCONTAINERCTRL = 10000, ID_UP = 10004, ID_HOME = 10005 }
	Control identifiers. More...
Public Member Functions
	AxContainerCtrl ()
	Constructors.
	AxContainerCtrl (wxWindow *parent, wxWindowID id=SYMBOL_AXCONTAINERCTRL_IDNAME, const wxPoint &pos=SYMBOL_AXCONTAINERCTRL_POSITION, const wxSize &size=SYMBOL_AXCONTAINERCTRL_SIZE, long style=SYMBOL_AXCONTAINERCTRL_STYLE)
bool	Create (wxWindow *parent, wxWindowID id=SYMBOL_AXCONTAINERCTRL_IDNAME, const wxPoint &pos=SYMBOL_AXCONTAINERCTRL_POSITION, const wxSize &size=SYMBOL_AXCONTAINERCTRL_SIZE, long style=SYMBOL_AXCONTAINERCTRL_STYLE)
	Creation.
	~AxContainerCtrl ()
	Destructor.
void	Init ()
	Initialises member variables.
void	CreateControls ()
	Creates the controls and sizers.
AxMenuListCtrl *	GetMenuCtrl () const
wxTextCtrl *	GetTitleCtrl () const
wxTextCtrl *	GetDescriptionCtrl () const
AxPagerCtrl *	GetPagerCtrl () const
AxMenuController *	GetController () const
void	SetController (AxMenuController *controller)
void	OnSysColourChanged (wxSysColourChangedEvent &event)
void	OnIdle (wxIdleEvent &event)
	wxEVT_IDLE event handler for ID_AXCONTAINERCTRL
void	OnAnyKeyDown (wxListEvent &event)
	wxEVT_COMMAND_LIST_KEY_DOWN event handler for wxID_ANY
void	OnUpClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_UP
void	OnUpUpdate (wxUpdateUIEvent &event)
	wxEVT_UPDATE_UI event handler for ID_UP
void	OnHomeClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_HOME
void	OnHomeUpdate (wxUpdateUIEvent &event)
	wxEVT_UPDATE_UI event handler for ID_HOME
wxBitmap	GetBitmapResource (const wxString &name)
	Retrieves bitmap resources.
wxIcon	GetIconResource (const wxString &name)
	Retrieves icon resources.
Static Public Member Functions
static bool	ShowToolTips ()
	Should we show tooltips?
Public Attributes
wxTextCtrl *	m_titleCtrl
AxMenuListCtrl *	m_menuCtrl
AxPagerCtrl *	m_pagerCtrl
wxTextCtrl *	m_descriptionCtrl
AxMenuController *	m_controller
AxContainerCtrlWakeUpIdleTimer	m_wakeUpIdleTimer

---

Detailed Description

This class offers a predefined user interface for AxTk applications.

Use with AxStandardMenuController, and add the control to a main frame or dialog.

---

Member Enumeration Documentation

anonymous enum

Control identifiers.

Enumerator:

ID_AXCONTAINERCTRL
ID_UP
ID_HOME

---

Constructor & Destructor Documentation

AxContainerCtrl::AxContainerCtrl

(

)

Constructors.

AxContainerCtrl::AxContainerCtrl	(	wxWindow *	parent,
		wxWindowID	id = SYMBOL_AXCONTAINERCTRL_IDNAME,
		const wxPoint &	pos = SYMBOL_AXCONTAINERCTRL_POSITION,
		const wxSize &	size = SYMBOL_AXCONTAINERCTRL_SIZE,
		long	style = SYMBOL_AXCONTAINERCTRL_STYLE
	)

AxContainerCtrl::~AxContainerCtrl

(

)

Destructor.

---

Member Function Documentation

bool AxContainerCtrl::Create	(	wxWindow *	parent,
		wxWindowID	id = SYMBOL_AXCONTAINERCTRL_IDNAME,
		const wxPoint &	pos = SYMBOL_AXCONTAINERCTRL_POSITION,
		const wxSize &	size = SYMBOL_AXCONTAINERCTRL_SIZE,
		long	style = SYMBOL_AXCONTAINERCTRL_STYLE
	)

Creation.

void AxContainerCtrl::CreateControls

(

)

Creates the controls and sizers.

wxBitmap AxContainerCtrl::GetBitmapResource

(

const wxString &

name

)

Retrieves bitmap resources.

AxMenuController* AxContainerCtrl::GetController

(

)

const [inline]

wxTextCtrl* AxContainerCtrl::GetDescriptionCtrl

(

)

const [inline]

wxIcon AxContainerCtrl::GetIconResource

(

const wxString &

name

)

Retrieves icon resources.

AxMenuListCtrl* AxContainerCtrl::GetMenuCtrl

(

)

const [inline]

AxPagerCtrl* AxContainerCtrl::GetPagerCtrl

(

)

const [inline]

wxTextCtrl* AxContainerCtrl::GetTitleCtrl

(

)

const [inline]

void AxContainerCtrl::Init

(

)

Initialises member variables.

void AxContainerCtrl::OnAnyKeyDown

(

wxListEvent &

event

)

wxEVT_COMMAND_LIST_KEY_DOWN event handler for wxID_ANY

void AxContainerCtrl::OnHomeClick

(

wxCommandEvent &

event

)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_HOME

void AxContainerCtrl::OnHomeUpdate

(

wxUpdateUIEvent &

event

)

wxEVT_UPDATE_UI event handler for ID_HOME

void AxContainerCtrl::OnIdle

(

wxIdleEvent &

event

)

wxEVT_IDLE event handler for ID_AXCONTAINERCTRL

void AxContainerCtrl::OnSysColourChanged

(

wxSysColourChangedEvent &

event

)

void AxContainerCtrl::OnUpClick

(

wxCommandEvent &

event

)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_UP

void AxContainerCtrl::OnUpUpdate

(

wxUpdateUIEvent &

event

)

wxEVT_UPDATE_UI event handler for ID_UP

void AxContainerCtrl::SetController

(

AxMenuController *

controller

)

[inline]

bool AxContainerCtrl::ShowToolTips

(

)

[static]

Should we show tooltips?

---

Member Data Documentation

AxMenuController* AxContainerCtrl::m_controller

wxTextCtrl* AxContainerCtrl::m_descriptionCtrl

AxMenuListCtrl* AxContainerCtrl::m_menuCtrl

AxPagerCtrl* AxContainerCtrl::m_pagerCtrl

wxTextCtrl* AxContainerCtrl::m_titleCtrl

AxContainerCtrlWakeUpIdleTimer AxContainerCtrl::m_wakeUpIdleTimer

---

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

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