Class: TBooleanMenuAction

Declaration: StandardControlActions.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TMenuAction

Inherited By:

None.

Purpose:

TBooleanMenuAction derives from TMenuAction. It is generated by menu items that have a Boolean state associated with them. The usual event type defined in a TBooleanMenuAction is TStandardControlActions::kValueChanged.

Instantiation:

This class is usually allocated on the heap so that it can be posted in a request.

Deriving Classes:

Use TBooleanMenuAction to derive classes that have additional information associated with them. Note that the Dispatch member function attempts to dispatch the action to an MBooleanMenuActionHandler first, and if no MBooleanMenuActionHandler exists, or it doesn't handle the action, then Dispatch tries to dispatch the action to an MMenuActionHandler. If this doesn't exist, or doesn't handle the action, Dispatch tries to dispatch the action to MViewActionHandler. This behavior will be the same for classes derived from TBooleanMenuAction. If you want to change this behavior, for example, if you have your own MXxxxActionHandler mixin, then you need to derive a class either directly from TMenuAction (if you want to dispatch to your MXxxxActionHandler first, and then to MMenuActionHandler, and finally to MViewActionHandler), or from TBooleanMenuAction (if you are also going to dispatch to MBooleanMenuActionHandler).

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TBooleanMenuAction::TBooleanMenuAction

TBooleanMenuAction ()
TBooleanMenuAction (const TEventType & eventType, const TViewHandle & viewHandle, MMenuItem * itemAlias, MBooleanControlState :: EBooleanState state, const TSemanticActionType & semanticMessage =TStandardActions :: kDefaultMessage)
TBooleanMenuAction (const TBooleanMenuAction &)

Interface Category:

API.

Purpose:

Default constructor.
Creates a TBooleanMenuAction initialized with the specified event, view, menu item ID, Boolean state, and semantic message.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to create a TBooleanMenuAction initialized with the passed parameters.
Called to copy an object.

Parameters:

Takes no parameters.
const TEventType & eventType -The event type associated with this action.
const TViewHandle & viewHandle -Handle to the view with which this action is to be associated.
MMenuItem * itemAlias -The menu item ID associated with this action.
MBooleanControlState :: EBooleanState state -The Boolean state associated with this action.
const TSemanticActionType & semanticMessage =TStandardActions :: kDefaultMessage -The message associated with the action.
const TBooleanMenuAction & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBooleanMenuAction::operator=

TBooleanMenuAction & operator =(const TBooleanMenuAction &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TBooleanMenuAction & -The source object for the assignment.

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: TBooleanMenuAction::~TBooleanMenuAction

virtual ~ TBooleanMenuAction ()

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: TBooleanMenuAction::GetState

MBooleanControlState :: EBooleanState GetState ()

Interface Category:

API.

Purpose:

Returns the current value of the Boolean state associated with this action.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The current value of the Boolean state.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBooleanMenuAction::SetState

virtual void SetState (MBooleanControlState :: EBooleanState state)

Interface Category:

API.

Purpose:

Sets the current value of the Boolean state associated with this action.

Calling Context:

Called by class that generated this action.

Parameters:

MBooleanControlState :: EBooleanState state -The value to set for the Boolean control.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBooleanMenuAction::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 the object streams itself out to.

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

TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

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

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBooleanMenuAction::Dispatch

virtual bool Dispatch (MActionTarget & target)

Interface Category:

API.

Purpose:

Dispatches the action to the specified target. First attempts to dynamically cast the target to an MBooleanMenuActionHandler, and then dispatches the action to the MBooleanMenuActionHandler. If no MBooleanMenuActionHandler exists, or it doesn't handle the action, then Dispatch calls the inherited TMenuAction Dispatch function, which tries to dispatch the action to an MMenuActionHandler. If this doesn't exist, or doesn't handle the action, then the TMenuAction Dispatch function tries to dispatch the action to an MViewActionHandler.

Calling Context:

Called to dispatch this action.

Parameters:

MActionTarget & target -The target to use.

Return Value:

Returns true if the action was successfully dispatched, false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TMenuAction function.

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