Class: TBooleanActionState

Declaration: ActionControlStates.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MBooleanControlState, MControlActionState

Inherited By:

TBooleanMenuActionControlState

Purpose:

TBooleanActionState generates view actions that are associated with classes derived from TBooleanControl.

Instantiation:

Always allocate on the heap.

Deriving Classes:

Derive from this class if you want to add information to the Boolean action or do some other behavior in addition to posting the action. When plugged into a Boolean control, it is called like any other MBooleanControlState. When SetBooleanState is called, it sends a Boolean control action that contains the semantic message passed in at construction.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TBooleanActionState::TBooleanActionState

TBooleanActionState (TViewHandle booleanControl, const TSemanticActionType & message =TStandardActions :: kDefaultMessage)
TBooleanActionState (const TBooleanActionState &)
TBooleanActionState ()

Interface Category:

API.

Purpose:

Constructs a usable TBooleanActionState.
Copy constructor.
Default constructor.

Calling Context:

Called to construct a usable instance which is then adopted into a class instance derived from TBooleanControl.
Called to copy an object.
Called by the stream-in operators and when the requisite parameters for the first constructor form are not available.

Parameters:

TViewHandle booleanControl -The handle to the control with which this state is associated. This control will be the first target of the action distribution.
const TSemanticActionType & message -The message to send with the action.
const TBooleanActionState & -The object to be copied.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBooleanActionState::operator=

TBooleanActionState & operator =(const TBooleanActionState &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TBooleanActionState & -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: TBooleanActionState::~TBooleanActionState

virtual ~ TBooleanActionState ()

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The destination stream.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBooleanActionState::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -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: TBooleanActionState::GetBooleanState

virtual EBooleanState GetBooleanState () const

Interface Category:

API.

Purpose:

Gets the current Boolean state associated with the control.

Calling Context:

Called to find out the current Boolean state of the control.

Parameters:

Takes no parameters.

Return Value:

Boolean state, one of kTrue, kFalse, or kUnknown.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBooleanActionState::SetBooleanState

virtual void SetBooleanState (EBooleanState state)

Interface Category:

API.

Purpose:

Sets the Boolean state of the control and posts a Boolean control action.

Calling Context:

Called by the control that references or owns the TBooleanActionState when the control is operated. You could override this to do some more work, then called inherited SetBooleanState to let it post the action.

Parameters:

EBooleanState state -The new state of the control.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBooleanActionState::SetBooleanStateValue

void SetBooleanStateValue (EBooleanState state)

Interface Category:

API.

Purpose:

Allows setting of the state without posting the action.

Calling Context:

Called by derived classes to set the state without triggering an action.

Parameters:

EBooleanState state -The Boolean state to set the control to.

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.