Class: TGUIDialogControllerViewAction

Declaration: DialogController.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TViewAction

Inherited By:

None.

Purpose:

TGUIDialogControllerViewAction derives from TViewAction and is used to communicate dialog controller actions to the TGUIPresenter.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive from this class if new actions are being added.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TGUIDialogControllerViewAction::TGUIDialogControllerViewAction

TGUIDialogControllerViewAction ()
TGUIDialogControllerViewAction (TGUIDialogController * controllerAlias, const TViewHandle & viewHandle, const TSemanticActionType & semanticMessage)
TGUIDialogControllerViewAction (const TGUIDialogControllerViewAction &)

Interface Category:

API.

Purpose:

Default constructor.
Creates a new dialog controller view action for the specified dialog controller, in the specified view, and whose message is the one specified.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called by any client object.
Called to copy an object.

Parameters:

Takes no parameters.
TGUIDialogController * controllerAlias -The dialog controller for which this object is a view action.
const TViewHandle & viewHandle -The view for which this object is a view action.
const TSemanticActionType & semanticMessage -The message represented by the new view action.
const TGUIDialogControllerViewAction & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDialogControllerViewAction::operator=

TGUIDialogControllerViewAction & operator =(const TGUIDialogControllerViewAction &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TGUIDialogControllerViewAction & -The object to be copied.

Return Value:

Returns a const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDialogControllerViewAction::~TGUIDialogControllerViewAction

virtual ~ TGUIDialogControllerViewAction ()

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: TGUIDialogControllerViewAction::operator>>=

TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream to which the object streams itself out.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDialogControllerViewAction::operator<<=

TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream from which the object streams itself in.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws a TInvalidVersionError if the version of the object on the stream is unknown to the version of the shared library installed.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDialogControllerViewAction::GetDialogController

TGUIDialogController * GetDialogController () const

Interface Category:

API.

Purpose:

Returns the dialog controller for which this object is a view action.

Calling Context:

Called by any client object.

Parameters:

Takes no parameters.

Return Value:

Returns the dialog controller for which this object is a view action.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDialogControllerViewAction::SetDialogController

virtual void SetDialogController (TGUIDialogController * controller)

Interface Category:

API.

Purpose:

Sets the dialog controller for which this object is a view action.

Calling Context:

Called by any client object.

Parameters:

TGUIDialogController * controller -The new dialog controller for this object.

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.