MGUI::LAYOUT_PAGE Class Reference

Layout pane for use as tab page. More...

#include <mgui/layout.h>

Inheritance diagram for MGUI::LAYOUT_PAGE:

[legend]

List of all members.

Public Types
typedef fastdelegate::FastDelegate < void(LAYOUT_PAGE &)>	DELEGATE
Public Member Functions
	LAYOUT_PAGE ()
virtual	~LAYOUT_PAGE ()
int	Create (MGUI::LAYOUT_BOOK &book, const MISTRING &label, DELEGATE DelegateOnInitPage, MGUI::LAYOUT_ORIENTATION orientation=MGUI::LAYOUT_ORIENTATION_Vertical, bool IgnoreNonVisible=false, bool AddSpaceAtEnd=true)
int	Create (MGUI::LAYOUT_BOOK &book, const MISTRING &label, MGUI::LAYOUT_ORIENTATION orientation=MGUI::LAYOUT_ORIENTATION_Vertical)
bool	IsActive () const
void	SetDelegateOnInitPage (DELEGATE delegate)
void	SetDelegateOnSetActive (DELEGATE delegate)
void	SetDelegateOnSetInactive (DELEGATE delegate)
void	SetEnabled (bool enabled=true)
void	SetIgnoreNonVisible (bool IgnoreNonVisible=true)
void	SetNoSpaceExpanding (bool NoSpaceExpanding=true)
Private Member Functions
virtual void	OnInitPage ()
virtual void	v_OnSetActive ()
virtual void	v_OnSetInactive ()

---

Detailed Description

Layout pane for use as tab page.

---

Member Typedef Documentation

typedef fastdelegate::FastDelegate<void(LAYOUT_PAGE&)> MGUI::LAYOUT_PAGE::DELEGATE

---

Constructor & Destructor Documentation

MGUI::LAYOUT_PAGE::LAYOUT_PAGE

(

)

Constructor.

virtual MGUI::LAYOUT_PAGE::~LAYOUT_PAGE

(

)

[virtual]

Destructor.

---

Member Function Documentation

int MGUI::LAYOUT_PAGE::Create	(	MGUI::LAYOUT_BOOK &	book,
		const MISTRING &	label,
		DELEGATE	DelegateOnInitPage,
		MGUI::LAYOUT_ORIENTATION	orientation = MGUI::LAYOUT_ORIENTATION_Vertical,
		bool	IgnoreNonVisible = false,
		bool	AddSpaceAtEnd = true
	)

Create page using delegate.

Returns:

Page index. Should not be used if OnInitPage is overridden, as delegate will be ignored.

Parameters:

	book	Book to add page to
	label	Label string
	DelegateOnInitPage	Delegate to call to initialize page
	IgnoreNonVisible	Ignore non-visible items when doing layout
	AddSpaceAtEnd	Add "expanding" space at end (usually bottom) of page

int MGUI::LAYOUT_PAGE::Create	(	MGUI::LAYOUT_BOOK &	book,
		const MISTRING &	label,
		MGUI::LAYOUT_ORIENTATION	orientation = MGUI::LAYOUT_ORIENTATION_Vertical
	)

Create page with tab label from MISTRING.

Returns:

Page index.

Parameters:

	book	Book to add page to
	label	Label string

bool MGUI::LAYOUT_PAGE::IsActive

(

)

const

Determine if this is the 'active' page.

virtual void MGUI::LAYOUT_PAGE::OnInitPage

(

)

[private, virtual]

Create page contents.

Default implementation calls delegate. If not overridden then delegate must be specified.

void MGUI::LAYOUT_PAGE::SetDelegateOnInitPage

(

DELEGATE

delegate

)

[inline]

Set delegate to call for page initialization.

If used, must be called before Create

void MGUI::LAYOUT_PAGE::SetDelegateOnSetActive

(

DELEGATE

delegate

)

[inline]

Set delegate to call when page made active.

void MGUI::LAYOUT_PAGE::SetDelegateOnSetInactive

(

DELEGATE

delegate

)

[inline]

Set delegate to call when page made inactive.

void MGUI::LAYOUT_PAGE::SetEnabled

(

bool

enabled = true

)

Set whether page is 'enabled' or not.

Reimplemented from MGUI::LAYOUT_PANE_BASE.

void MGUI::LAYOUT_PAGE::SetIgnoreNonVisible

(

bool

IgnoreNonVisible = true

)

[inline]

Set to ignore nonvisible items when doing layout.

This must be called before Create() and is usually done in the subclass constructor.

void MGUI::LAYOUT_PAGE::SetNoSpaceExpanding

(

bool

NoSpaceExpanding = true

)

[inline]

Set whether to not automatically add "expanding space" at end (bottom usually) of page.

This must be called before Create() and is usually done in the subclass constructor. Default behavior is to add expanding space.

virtual void MGUI::LAYOUT_PAGE::v_OnSetActive

(

)

[private, virtual]

Called when page is made active.

virtual void MGUI::LAYOUT_PAGE::v_OnSetInactive

(

)

[private, virtual]

Called when page is made inactive.

---

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

• mgui/layout.h