StDialogHandler

StDialogHandler is a PowerPlant class that is used for creating dialog boxes.

Methods :

The methods in this class are:

StDialogHandler()	~StDialogHandler()
AllowSubRemoval()	DoDialog()
FindCommandStatus()	GetDialog()
ListenToMessage()	SetSleepTime()

Data Members:

The data members in this class are:

mDialog	mMessage
mSleepTime

Operation:

Refer to The PowerPlant Book for important information about mixing the PowerPlant dialog classes with the Mac OS Toolbox calls.

Source files:

(Utility Classes)

UModalDialogs.h

UModalDialogs.cp

Ancestors:

LAttachable

LCommander

LEventDispatcher

LListener

See also:

LBroadcaster

StDialogHandler()

Purpose:

The constructor creates an object from the passed-in parameters.

Access:

Public

Prototype:

StDialogHandler( ResIDT inDialogResID,

LCommander *inSuper );

The parameters for this constructor are:

ResIDT	inDialogResID	The resource ID for the dialog resource.
LCommander*	inSuper	The SuperCommander for this dialog.

~StDialogHandler()

Purpose:

The destructor destroys the object.

Access:

Virtual, Public

Prototype:

virtual ~StDialogHandler();

AllowSubRemoval()

Purpose:

This method indicates whether removal of subcommanders is allowed. It is an override of AllowSubRemoval() in LCommander.

DoDialog()

Purpose:

Handle an event for a dialog box.

Access:

Virtual, Public

Prototype:

virtual MessageT DoDialog();

None

Return:

If the event triggers a Broadcaster to broadcast a message, the last such message heard by the DialogHandler is returned. Otherwise, this function returns msg_Nothing.

Remarks:

Call this function repeatedly to handle events.

FindCommandStatus()

Purpose:

This method passes back the status of a command. It is an override of FindCommandStatus() in LCommander.

GetDialog()

Purpose:

This is an accessor method for mDialog.

Access:

Public

Prototype:

LWindow* GetDialog();

None

Return:

Returns the pointer mDialog to the window for the dialog box.

ListenToMessage()

Purpose:

This method provides the message processing behavior for an LListener-inherited object. It is an override of ListenToMessage() in LListener.

SetSleepTime()

Purpose:

This method sets the value of the mSleepTime data member.

Access:

Public

Prototype:

void SetSleepTime(SInt32 inSleepTime);

SInt32 indicating the sleep time to store in mSleepTime.

Return:

None

mDialog

Purpose:

The pointer to the dialog box.

Access:

Protected

Prototype:

LWindow *mDialog;

mMessage

Purpose:

A place to store the message.

Access:

Protected

Prototype:

MessageT mMessage;

mSleepTime

Purpose:

Storage for the sleep time parameter.

Access:

Protected

Prototype:

SInt32 mSleepTime;