Class: TTextActionControlState

Declaration: TextControlActions.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MTextControlState, MControlActionState

Inherited By:

None.

Purpose:

Generates actions when text control state is modified.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TTextActionControlState::TTextActionControlState

TTextActionControlState (TViewHandle textControl, const TSemanticActionType & message =TStandardActions :: kDefaultMessage)
TTextActionControlState (const TText & initialText, TViewHandle textControl, const TSemanticActionType & message =TStandardActions :: kDefaultMessage)
TTextActionControlState (const TTextActionControlState &)
TTextActionControlState ()

Interface Category:

API.

Purpose:

Constructs an instance with empty contents.
Constructs an instance with non-empty initial contents.
Copy constructor.
Default constructor.

Calling Context:

Called to construct an empty text control state, which can then be adopted into a TTextControl instance.
Called to construct a text control state with initial contents.
Called to copy an object.
Called by the stream-in operators and when the required parameters for the first two constructor forms are not available.

Parameters:

TViewHandle textControl -Control which is to be used as the initial target for action distribution.
const TSemanticActionType & message -Message to include in generated actions.
const TText & initialText -Initial text contents for the control.
TViewHandle textControl -Control which is to be used as the initial target for action distribution.
const TSemanticActionType & message -Message to include in generated actions.
const TTextActionControlState & -source object.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextActionControlState::~TTextActionControlState

virtual ~ TTextActionControlState ()

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

TTextActionControlState & operator =(const TTextActionControlState &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TTextActionControlState & -The source object.

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextActionControlState::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 the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextActionControlState::HandleTextChanged

virtual void HandleTextChanged (const TNotification &)

Interface Category:

API.

Purpose:

Generates actions when the state of the text control changes. Will generate a TTextControlAction::kEmpty when the text becomes empty, and a TTextControlAction::kNotEmpty when the text contents become non-empty.

Calling Context:

Called via a TMemberFunctionConnectionTo.

Parameters:

const TNotification & -The notification that the model generated when the text model was changed.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextActionControlState::InternalGetTextRepresentation

virtual MTextRepresentation * InternalGetTextRepresentation () const

Interface Category:

API.

Purpose:

Gets the text representation associated with this control state.

Calling Context:

Called by Text Editing Framework. Not called directly by clients.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to MTextRepresentation class.

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.