STATUSCONTEXT Class Reference

Status context (DEPRECATED). More...

#include <mi32/mstatus.h>

List of all members.

Public Member Functions
	STATUSCONTEXT (STATUSDIALOG &sdialog)
	STATUSCONTEXT (MISTATUSMANAGER *pStatusMgr=0, bool CreateContext=true)
	~STATUSCONTEXT ()
void	BarClear ()
int	BarIncrement (INT32 increment=1, int line=0)
int	BarInit (INT32 maximum, int line=0)
int	BarUpdate (INT32 value, INT32 maximum, int line=0)
int	CheckCancel ()
void	Clear ()
void	ClearLine (int)
void	ClearLine ()
void	Create (MISTATUSMANAGER *pStatusMgr=0)
void	Destroy ()
void	DisableCancel ()
void	EnableCancel ()
MISTATUSCONTEXT *	GetHandle () const
int	TextUpdate (const MISTRING &string, int line=0)

---

Detailed Description

Status context (DEPRECATED).

Deprecated:

use MISTATUSCONTEXT instead.

---

Constructor & Destructor Documentation

STATUSCONTEXT::STATUSCONTEXT	(	MISTATUSMANAGER *	pStatusMgr = 0,
		bool	CreateContext = true
	)			[inline, explicit]

Constructor using default status dialog.

STATUSCONTEXT::STATUSCONTEXT

(

STATUSDIALOG &

sdialog

)

[inline, explicit]

Construct context in STATUSDIALOG.

STATUSCONTEXT::~STATUSCONTEXT

(

)

[inline]

Destructor.

---

Member Function Documentation

void STATUSCONTEXT::BarClear

(

)

[inline]

Clear the status bar.

int STATUSCONTEXT::BarIncrement	(	INT32	increment = 1,
		int	line = 0
	)			[inline]

Increment progress indicator bar position.

Parameters:

increment

Amount to increment by

int STATUSCONTEXT::BarInit	(	INT32	maximum,
		int	line = 0
	)			[inline]

Initialize or reset progress bar.

Parameters:

maximum

Maximum expected number of calls to BarIncrement()

int STATUSCONTEXT::BarUpdate	(	INT32	value,
		INT32	maximum,
		int	line = 0
	)			[inline]

Update progress indicator bar position.

Parameters:

	value	Current bar position
	maximum	Maximum bar position

int STATUSCONTEXT::CheckCancel

(

)

[inline]

Check if cancel button has been pressed.

void STATUSCONTEXT::Clear

(

)

[inline]

Clear all lines in status context.

void STATUSCONTEXT::ClearLine

(

int

)

[inline]

Clear both text and indicator bar in context.

void STATUSCONTEXT::ClearLine

(

)

[inline]

Clear both text and indicator bar in context.

void STATUSCONTEXT::Create

(

MISTATUSMANAGER *

pStatusMgr = 0

)

[inline]

Create a status context.

void STATUSCONTEXT::Destroy

(

)

[inline]

Destroy status context.

Automatically called by destructor.

void STATUSCONTEXT::DisableCancel

(

)

[inline]

Disable cancel button.

void STATUSCONTEXT::EnableCancel

(

)

[inline]

Enable cancel button.

MISTATUSCONTEXT* STATUSCONTEXT::GetHandle

(

)

const [inline]

Obtain internal handle for legacy functions.

int STATUSCONTEXT::TextUpdate	(	const MISTRING &	string,
		int	line = 0
	)			[inline]

Update text line using a string.

Parameters:

string

Text string (also implies TEXTID)

---

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

• mi32/mstatus.h