STATUSDIALOG Class Reference

Status dialog (DEPRECATED). More...

#include <mi32/mstatus.h>

List of all members.

Public Types
enum	FLAGS { FLAG_NoCancel = MGUI::DLG_STATUS::DLGSTYLE_DisableCancel, FLAG_DelayPopup = MGUI::DLG_STATUS::DLGSTYLE_DelayPopup, FLAG_None = MGUI::DLG_STATUS::DLGSTYLE_Default }
Public Member Functions
	STATUSDIALOG ()
	~STATUSDIALOG ()
ERRVALUE	CheckCancel () const
ERRVALUE	Create (MDLGPARENT dlgparent, FLAGS flags=FLAG_None)
void	Destroy ()
void	DisableCancel () const
void	EnableCancel () const
MISTATUSMANAGER *	GetHandle () const
MTIMER *	GetTimer ()
void	ReportDone (TEXTID textid=TEXTID__None) const
void	ResetCancel () const
MISTATUSMANAGER *	SetSelfAsDefault ()
void	WaitForOK () const

---

Detailed Description

Status dialog (DEPRECATED).

Deprecated:

Use MGUI::DLG_STATUS.

---

Member Enumeration Documentation

enum STATUSDIALOG::FLAGS

Enumerator:

FLAG_NoCancel
FLAG_DelayPopup
FLAG_None

---

Constructor & Destructor Documentation

STATUSDIALOG::STATUSDIALOG

(

)

[inline]

Constructor, performs initialization only, does not create dialog itself.

STATUSDIALOG::~STATUSDIALOG

(

)

[inline]

Destructor, will destroy dialog if exists.

---

Member Function Documentation

ERRVALUE STATUSDIALOG::CheckCancel

(

)

const [inline]

Check if 'Cancel' button has been pressed.

Returns:

EUserCancel if pressed or 0 if not.

ERRVALUE STATUSDIALOG::Create	(	MDLGPARENT	dlgparent,
		FLAGS	flags = FLAG_None
	)			[inline]

Create the actual dialog.

Parameters:

dlgparent

Parent for dialog

void STATUSDIALOG::Destroy

(

)

[inline]

Destroy dialog without destroying class instance.

void STATUSDIALOG::DisableCancel

(

)

const [inline]

Disable the 'Cancel' button on the dialog (if any).

void STATUSDIALOG::EnableCancel

(

)

const [inline]

Enable the 'Cancel' button on the dialog (if any).

MISTATUSMANAGER* STATUSDIALOG::GetHandle

(

)

const [inline]

Get the MISTATUSMANAGER* for the dialog.

Deprecated:

No new code should be written to take an MISTATUSMANAGER* directly, however this method is still necessary for calling some old code.

MTIMER* STATUSDIALOG::GetTimer

(

)

[inline]

Get timer associated with status dialog.

void STATUSDIALOG::ReportDone

(

TEXTID

textid = TEXTID__None

)

const [inline]

Report that process is finished with time.

This will change the 'Cancel' button to 'OK' wait for the user to press. If the TEXTID__None is specified a generic 'time to process' message will be shown.

void STATUSDIALOG::ResetCancel

(

)

const [inline]

Reset the 'Cancel' button on the dialog (if any).

MISTATUSMANAGER* STATUSDIALOG::SetSelfAsDefault

(

)

[inline]

Sets this dialog to be the default status handle.

Useful when calling functions that don't play nice and set the default back to 0 when they exit.

void STATUSDIALOG::WaitForOK

(

)

const [inline]

Wait for user to press 'OK' button.

---

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

• mi32/mstatus.h