AxPagerCtrl Class Reference
[Basic AxTk UI classes]

Switches between pages, without a visible controller object. More...

#include <ax/ax_pagerctrl.h>

List of all members.

Public Member Functions
	AxPagerCtrl ()
	AxPagerCtrl (wxWindow *parent, wxWindowID winid, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxEmptyString)
bool	Create (wxWindow *parent, wxWindowID winid, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxEmptyString)
virtual	~AxPagerCtrl ()
virtual size_t	GetPageCount () const
wxWindow *	GetPage (size_t n)
wxWindow *	GetPage (size_t n) const
wxWindow *	GetCurrentPage () const
virtual int	FindPage (wxWindow *window) const
virtual int	FindPage (const wxString &label) const
virtual wxWindow *	FindPageWindow (const wxString &label) const
virtual int	GetSelection () const
virtual bool	SetPageText (size_t n, const wxString &strText)
virtual wxString	GetPageText (size_t n)
virtual void	SetPageSize (const wxSize &size)
virtual wxSize	CalcSizeFromPage (const wxSize &sizePage) const
unsigned int	GetInternalBorder () const
void	SetInternalBorder (unsigned int border)
void	SetControlMargin (int margin)
int	GetControlMargin () const
bool	IsVertical () const
void	SetFitToCurrentPage (bool fit)
bool	GetFitToCurrentPage () const
wxSizer *	GetControlSizer () const
void	SetTopRuleSize (int border)
int	GetTopRuleSize () const
void	SetDrawTopRule (bool draw)
bool	GetDrawTopRule () const
virtual bool	DeletePage (size_t n)
virtual bool	RemovePage (size_t n)
virtual bool	DeleteAllPages ()
virtual bool	AddPage (wxWindow *page, const wxString &text, bool bSelect=false, int imageId=-1)
virtual bool	InsertPage (size_t n, wxWindow *page, const wxString &text, bool bSelect=false, int imageId=-1)
virtual int	SetSelection (size_t n)
virtual int	ChangeSelection (size_t n)
void	AdvanceSelection (bool forward=true)
virtual int	HitTest (const wxPoint &WXUNUSED(pt), long *WXUNUSED(flags)=NULL) const
virtual bool	HasMultiplePages () const
virtual int	DoSetSelection (size_t nPage, int flags=0)
virtual void	UpdateSelectedPage (size_t newsel)
virtual wxBookCtrlBaseEvent *	CreatePageChangingEvent () const
virtual void	MakeChangedEvent (wxBookCtrlBaseEvent &event)
virtual bool	AllowNullPage () const
virtual wxWindow *	DoRemovePage (size_t page)
virtual wxSize	DoGetBestSize () const
int	GetNextPage (bool forward) const
void	DoSize ()
void	DoInvalidateBestSize ()
Protected Types
enum	{ SetSelection_SendEvent = 1 }
Protected Member Functions
wxRect	GetPageRect () const
void	OnSize (wxSizeEvent &event)
void	OnPaint (wxPaintEvent &event)
void	OnEraseBackground (wxEraseEvent &event)
Protected Attributes
wxArrayPages	m_pages
wxImageList *	m_imageList
bool	m_ownsImageList
bool	m_fitToCurrentPage
wxSizer *	m_controlSizer
int	m_controlMargin
int	m_topRuleSize
bool	m_drawTopRule

---

Detailed Description

Switches between pages, without a visible controller object.

---

Member Enumeration Documentation

anonymous enum [protected]

Enumerator:

SetSelection_SendEvent

---

Constructor & Destructor Documentation

AxPagerCtrl::AxPagerCtrl

(

)

[inline]

AxPagerCtrl::AxPagerCtrl	(	wxWindow *	parent,
		wxWindowID	winid,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = 0,
		const wxString &	name = wxEmptyString
	)			[inline]

AxPagerCtrl::~AxPagerCtrl

(

)

[virtual]

---

Member Function Documentation

virtual bool AxPagerCtrl::AddPage	(	wxWindow *	page,
		const wxString &	text,
		bool	bSelect = false,
		int	imageId = -1
	)			[inline, virtual]

void AxPagerCtrl::AdvanceSelection

(

bool

forward = true

)

[inline]

virtual bool AxPagerCtrl::AllowNullPage

(

)

const [inline, virtual]

wxSize AxPagerCtrl::CalcSizeFromPage

(

const wxSize &

sizePage

)

const [virtual]

virtual int AxPagerCtrl::ChangeSelection

(

size_t

n

)

[inline, virtual]

bool AxPagerCtrl::Create	(	wxWindow *	parent,
		wxWindowID	winid,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = 0,
		const wxString &	name = wxEmptyString
	)

