S3DProgressDlg |
This class is provides a generic wrapper for the dialog boxes that provide overall and current progress status, and give the user the option to cancel the export.
|
Interface Method |
Description |
|
Constructor |
|
|
Destructor |
|
|
Updates the progress window |
|
|
Destroys the progress window |
|
|
Sets the message text of the current status window |
|
|
Sets the text of the Main progress |
|
|
Sets the text of the current message to a resource string |
|
|
Sets the text of the main message to a resource string |
|
|
Increments the current progress bar |
|
|
Sets the current progress bar status |
|
|
Increments the total progress bar status |
|
|
Sets the total progress bar status |
|
|
Sets the number of progress steps on the current progress bar |
|
|
Sets the number of progress steps on the total progress bar |
|
|
Asks whether the cancel button has been pressed |
|
|
Initializes the object |
|
|
Processes any waiting windows messages |
Constructor method.
Parameters:
None
Return Values:
None
Destructor method.
Parameters:
None
Return Values:
None
This method increments the current progress bar and repaints the window. Defaults to incrementing the current progress by 1.
Parameters:
|
in_Progress = 1 |
The amount by which to advance the progress |
This method increments the total progress bar and repaints the window. Defaults to incrementing the total progress by 1.
Parameters:
|
= 1 |
The amount by which to advance the progress |
This method indicates whether the cancel button been pressed.
Parameters:
None
Return Values:
BOOL
This method indicates whether the process dialog been initialized.
Parameters:
None
Return Values:
BOOL
This method processes any waiting windows messages.
Parameters:
None
Return Values:
None
This method is a callback for the progress dialog. See Windows§ documentation for details on dialog procedures.
Parameters:
|
hwndDlg |
Help Window Dialog |
|
uMsg |
Message |
|
wParam |
Width parameter |
|
lParam |
Length parameter |
Return Values:
int
This method sets the text of the current message to a resource string. It loads a string from the resource table and sets the current message to it.
Parameters:
|
in_ResourceId |
The index of the string resource to load |
This method sets the message text of the current status window.
Parameters:
|
in_Msg |
The text to set the message to |
This method sets the current progress bar status and repaints the window.
Parameters:
|
in_Progress = 1 |
The position at which to set the current progress bar |
This method sets the number of progress steps on the current progress bar.
Parameters:
|
n_Steps |
The number of steps possible on the current progress bar |
This method sets the text of the main message to a resource string. It loads a string from the resource table and sets the main message to it.
Parameters:
|
in_ResourceId |
The index of the string resource to load |
This method sets the text of the Main progress.
Parameters:
|
in_Msg |
The text to set the message to |
This method sets the total progress bar status and repaints the window.
Parameters:
|
= 1 |
The position at which to set the total progress bar |
This method sets the number of progress steps on the total progress bar.
Parameters:
|
in_Steps |
The number of steps possible on the total progress bar |
This method destroys the progress window. It should be called when the export is finished or canceled.
Parameters:
None
This method initializes the object.
Parameters:
|
window |
Window Handle to parent window (used only if NOT compiled for MAX) |
This method updates the progress window. It causes the window to repaint and processes any waiting windows messages.
Parameters:
None
Return Values:
None
§See asterisked (*) statement at Legal Information © 2001 Intel Corporation.