Class: TDialogControlStateOn

Declaration: DialogController.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MMomentaryControlState

Inherited By:

None.

Purpose:

TDialogControlStateOn is a template class parameterized by a dialog controller. An object of this type is passed to a momentary menu item. The Select member function uses TGUIPresenter API to cause a presenter to adopt a dialog controller.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TDialogControlStateOn::TDialogControlStateOn

TDialogControlStateOn (TGUIBundle * theBundleToAlias)

Interface Category:

API.

Purpose:

Create a new TDialogControlStateOn with the specified GUI bundle.

Calling Context:

Called by any client object.

Parameters:

TGUIBundle * theBundleToAlias -The GUI bundle for the new TDialogControlStateOn.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDialogControlStateOn::~TDialogControlStateOn

virtual ~ TDialogControlStateOn ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDialogControlStateOn::Select

virtual void Select ()

Interface Category:

API.

Purpose:

Creates a new dialog controller with this object's GUI bundle. Then, this function causes the GUI bundle's presenter to adopt the new dialog controller. The dialog controller is of the type used to create the concrete control state class from the template.

Calling Context:

Called by the Presentation Framework.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDialogControlStateOn::GetGUIBundle

TGUIBundle * GetGUIBundle () const

Interface Category:

API.

Purpose:

Returns this object's GUI bundle.

Calling Context:

Called from Select and by any client object.

Parameters:

Takes no parameters.

Return Value:

Returns this object's GUI bundle.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDialogControlStateOn::SetGUIBundle

void SetGUIBundle (TGUIBundle * theBundleToAlias)

Interface Category:

API.

Purpose:

Sets this object's GUI bundle.

Calling Context:

Called by any client object.

Parameters:

TGUIBundle * theBundleToAlias -The new GUI bundle for this object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDialogControlStateOn::AdoptDialogView

void AdoptDialogView (TView * dialogView)

Interface Category:

API.

Purpose:

Adopt the dialog view to be used when creating the dialog controller.

Calling Context:

You can call this function directly.

Parameters:

TView * dialogView -The view to adopt.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.