wxBookCtrlBaseEvent * AxPagerCtrl::CreatePageChangingEvent

(

)

const [virtual]

virtual bool AxPagerCtrl::DeleteAllPages

(

)

[inline, virtual]

bool AxPagerCtrl::DeletePage

(

size_t

n

)

[virtual]

wxSize AxPagerCtrl::DoGetBestSize

(

)

const [virtual]

void AxPagerCtrl::DoInvalidateBestSize

(

)

wxWindow * AxPagerCtrl::DoRemovePage

(

size_t

page

)

[virtual]

int AxPagerCtrl::DoSetSelection	(	size_t	nPage,
		int	flags = 0
	)			[virtual]

void AxPagerCtrl::DoSize

(

)

int AxPagerCtrl::FindPage

(

const wxString &

label

)

const [virtual]

int AxPagerCtrl::FindPage

(

wxWindow *

window

)

const [virtual]

wxWindow * AxPagerCtrl::FindPageWindow

(

const wxString &

label

)

const [virtual]

int AxPagerCtrl::GetControlMargin

(

)

const [inline]

wxSizer* AxPagerCtrl::GetControlSizer

(

)

const [inline]

wxWindow* AxPagerCtrl::GetCurrentPage

(

)

const [inline]

bool AxPagerCtrl::GetDrawTopRule

(

)

const [inline]

bool AxPagerCtrl::GetFitToCurrentPage

(

)

const [inline]

unsigned int AxPagerCtrl::GetInternalBorder

(

)

const [inline]

int AxPagerCtrl::GetNextPage

(

bool

forward

)

const

wxWindow* AxPagerCtrl::GetPage

(

size_t

n

)

const [inline]

wxWindow* AxPagerCtrl::GetPage

(

size_t

n

)

[inline]

virtual size_t AxPagerCtrl::GetPageCount

(

)

const [inline, virtual]

wxRect AxPagerCtrl::GetPageRect

(

)

const [protected]

wxString AxPagerCtrl::GetPageText

(

size_t

n

)

[virtual]

int AxPagerCtrl::GetSelection

(

)

const [virtual]

int AxPagerCtrl::GetTopRuleSize

(

)

const [inline]

virtual bool AxPagerCtrl::HasMultiplePages

(

)

const [inline, virtual]

virtual int AxPagerCtrl::HitTest	(	const wxPoint &	WXUNUSEDpt,
		long *	WXUNUSEDflags = NULL
	)			const [inline, virtual]

virtual bool AxPagerCtrl::InsertPage	(	size_t	n,
		wxWindow *	page,
		const wxString &	text,
		bool	bSelect = false,
		int	imageId = -1
	)			[virtual]

bool AxPagerCtrl::IsVertical

(

)

const [inline]

void AxPagerCtrl::MakeChangedEvent

(

wxBookCtrlBaseEvent &

event

)

[virtual]

void AxPagerCtrl::OnEraseBackground

(

wxEraseEvent &

event

)

[protected]

void AxPagerCtrl::OnPaint

(

wxPaintEvent &

event

)

[protected]

void AxPagerCtrl::OnSize

(

wxSizeEvent &

event

)

[protected]

virtual bool AxPagerCtrl::RemovePage

(

size_t

n

)

[inline, virtual]

void AxPagerCtrl::SetControlMargin

(

int

margin

)

[inline]

void AxPagerCtrl::SetDrawTopRule

(

bool

draw

)

[inline]

void AxPagerCtrl::SetFitToCurrentPage

(

bool

fit

)

[inline]

void AxPagerCtrl::SetInternalBorder

(

unsigned int

border

)

[inline]

void AxPagerCtrl::SetPageSize

(

const wxSize &

size

)

[virtual]

bool AxPagerCtrl::SetPageText	(	size_t	n,
		const wxString &	strText
	)			[virtual]

virtual int AxPagerCtrl::SetSelection

(

size_t

n

)

[inline, virtual]

void AxPagerCtrl::SetTopRuleSize

(

int

border

)

[inline]

void AxPagerCtrl::UpdateSelectedPage

(

size_t

newsel

)

[virtual]

---

Member Data Documentation

int AxPagerCtrl::m_controlMargin [protected]

wxSizer* AxPagerCtrl::m_controlSizer [protected]

bool AxPagerCtrl::m_drawTopRule [protected]

bool AxPagerCtrl::m_fitToCurrentPage [protected]

wxImageList* AxPagerCtrl::m_imageList [protected]

bool AxPagerCtrl::m_ownsImageList [protected]

wxArrayPages AxPagerCtrl::m_pages [protected]

int AxPagerCtrl::m_topRuleSize [protected]

---

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

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