Class: TTextStoreInterest

Declaration: SimpleTextNotification.h

Taxonomy Categories:

Member Functions:

TTextStoreInterest
~TTextStoreInterest
operator=
operator>>=
operator<<=
Hash

Interface Category:

API.

Inherits From:

TInterest

Inherited By:

None.

Purpose:

TTextStoreInterest is derived from TInterest. A TTextStoreInterest object is needed to register for notification of changes to the text store.

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

TTextStoreInterest (const TGlobalID & textStoreID, const TToken & theName)
TTextStoreInterest (const TTextStoreInterest &)
TTextStoreInterest ()

Interface Category:

API.

Purpose:

Constructs a text store interest with the specified text store ID and token name.
Copy constructor.
Default constructor.

Calling Context:

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

Parameters:

const TGlobalID & textStoreID -The text store ID.
const TToken & theName -The token name.
const TTextStoreInterest & -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: TTextStoreInterest::~TTextStoreInterest

virtual ~ TTextStoreInterest ()

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

const TTextStoreInterest & operator =(const TTextStoreInterest &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

May be called directly by clients.

Parameters:

const TTextStoreInterest & -The source object for the 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: TTextStoreInterest::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

May be called directly by clients.

Parameters:

TStream & -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: TTextStoreInterest::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

May be called directly by clients.

Parameters:

TStream & -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.

Member Function: TTextStoreInterest::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Overrides inherited MCollectible function.

Calling Context:

May be called directly by clients.

Parameters:

Takes no parameters.

Return Value:

The numeric value of the hash, a long.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited MCollectible function.

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