MGUI::DLGWIZARD Class Reference

Base class for wizard dialog support for modal behavior. More...

#include <mgui/dlgwizard.h>

Inheritance diagram for MGUI::DLGWIZARD:

[legend]

List of all members.

Public Types
enum	BTNFLAGS {   BTNFLAG_None = 0x00, BTNFLAG_Next = 0x01, BTNFLAG_Back = 0x02, BTNFLAG_Finish = 0x04,   BTNFLAG_DisabledFinish = 0x08 }
enum	DLGSTYLE { DLGSTYLE_Default = 0x0000, DLGSTYLE_Resizable = 0x0001 }
Public Member Functions
virtual	~DLGWIZARD ()=0
ERRVALUE	DoModal (MDLGPARENT dlgparent)
int	GetActiveIndex () const
int	GetNumPages () const
void	SetActiveIndex (int index)
void	SetWizardButtons (BTNFLAGS flags)
Protected Member Functions
	DLGWIZARD (const MISTRING &title, HELPID HelpID, DLGSTYLE style=DLGSTYLE_Default)
void	NotifyCancel ()
void	SetReturnValue (int RetValue)
void	SetRootMargin (int RootMargin)
void	SetRootSpacing (int RootSpacing)
void	SetStyle (DLGSTYLE style)
virtual void	v_OnCancel ()
Private Member Functions
virtual void	v_OnClose ()
virtual void	v_OnDestroy ()
virtual void	v_OnOpen ()

---

Detailed Description

Base class for wizard dialog support for modal behavior.

Most derived classes will also override v_OnFinish to perform the desired update of the external data when the user presses 'Finish' When overriding the protected v_On...() virtual methods pay close attention to when the corresponding base method is to be called to ensure correct behavior.

---

Member Enumeration Documentation

enum MGUI::DLGWIZARD::BTNFLAGS

Enumerator:

BTNFLAG_None
BTNFLAG_Next
BTNFLAG_Back
BTNFLAG_Finish
BTNFLAG_DisabledFinish

enum MGUI::DLGWIZARD::DLGSTYLE

Dialog style settings, may be combined.

Enumerator:

DLGSTYLE_Default	Default style.
DLGSTYLE_Resizable	Dialog is resizable.

---

Constructor & Destructor Documentation

virtual MGUI::DLGWIZARD::~DLGWIZARD

(

)

[pure virtual]

Destructor.

MGUI::DLGWIZARD::DLGWIZARD	(	const MISTRING &	title,
		HELPID	HelpID,
		DLGSTYLE	style = DLGSTYLE_Default
	)			[protected]

Constructor, initializes only.

Parameters:

	title	Title string, can use TEXTID also
	HelpID	Help ID, use HELPID__None if no 'help' available
	style	Dialog style settings

---

Member Function Documentation

ERRVALUE MGUI::DLGWIZARD::DoModal

(

MDLGPARENT

dlgparent

)

Open dialog in modal state and wait for user to dismiss via OK/Cancel.

Returns:

0 if OK, EUserCancel if Cancel, < 0 if error

Parameters:

dlgparent

Parent for modal dialog

int MGUI::DLGWIZARD::GetActiveIndex

(

)

const

Get index to 'active' page.

Returns:

Zero-based index to active page, -1 if none created.

int MGUI::DLGWIZARD::GetNumPages

(

)

const

Get number of pages currently in the wizard.

Returns:

Number of pages

void MGUI::DLGWIZARD::NotifyCancel

(

)

[inline, protected]

Send 'Cancel' notification to dialog.

void MGUI::DLGWIZARD::SetActiveIndex

(

int

index

)

Set active page by index.

Parameters:

index

Zero-based page index

void MGUI::DLGWIZARD::SetReturnValue

(

int

RetValue

)

[inline, protected]

Set value to return from dialog.

void MGUI::DLGWIZARD::SetRootMargin

(

int

RootMargin

)

[inline, protected]

Set margin for root pane.

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

void MGUI::DLGWIZARD::SetRootSpacing

(

int

RootSpacing

)

[inline, protected]

Set spacing for root pane.

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

void MGUI::DLGWIZARD::SetStyle

(

DLGSTYLE

style

)

[inline, protected]

Set dialog style.

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

void MGUI::DLGWIZARD::SetWizardButtons

(

BTNFLAGS

flags

)

Set back / next / finish button status Specifying the flag enables.

Leaving out the flag disables

virtual void MGUI::DLGWIZARD::v_OnCancel

(

)

[protected, virtual]

Called when 'Cancel' button is pressed.

Derived class must call base class v_OnCancel() method AFTER performing its own processing to actually close the dialog. In some cases the user may be given an opportunity to verify that they intended to press the Cancel button. If they elect not to cancel then the base class v_OnCancel() method should not be called. This will cause the dialog to remain open and allow the user to retain the settings. Derived classes should generally declare this method as private.

virtual void MGUI::DLGWIZARD::v_OnClose

(

)

[private, virtual]

Called when dialog gets closed.

virtual void MGUI::DLGWIZARD::v_OnDestroy

(

)

[private, virtual]

Called when dialog is destroyed.

virtual void MGUI::DLGWIZARD::v_OnOpen

(

)

[private, virtual]

Called after dialog is actually opened.

---

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

• mgui/dlgwizard.h