Communicator UI: 5.1 FoamProgressDialog: FoamProgressDialog Instance Data

| Up: GEOS SDK TechDocs | Up | Prev: 5 FoamProgressDialog | Next: 5.2 Setting Up the Template

FoamProgressDialogClass contains several pieces of instance data, and also alters the defaults of its superclasses, GenControlClass and GenInteractionClass .

Code Display 2-11 FoamProgressDialogClass Instance Data

@instance		ChunkHandle		FPDI_descriptionText			= NullChunk;
@instance		ChunkHandle		FPDI_statusText			= NullChunk;
@instance		optr		FPDI_cancelDestination			= NullOptr;
@instance		word		FPDI_cancelActionMsg			= 0;
@vardata void		HINT_FOAM_PROGRESS_DIALOG_DESTROY_SELF_AFTER_DISMISS;
@vardata void		ATTR_FOAM_PROGRESS_DIALOG_DONT_DISMISS_ON_CANCEL;
@default		GII_visibility		= GIV_POPUP;
@default		GII_type		= GIT_MULTIPLE_RESPONSE;
@default		GII_attrs		= (GIA_NOT_USER_INITIATABLE | GIA_MODAL);
@default		GI_attrs		= GA_SIGNAL_INTERACTION_COMPLETE;
@default		GI_states		= (@default | GS_ENABLED);
 
FPDI _descriptionText contains text to display to the user, informing them of the task being performed.
FPDI_ statusText contains text to display next to the status indicator.
FPDI _cancelDestination contains the object that should receive notification (via FPDI _cancelActionMsg ) if the action is cancelled by the user. The object must be capable of handling cancellation in a clean manner.
FPDI_ cancelActionMsg stores the message to send if the user cancels the operation. This message will be sent to the FPDI_ cancelDestination , where it should be handled appropriately.
HINT_FOAM_PROGRESS_DIALOG_DESTROY_SELF_AFTER_DISMISS indicates that the resource block containing this dialog should be destroyed after the dialog is dismissed. This hint indirectly calls UserDestroyDialog(); do not use this hint if you will use TakeDownDialogViaUIThread() instead.
ATTR_FOAM_PROGRESS_DIALOG_DONT_DISMISS_ON_CANCEL indicates that the dialog will not be dismissed if the user presses "Cancel." The application is responsible for handling this situation, and eventually dismissing the dialog.
| Up: GEOS SDK TechDocs | Up | Prev: 5 FoamProgressDialog | Next: 5.2 Setting Up the Template