Class: TScrapItemProvider

Declaration: ScrapItemProvider.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TSimpleScrapItemProvider

Purpose:

TScrapItemProvider is an abstract base class that defines the protocols for an object that provides data to the clipboard.

Instantiation:

Abstract base class; do not allocate.

Deriving Classes:

Provided classes include TSimpleScrapItemProvider. Derived classes must override the pure virtual functions: CopyAvailableTypes, and GiveAssociatedScrapTo.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TScrapItemProvider::~TScrapItemProvider

virtual ~ TScrapItemProvider ()

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: TScrapItemProvider::CopyAvailableTypes

virtual void CopyAvailableTypes (TSequenceOf < TTypeDescription > & collection, TMemoryHeap * whichHeap =NIL)

Interface Category:

API.

Purpose:

Copies the type descriptions for the data types available from this provider.

Calling Context:

You can call this function directly.

Parameters:

TSequenceOf < TTypeDescription > & collection -The sequence into which to place the available types.
TMemoryHeap * whichHeap =NIL -The heap in which to create the type descriptions placed in the sequence.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is a pure virtual function and must be overridden by classes deriving from TScrapItemProvider.

Member Function: TScrapItemProvider::GiveAssociatedScrapTo

virtual bool GiveAssociatedScrapTo (TTypeDescription & theType, MScrapAcceptor & theAcceptor)

Interface Category:

API.

Purpose:

Gives the data associated with the specified type to the specified acceptor.

Calling Context:

You can call this function directly.

Parameters:

TTypeDescription & theType -The data type chosen by the scrap acceptor.
MScrapAcceptor & theAcceptor -The acceptor to whom the data is to be given.

Return Value:

Returns true if the acceptor accepted the data.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is a pure virtual function and must be overridden by classes deriving from TScrapItemProvider.

Member Function: TScrapItemProvider::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The stream to which the object streams itself out.

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

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream from which the object streams itself in.

Return Value:

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

Exceptions:

Throws a TInvalidVersionError if the version of the object on the stream is unknown to the version of the shared library installed.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrapItemProvider::TScrapItemProvider

TScrapItemProvider ()
TScrapItemProvider (const TScrapItemProvider &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to copy an object.

Parameters:

Takes no parameters.
const TScrapItemProvider & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

TScrapItemProvider is an abstract base class--all the constructors are protected. Do not instantiate this class.

Member Function: TScrapItemProvider::operator=

TScrapItemProvider & operator =(const TScrapItemProvider &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TScrapItemProvider & -The object to be copied.

Return Value:

Returns a const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

TScrapItemProvider is an abstract base class--all the constructors are protected. Do not instantiate this class.

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