wxGenericProgressDialog

Implements methods from the following classes

• wxDialog

Methods

• wxGenericProgressDialog
  Constructor.
• GetMessage
  Returns the last message passed to the Update() function; if you always passed wxEmptyString to Update() then the message set through the constructor is returned.
• GetRange
  Returns the maximum value of the progress meter, as passed to the constructor or wxNOT_FOUND if the dialog has no progress bar.
• GetValue
  Returns the last value passed to the Update() function or wxNOT_FOUND if the dialog has no progress bar.
• Pulse
  Like Update() but makes the gauge control run in indeterminate mode.
• Resume
  Can be used to continue with the dialog, after the user had clicked the "Abort" button.
• SetRange
  Changes the maximum value of the progress meter given in the constructor.
• Update
  Updates the dialog, setting the progress bar to the new value and updating the message if new one is specified.
• WasCancelled
  Returns true if the "Cancel" button was pressed.
• WasSkipped
  Returns true if the "Skip" button was pressed.

Static Methods

wxGenericProgressDialog

wxGenericProgressDialog ( string $title, string $message, integer $maximum=100, wxWindow &$parent=NULL, integer $style=wxPD_AUTO_HIDE|wxPD_APP_MODAL )

Constructor.

GetMessage

string GetMessage ( )

Returns the last message passed to the Update() function; if you always passed wxEmptyString to Update() then the message set through the constructor is returned.

GetRange

integer GetRange ( )

Returns the maximum value of the progress meter, as passed to the constructor or wxNOT_FOUND if the dialog has no progress bar.

GetValue

integer GetValue ( )

Returns the last value passed to the Update() function or wxNOT_FOUND if the dialog has no progress bar.

Pulse

bool Pulse ( string $newmsg=wxEmptyString, bool &$skip=NULL )

Like Update() but makes the gauge control run in indeterminate mode.

Resume

Resume ( )

Can be used to continue with the dialog, after the user had clicked the "Abort" button.

SetRange

SetRange ( integer $maximum )

Changes the maximum value of the progress meter given in the constructor.

Update

bool Update ( integer $value, string $newmsg=wxEmptyString, bool &$skip=NULL )

Updates the dialog, setting the progress bar to the new value and updating the message if new one is specified.

WasCancelled

bool WasCancelled ( )

Returns true if the "Cancel" button was pressed.

WasSkipped

bool WasSkipped ( )

Returns true if the "Skip" button was pressed.