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 Member Functions
int	Create (MGUI::LAYOUT_BOOK &book, const MISTRING &label, MGUI::LAYOUT_ORIENTATION orientation=MGUI::LAYOUT_ORIENTATION_Vertical)
int	Create (MGUI::LAYOUT_BOOK &book, const char *label, MGUI::LAYOUT_ORIENTATION orientation=MGUI::LAYOUT_ORIENTATION_Vertical)
bool	IsActive () const
	LAYOUT_PAGE ()
void	SetEnabled (bool enabled=true)
virtual	~LAYOUT_PAGE ()
Protected Member Functions
virtual void	OnInitPage ()=0
virtual void	OnSetActive ()
void	SetIgnoreNonVisible (bool IgnoreNonVisible=true)
void	SetNoSpaceExpanding (bool NoSpaceExpanding=true)

---

Detailed Description

Layout pane for use as tab page.

Definition at line 1537 of file layout.h.

---

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, 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

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

Create page with tab label from resource lookup. Returns: Page index. Parameters: book  Book to add page to label  Label string for resource lookup

bool MGUI::LAYOUT_PAGE::IsActive (   )  const

Determine if this is the 'active' page.

virtual void MGUI::LAYOUT_PAGE::OnInitPage (   )  [protected, pure virtual]

Create page contents. Derived class MUST implement this. This will be called by the page creation code and thus should not be called directly. Implemented in MGUI::FRAMESTYLEDLG::PAGE_FRAME, MGUI::FRAMESTYLEDLG::PAGE_LEADER, and MGUI::FRAMESTYLEDLG::PAGE_SAMPLE.

virtual void MGUI::LAYOUT_PAGE::OnSetActive (   )  [protected, virtual]

Called when page is made active. Derived class must call base class BEFORE performing own processing. Reimplemented in MGUI::FRAMESTYLEDLG::PAGE_FRAME, MGUI::FRAMESTYLEDLG::PAGE_LEADER, and MGUI::FRAMESTYLEDLG::PAGE_SAMPLE.

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, protected]

Set to ignore nonvisible items when doing layout. This must be called before Create() and is usually done in the subclass constructor. Definition at line 1589 of file layout.h.

void MGUI::LAYOUT_PAGE::SetNoSpaceExpanding (  bool  NoSpaceExpanding = true  )  [inline, protected]

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. Definition at line 1596 of file layout.h.

---

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

• mgui/layout.h

---