Class: TSimpleTextControlState

Declaration: TextControl.h

Taxonomy Categories:

Member Functions:


Interface Category:

API.

Inherits From:

MTextControlState

Inherited By:

None.

Purpose:

A concrete implementation of MTextControlState that maintains the underlying text data as an instance of TSimpleTextStore. This is the default control state class used if none is specified when constructing the text control.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is designed to be used directly. If you want to create your own concrete text control class, you should derive directly from MTextControlState.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSimpleTextControlState::TSimpleTextControlState

  1. TSimpleTextControlState ()
  2. TSimpleTextControlState (const TText &)
  3. TSimpleTextControlState (const TSimpleTextControlState &)

Interface Category:

API.

Purpose:

  1. Default constructor.
  2. Constructs a text control state, putting the specified text data into the underlying text representation.
  3. Copy constructor.

Calling Context:

  1. May be called directly by clients.
  2. May be called directly by clients.
  3. May be called directly by clients.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSimpleTextControlState::~TSimpleTextControlState

virtual ~ TSimpleTextControlState ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Typically not called directly by clients.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSimpleTextControlState::operator=

TSimpleTextControlState & operator =(const TSimpleTextControlState &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

May be called directly by clients.

Parameters:

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

May be called directly by clients.

Parameters:

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

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

May be called directly by clients.

Parameters:

Return Value:

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

Exceptions:

Throws TInvalidVersionError if the object has detected an unsupportable version during the stream-in process.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSimpleTextControlState::InternalGetTextRepresentation

virtual MTextRepresentation * InternalGetTextRepresentation () const

Interface Category:

API.

Purpose:

Returns a pointer to the TSimpleTextStore object that contains the underlying text data for this text control state.

Calling Context:

Typically not called directly by clients.

Parameters:

Return Value:

A pointer to the TSimpleTextStore object that contains the underlying text data for this text control state.

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.
Copyright©1995 Taligent,Inc. All rights reserved.