Inheritance diagram for RangeProgressBar:

Public Member Functions
	RangeProgressBar (const PMString &title, int32 startRange, int32 endRange, bool8 showImmediate=kFalse, bool8 showCancel=kTrue, IProgressBarControlData *customProgress=nil, bool32 useTwoBars=kFalse, std::function< void()> callback=nullptr)

void	SetTaskText (const PMString &text, bool16 forceRedraw=kTrue)

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

Range Progress bar. 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

RangeProgressBar::RangeProgressBar	(	const PMString &	title,
		int32	startRange,
		int32	endRange,
		bool8	showImmediate = `kFalse`,
		bool8	showCancel = `kTrue`,
		IProgressBarControlData *	customProgress = `nil`,
		bool32	useTwoBars = `kFalse`,
		std::function< void()>	callback = `nullptr`
	)

Constructor

Parameters

title	IN dialog title
startRange	IN value corresponding to the start of the bar
endRange	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)

void RangeProgressBar::SetTaskText	(	const PMString &	text,
		bool16	forceRedraw = `kTrue`
	)

Set the task text for the current task.