Class: TSimpleScrapItemProvider

Declaration: SimpleScrapItemProvider.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TScrapItemProvider

Inherited By:

None.

Purpose:

TSimpleScrapItemProvider derives from TScrapItemProvider and implements a concrete object that provides data to the clipboard.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None provided.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

All protected functions, including InternalConstructDictionary, InternalConstructSet, InternalDestruct, and InternalAdoptScrapItem, should be treated as private. They will be private in the next CommonPoint application system release.

Member Function: TSimpleScrapItemProvider::~TSimpleScrapItemProvider

virtual ~ TSimpleScrapItemProvider ()

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

TSimpleScrapItemProvider (TScrapItem * adoptItem)
TSimpleScrapItemProvider (TCollectionOf < TScrapItem > & adoptItems)
TSimpleScrapItemProvider (const TSimpleScrapItemProvider &)

Interface Category:

API.

Purpose:

Creates a new scrap item provider that provides the specified scrap item to the clipboard.
Creates a new scrap item provider that provides the specified collection of scrap items to the clipboard.
Copy constructor

Calling Context:

You can call this function directly.
You can call this function directly.
Called to copy an object.

Parameters:

TScrapItem * adoptItem -The scrap item provided by the new object.
TCollectionOf < TScrapItem > & adoptItems -The collection of scrap items provided by the new object.
const TSimpleScrapItemProvider & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSimpleScrapItemProvider::operator=

TSimpleScrapItemProvider & operator =(const TSimpleScrapItemProvider &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TSimpleScrapItemProvider & -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:

None.

Member Function: TSimpleScrapItemProvider::AdoptAdditionalScrapItem

void AdoptAdditionalScrapItem (TScrapItem * adoptItem)

Interface Category:

API.

Purpose:

Adopts the specified scrap item. If this provider has a single scrap item, it is replaced with the new one, and deleted. Otherwise, the new item is added to the collection.

Calling Context:

You can call this function directly.

Parameters:

TScrapItem * adoptItem -The scrap item to be adopted.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSimpleScrapItemProvider::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:

None.

Member Function: TSimpleScrapItemProvider::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:

None.

Member Function: TSimpleScrapItemProvider::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: TSimpleScrapItemProvider::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

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

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