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

S3DProgressDlg

Constructor

~S3DProgressDlg

Destructor

UpdateWindow

Updates the progress window

Terminate

Destroys the progress window

SetCurrentMsg

Sets the message text of the current status window

SetMainMsg

Sets the text of the Main progress

SetCurrentMsg

Sets the text of the current message to a resource string

SetMainMsg

Sets the text of the main message to a resource string

IncCurrentProgress

Increments the current progress bar

SetCurrentProgress

Sets the current progress bar status

IncTotalProgress

Increments the total progress bar status

SetTotalProgress

Sets the total progress bar status

SetCurrentProgressSteps

Sets the number of progress steps on the current progress bar

SetTotalProgressSteps

Sets the number of progress steps on the total progress bar

IsCanceled

Asks whether the cancel button has been pressed

Initialize

Initializes the object

ProcessMessages

Processes any waiting windows messages


S3DProgressDlg::S3DProgressDlg ()

Constructor method.

Parameters:

None

Return Values:

None


S3DProgressDlg::~S3DProgressDlg ()

Destructor method.

Parameters:

None

Return Values:

None


S3DProgressDlg::IncCurrentProgress (U32 in_Progress = 1)

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

Return Values


S3DProgressDlg::IncTotalProgress (U32 = 1)

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

Return Values


S3DProgressDlg::IsCanceled ()

This method indicates whether the cancel button been pressed.

Parameters:

None

Return Values:

BOOL


S3DProgressDlg::IsInit ()

This method indicates whether the process dialog been initialized.

Parameters:

None

Return Values:

BOOL


S3DProgressDlg::ProcessMessages ()

This method processes any waiting windows messages.

Parameters:

None

Return Values:

None


S3DProgressDlg::ProgressDlgProc (HWND hwndDlg, UINT uMsg, WPARAM wParam, LPARAM lParam) [static]

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


S3DProgressDlg::SetCurrentMsg (U32 in_ResourceId)

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

Return Values


S3DProgressDlg::SetCurrentMsg (CIFXString * in_Msg)

This method sets the message text of the current status window.

Parameters:

in_Msg

The text to set the message to

Return Values


S3DProgressDlg::SetCurrentProgress (U32 in_Progress = 1)

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

Return Values


S3DProgressDlg::SetCurrentProgressSteps (U32 in_Steps)

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

Return Values


S3DProgressDlg::SetMainMsg (U32 in_ResourceId)

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

Return Values


S3DProgressDlg::SetMainMsg (CIFXString * in_Msg)

This method sets the text of the Main progress.

Parameters:

in_Msg

The text to set the message to

Return Values


S3DProgressDlg::SetTotalProgress (U32 = 1)

This method sets the total progress bar status and repaints the window.

Parameters:

= 1

The position at which to set the total progress bar

Return Values


S3DProgressDlg::SetTotalProgressSteps (U32 in_Steps)

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

 


S3DProgressDlg::Terminate ()

This method destroys the progress window. It should be called when the export is finished or canceled.

Parameters:

None

Return Values


S3DProgressDlg::Initializes (HWND window)

This method initializes the object.

Parameters:

window

Window Handle to parent window (used only if NOT compiled for MAX)

 

Return Values


S3DProgressDlg::UpdateWindow ()

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.