WBProgressDialog Interface Reference

Modal progress dialog used to display task progress and status. More...

Inheritance diagram for WBProgressDialog:

Public Member Functions
void	WBProgressDialog (string title, WBModuleDef parentWindow)
proto external void	SetProgress (float progress)
	Updates the progress value displayed in the dialog.
proto external void	SetMainTitle (string text)
	Sets the main title text displayed at the top of the dialog.
proto external void	SetActionTitle (string text)
	Sets the action title text describing the current operation.
Public Member Functions inherited from Managed
proto external ref Managed	Clone ()
	Return shallow copy of object, or null if it is not allowed (not public constructor)

Detailed Description

Modal progress dialog used to display task progress and status.

Provides an interface for updating progress, the main title, and the action description shown to the user. The dialog is associated with a parent module window.

WBProgressDialog progress = new WBProgressDialog("Main Title", null);
 
for (int i = 0; i < 100; i++)
{
progress.SetProgress(i / 100);
progress.SetMainTitle("Working on something " + i / 20);
progress.SetActionTitle("Processing " + i / 10);
Print(i);
}

Constructor & Destructor Documentation

WBProgressDialog()

void WBProgressDialog.WBProgressDialog	(	string	title,
		WBModuleDef	parentWindow )

Member Function Documentation

SetActionTitle()

proto external void WBProgressDialog.SetActionTitle

(

string

text

)

Sets the action title text describing the current operation.

Parameters

text	New action description.

SetMainTitle()

proto external void WBProgressDialog.SetMainTitle

(

string

text

)

Sets the main title text displayed at the top of the dialog.

Parameters

text	New main title.

SetProgress()

proto external void WBProgressDialog.SetProgress

(

float

progress

)

Updates the progress value displayed in the dialog.

Parameters

progress

Progress value in the range [0.0, 1.0].

---

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

• GameLib/generated/WorkbenchAPI/WBProgressDialog.c