Class: TTextPresenterStateNotification

Declaration: DocumentTextNotification.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TNotification

Inherited By:

None.

Purpose:

TTextPresenterStateNotification, derived from TNotification, is used by the Text Editing Framework to allow a text presenter state object to inform any interested objects that data in the text presenter state object has changed. A TTextPresenterStateNotification is generated by a text presenter state object whenever the appearance data of the presenter is changed.

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: TTextPresenterStateNotification::TTextPresenterStateNotification

TTextPresenterStateNotification (const TPresenterStateReference psReference, EActionType)
TTextPresenterStateNotification (const TTextPresenterStateNotification &)
TTextPresenterStateNotification ()

Interface Category:

API.

Purpose:

Constructs a notification that references the changed presenter state and indicates the type of change.
Copy constructor.
Default constructor. This constructor is protected.

Calling Context:

May be called directly by clients.
May be called directly by clients.
Only for internal use by Resurrect. Developers should treat as protected.

Parameters:

const TPresenterStateReference psReference -A reference to the modified presenter state.
EActionType -The type of change that occurred.
const TTextPresenterStateNotification & -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: TTextPresenterStateNotification::~TTextPresenterStateNotification

virtual ~ TTextPresenterStateNotification ()

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

TTextPresenterStateNotification & operator =(const TTextPresenterStateNotification &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

May be called directly by clients.

Parameters:

const TTextPresenterStateNotification & -The object to assign to this 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: TTextPresenterStateNotification::GetActionType

virtual EActionType GetActionType () const

Interface Category:

API.

Purpose:

Returns an EActionType value indicating what type of change caused the text presenter state to generate this notification. Called to determine what type of change occurred on the text presenter state. Called by the view when it receives the notification. The view then knows what aspect of the presenter state was changed and it redraws only what is necessary to reflect that change.

Calling Context:

May be called directly by clients.

Parameters:

Takes no parameters.

Return Value:

An EActionType value indicating how the text presenter state was changed.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextPresenterStateNotification::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: TTextPresenterStateNotification::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.