DocWindowProgressBar Class Reference

#include <ProgressBar.h>

Inheritance diagram for DocWindowProgressBar:

Public Member Functions
	DocWindowProgressBar (int32 nStart, int32 nEnd, const PMString &strText, IDrawMgr *pMgr, bool32 bAllowCancel=kTrue, bool32 bShowImmediate=kFalse)
virtual bool16	WasCancelled (bool8 setGlobalErrorState=kTrue)
virtual void	Abort ()
virtual void	DisableChildProgressBars (bool16 disable)
virtual bool16	WasRegisterSuccessful ()
virtual void	SetPosition (int32 newPosition)

Detailed Description

Progress bar within a document window. Intended to be used as a stack based object, the lifetime of the progress bar corresponding to the scope of the object.

Constructor & Destructor Documentation

DocWindowProgressBar::DocWindowProgressBar	(	int32	nStart,
		int32	nEnd,
		const PMString &	strText,
		IDrawMgr *	pMgr,
		bool32	bAllowCancel = kTrue,
		bool32	bShowImmediate = kFalse
	)

Constructor

Parameters

taskStart	IN value corresponding to the start of the bar
taskEnd	IN value corresponding to the end of the bar
strText	IN text label
pMgr	IN draw manager to use
bAllowCancel	IN allow the operation to be cancelled
bShowImmediate	IN show the progress bar dialog immediately

Member Function Documentation

virtual void DocWindowProgressBar::Abort ( )

virtual

Call this anytime during the tasks to immediately terminate the entire progress bar process. Usually called when an error condition is encountered during one of the sub tasks.

Implements CProgressBar.

virtual void DocWindowProgressBar::DisableChildProgressBars ( bool16  disable )

virtual

Call this passing kTrue to keep any subsequent progress bars from subdividing your progress bar.

Implements CProgressBar.

virtual void DocWindowProgressBar::SetPosition ( int32  newPosition )

virtual

Call this to set the position of the progressbar to a location within the specified range.

Reimplemented from CProgressBar.

virtual bool16 DocWindowProgressBar::WasCancelled ( bool8  setGlobalErrorState = kTrue )

virtual

Check this to see if the user cancelled the action.

Implements CProgressBar.

virtual bool16 DocWindowProgressBar::WasRegisterSuccessful ( )

virtual

Was the registration of this progress bar was successful. Not usually necessary to call this. Reasons for failure include another progress bar calling DisableChildProgressBars().

Implements CProgressBar.