TaskProgressBar Class Reference

#include <ProgressBar.h>

Inheritance diagram for TaskProgressBar:

Public Member Functions
	TaskProgressBar (const PMString &title, int32 numTasks, bool8 showImmediate=kFalse, bool8 showCancel=kTrue, IProgressBarControlData *customProgress=nil, bool32 useTwoBars=kFalse)
void	DoTask (const PMString &displayText="", int32 advanceNtasks=1)
void	SetTaskStatus (const PMString &displayText="")
Public Member Functions inherited from BaseProgressBar
bool16	WasCancelled (bool8 setGlobalErrorState=kTrue)
void	Abort ()
void	DisableChildProgressBars (bool16 disable)
bool16	WasRegisterSuccessful ()
void	SetPosition (int32 newPosition)

Additional Inherited Members
Protected Member Functions inherited from BaseProgressBar
	BaseProgressBar (int32 nType, const PMString &progressDialogTitle, int32 taskStart, int32 taskEnd, bool8 showImmediate, bool8 showCancel, IProgressBarControlData *customProgress, bool32 useTwoBars)
Protected Attributes inherited from BaseProgressBar
IProgressBarManager *	fProgressMgr
int32	fnBarID

Detailed Description

Task Progress bar (one that manages a series of smaller tasks). 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

TaskProgressBar::TaskProgressBar	(	const PMString &	title,
		int32	numTasks,
		bool8	showImmediate = kFalse,
		bool8	showCancel = kTrue,
		IProgressBarControlData *	customProgress = nil,
		bool32	useTwoBars = kFalse
	)

Constructor

Parameters

title	IN dialog title
numTasks	IN number of tasks managed by this progress 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 TaskProgressBar::DoTask	(	const PMString &	displayText = "",
		int32	advanceNtasks = 1
	)

Call this before processing a task. Calling this will move the progress bar for any previously called tasks

void TaskProgressBar::SetTaskStatus

(

const PMString &

displayText = ""

)

set line of status text