ProgressWindow Class Reference

Public Member Functions
	ProgressWindow (str title)
	ProgressWindow (str title, int minimum, int maximum)
None	IncrementProgress (str label)
None	IncrementProgress (str label, int increment)
None	SetProgress (str label, int value)
None	SetScaledProgress (str label, int value)

Detailed Description

Popup window with a title bar, an info label, and a progress bar.

Constructor & Destructor Documentation

ProgressWindow() [1/2]

ProgressWindow::ProgressWindow

(

str

title

)

Shows a new progress dialog which is modal and has no buttons or icons, with an increment of 1%.

Parameters

title

the progress dialog title

ProgressWindow() [2/2]

ProgressWindow::ProgressWindow	(	str	title,
		int	minimum,
		int	maximum
	)

Shows a new progress dialog which is modal and has no buttons or icons, with the given increment.

Note

the internal value of the progress dialog is always stored from 0 to 100%.

Parameters

title	the progress dialog title
minimum	the beginning progress position
maximum	the end progress position, increment = 100.0f / ( maximum - minimum )

Precondition

maximum >= minimum

Member Function Documentation

IncrementProgress() [1/2]

None ProgressWindow::IncrementProgress

(

str

label

)

Updates the progress dialog label and increments progress by increment percentage points (default of 1%)

Parameters

label

the string to set the progress dialog label to

IncrementProgress() [2/2]

None ProgressWindow::IncrementProgress	(	str	label,
		int	increment
	)

Updates the progress dialog label and increments the progress by the given percentage points.

Parameters

label	the string to set the progress dialog label to
increment	the amount to increase the progress by

SetProgress()

None ProgressWindow::SetProgress	(	str	label,
		int	value
	)

Updates the progress dialog label and assigns the progress to an exact percentage value.

Parameters

label	the string to set the progress dialog label to
value	the value to set the progress to

SetScaledProgress()

None ProgressWindow::SetScaledProgress	(	str	label,
		int	value
	)

Updates the progress dialog label and assigns the progress to a scaled value i.e.

the value of the progress bar = value * increment (as calculated in the ructor)

Parameters

label	the string to set the progress dialog label to
value	progress will be set to this value scaled by increment

---

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

• ProgressWindow.i