Class: TInsertTextNotification

Declaration: TextNotificationCore.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTextNotification

Inherited By:

None.

Purpose:

TInsertTextNotification is a derived class of TTextNotification. It is used when text has been inserted, and adds an array which indicates how many characters are inserted at each position in the selection. This is necessary because multiple, discontiguous selection is supported.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is designed to be used directly.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TInsertTextNotification::TInsertTextNotification

TInsertTextNotification (const TInterest &, const TTextArea &, EActionType, TTextCount , TPseudoTimeStamp)
TInsertTextNotification (const TInterest &, const TTextArea &, EActionType, const TPrimitiveTypeArray < TTextCount > &, TPseudoTimeStamp)
TInsertTextNotification (const TInsertTextNotification &)
TInsertTextNotification ()

Interface Category:

API.

Purpose:

Constructs a TInsertTextNotification object, specifying the interest, the modified selection, the type of change, a count specifying the number of characters inserted, and the time stamp indicating when the change occurred.
Constructs a TInsertTextNotification object, specifying the interest, the modified selection, the type of change, an array indicating how many characters are inserted at each position in the selection, and the time stamp indicating when the change occurred.
Copy constructor.
Default constructor. This constructor is protected.

Calling Context:

May be called directly by clients.
May be called directly by clients.
May be called directly by clients.
May be called directly by clients.

Parameters:

const TInterest & -The interest, identifying the sender of the notification.
const TTextArea & -The selection on which the change occurred.
EActionType -The type of change that occurred.
TTextCount -Count indicating the number of characters inserted.
TPseudoTimeStamp -The time stamp specifying when the change occurred.
const TInterest & -The interest, identifying the sender of the notification.
const TTextArea & -The selection on which the change occurred.
EActionType -The type of change that occurred.
const TPrimitiveTypeArray < TTextCount > & -The array indicating how many characters are inserted at each position in a selection.
TPseudoTimeStamp -The time stamp specifying when the change occurred.
const TInsertTextNotification & -The object to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TInsertTextNotification::~TInsertTextNotification

virtual ~ TInsertTextNotification ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Typically not called directly by clients.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TInsertTextNotification::operator=

TInsertTextNotification & operator =(const TInsertTextNotification &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

May be called directly by clients.

Parameters:

const TInsertTextNotification & -The source object for this 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: TInsertTextNotification::GetInsertionCountArray

virtual TPrimitiveTypeArray < TTextCount > GetInsertionCountArray () const

Interface Category:

API.

Purpose:

Returns a copy of the array indicating the number of characters inserted at each position in the selection. Called by notification recipients after the notification to determine the number of characters inserted at each position in the selection.

Calling Context:

May be called directly by clients.

Parameters:

Takes no parameters.

Return Value:

A new TPrimitiveTypeArray<TTextCount> object indicating the number of characters inserted at each position in the selection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TInsertTextNotification::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

May be called directly by clients.

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

virtual TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

May be called directly by clients.

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.

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