BaseProgressBar Class Reference

#include <ProgressBar.h>

Inheritance diagram for BaseProgressBar:

Public Member Functions
bool16	WasCancelled (bool8 setGlobalErrorState=kTrue)
void	Abort ()
void	DisableChildProgressBars (bool16 disable)
bool16	WasRegisterSuccessful ()
void	SetPosition (int32 newPosition)

Protected Member Functions
	BaseProgressBar (int32 nType, const PMString &progressDialogTitle, int32 taskStart, int32 taskEnd, bool8 showImmediate, bool8 showCancel, IProgressBarControlData *customProgress, bool32 useTwoBars)

Protected Attributes
IProgressBarManager *	fProgressMgr
int32	fnBarID

Detailed Description

Concrete/generic progress bar - used as a starting point for various types of progress bars. 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

BaseProgressBar::BaseProgressBar ( int32  nType, const PMString &  progressDialogTitle, int32  taskStart, int32  taskEnd, bool8  showImmediate, bool8  showCancel, IProgressBarControlData *  customProgress, bool32  useTwoBars  )

protected

Constructor

Parameters

nType	IN the progress bar type
progressDialogTitle	IN dialog title
taskStart	IN value corresponding to the start of the bar
taskEnd	IN value corresponding to the end of the bar
showImmediate	IN show the progress bar dialog immediately
showCancel	IN make the cancel button visible
customProgress	IN custom progress bar control data
useTwoBars	IN one bar or two (for subtasks)

Member Function Documentation

void BaseProgressBar::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.

void BaseProgressBar::DisableChildProgressBars ( bool16  disable )

virtual

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

Implements CProgressBar.

void BaseProgressBar::SetPosition ( int32  newPosition )

virtual

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

Reimplemented from CProgressBar.

bool16 BaseProgressBar::WasCancelled ( bool8  setGlobalErrorState = kTrue )

virtual

Check this to see if the user cancelled the action.

Implements CProgressBar.

bool16 BaseProgressBar::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.