MOA Developer's Guide
MOA Interfaces | MOA Methods | MOA Types and Misc API

IMoaProgressBox

Interface ID: IID_IMoaProgressBox
Pointer type: PIMoaProgressBox
Inheritance: IMoaUnknown
Header file: moastdif.h

Description
This optional callback interface may be provided by an application's callback object to provide methods for reporting progress to the user. In Director this interface is only provided in the Authoring environment, it is not available in Projectors or Shockwave.

Methods

Opening and closing
OpenProgress()
CloseProgress()
Setting text
SetCaption()
SetUserMessage()
Showing progress
SetUserProgress()
Testing for cancel
TestUserCanceled()

CloseProgress()

Syntax
CloseProgress()
Parameters
Returns
void
Description
Closes the progress dialog box.

OpenProgress()

Syntax
OpenProgress(MoaBoolParam showStopButton)
Parameters
showStopButton
Determines whether progress box displays Stop button
Returns
void
Description
Opens the progress dialog box for an operation. If showStopButton is TRUE, the progress dialog box displays a Stop button, allowing the user to cancel the operation.

SetCaption()

Syntax
SetCaption(ConstPMoaChar sCaption)
Parameters
sCaption
String representing the caption for the progress dialog box
Returns
MoaError
Description
Assigns the provided string as the caption for the progress box.

SetUserMessage()

Syntax
SetUserMessage(ConstPMoaChar sMessage)
Parameters
sMessage
String representing the user message for the progress dialog box
Returns
MoaError
Description
Sets an optional message sMessage to display in the dialog box. This message can be updated periodically to report changes in processing status.

SetUserProgress()

Syntax
SetUserProgress(MoaUlong done, MoaUlong total)
Parameters
done
Integer representing the amount of processing completed
total
Integer representing total processing to be completed
Returns
MoaError
Description
Sets the amount of progress displayed in the dialog box. The progress displayed will be the proportion of the value of done to the value of total.

TestUserCanceled()

Syntax
TestUserCanceled()
Parameters
Returns
MoaError
Description
Tests whether the user has canceled the process from the progress dialog box.

Copyright © 1995-2007 Adobe Macromedia Software LLC, Inc.