Class: TAction

Declaration: Action.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TViewAction

Purpose:

TAction is a base class that is used to derive classes representing specific types of actions. It is possible to instantiate a TAction object directly, though such an object only notifies you that an action has occurred and has no specific knowledge of the action's type.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

You can use TAction to derive classes which represent specific types of actions. Derived classes should provide any state information which might be required, as TAction does not provide such information.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TAction::TAction

TAction ()
TAction (const TAction & copy)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to copy an object. Usually called by derived class' copy constructors.

Parameters:

Takes no parameters.
const TAction & copy -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAction::operator=

TAction & operator =(const TAction & assign)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object. Usually called by derived class' assignment operators.

Parameters:

const TAction & assign -The object to be copied.

Return Value:

A non-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: TAction::~TAction

virtual ~ TAction ()

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

TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data. Usually called by derived class' stream-in operators.

Parameters:

TStream & fromWhere -The source stream.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAction::Dispatch

virtual bool Dispatch (MActionTarget & target)

Interface Category:

API.

Purpose:

Dispatches the action to the specified target, if the target is an MActionHandler.

Calling Context:

Called to dispatch an action to a specified target. Usually called from action target HandleActionDispatch or action derived class Dispatch.

Parameters:

MActionTarget & target -The target.

Return Value:

Returns true if the target was an MActionHandler and if the target handled the action, otherwise false is returned.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAction::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The destination stream. Usually called by derived class'stream-out operators.

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.

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