MGUI::LAYOUT_WIZARD_PAGE Class Reference

#include <mgui/dlgwizard.h>

Inheritance diagram for MGUI::LAYOUT_WIZARD_PAGE:

[legend]

List of all members.

Public Types
enum	PAGE { PAGE_Same = -2, PAGE_Next = -1, PAGE_Back = PAGE_Next }
Public Member Functions
	LAYOUT_WIZARD_PAGE ()
virtual	~LAYOUT_WIZARD_PAGE ()
int	Create (MGUI::DLGWIZARD &wizard, MGUI::LAYOUT_ORIENTATION orientation=MGUI::LAYOUT_ORIENTATION_Vertical)
int	GetPageIndex () const
bool	IsActive () const
void	SetEnabled (bool enabled=true)
void	SetNextEnabled (bool enabled, bool ForceToFinish=false)
Protected Member Functions
void	SetIgnoreNonVisible (bool IgnoreNonVisible=true)
void	SetNoSpaceExpanding (bool NoSpaceExpanding=true)
virtual void	v_OnWizardFinish ()
Private Member Functions
virtual void	v_OnInitPage ()=0
virtual void	v_OnSetActive ()
virtual void	v_OnSetInactive ()
virtual int	v_OnWizardBack ()
virtual int	v_OnWizardNext ()

---

Member Enumeration Documentation

enum MGUI::LAYOUT_WIZARD_PAGE::PAGE

Enumerator:

PAGE_Same
PAGE_Next
PAGE_Back

---

Constructor & Destructor Documentation

MGUI::LAYOUT_WIZARD_PAGE::LAYOUT_WIZARD_PAGE

(

)

Constructor.

virtual MGUI::LAYOUT_WIZARD_PAGE::~LAYOUT_WIZARD_PAGE

(

)

[virtual]

Destructor.

---

Member Function Documentation

int MGUI::LAYOUT_WIZARD_PAGE::Create	(	MGUI::DLGWIZARD &	wizard,
		MGUI::LAYOUT_ORIENTATION	orientation = MGUI::LAYOUT_ORIENTATION_Vertical
	)

Create page with tab label from MISTRING.

Returns:

Page index.

Parameters:

wizard

Wizard to add page to

int MGUI::LAYOUT_WIZARD_PAGE::GetPageIndex

(

)

const [inline]

Get the index of 'this' page.

Returns:

'this' wizard page index

bool MGUI::LAYOUT_WIZARD_PAGE::IsActive

(

)

const

Determine if this is the 'active' page.

void MGUI::LAYOUT_WIZARD_PAGE::SetEnabled

(

bool

enabled = true

)

Set whether page is 'enabled' or not.

Reimplemented from MGUI::LAYOUT_PANE_BASE.

void MGUI::LAYOUT_WIZARD_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.

void MGUI::LAYOUT_WIZARD_PAGE::SetNextEnabled	(	bool	enabled,
		bool	ForceToFinish = false
	)

Set next / finish button status.

Parameters:

	enabled	Whether button is enabled or not
	ForceToFinish	Force to display "Finish" instead of "Next" even if not last page

void MGUI::LAYOUT_WIZARD_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.

virtual void MGUI::LAYOUT_WIZARD_PAGE::v_OnInitPage

(

)

[private, pure virtual]

Create page contents.

Derived class MUST implement this.

virtual void MGUI::LAYOUT_WIZARD_PAGE::v_OnSetActive

(

)

[private, virtual]

Called when page is made active.

virtual void MGUI::LAYOUT_WIZARD_PAGE::v_OnSetInactive

(

)

[private, virtual]

Called when page is made inactive.

virtual int MGUI::LAYOUT_WIZARD_PAGE::v_OnWizardBack

(

)

[private, virtual]

Called when the 'Back' button is pressed.

Returns:

PAGE_Back to automatically advance to the previous page; PAGE_Same to prevent the page from changing. To jump to a page other than the previous one, return the index of the dialog to be displayed. Default implementation returns PAGE_Back.

virtual void MGUI::LAYOUT_WIZARD_PAGE::v_OnWizardFinish

(

)

[protected, virtual]

Called when 'Finish' button is pressed.

Derived class must call base class v_OnWizardFinish() method AFTER performing its own processing to actually close the dialog. If the dialog settings do not pass their associated validation test then an appropriate message should be displayed for the user and the base class v_OnFinish() method should not be called. This will cause the dialog to remain open and allow the user to correct the settings. Derived classes should typically declare this method as private.

virtual int MGUI::LAYOUT_WIZARD_PAGE::v_OnWizardNext

(

)

[private, virtual]

Called when the 'Next' button is pressed.

Returns:

PAGE_Next to automatically advance to the next page; PAGE_Same to prevent the page from changing. To jump to a page other than the next one, return the index of the page to be displayed. Default implementation returns PAGE_Next.

---

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

• mgui/dlgwizard.h