Class: TClipboardHandle

Declaration: Clipboard.h

Taxonomy Categories:

Member Functions:


Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

The clipboard is a unique entity. TClipboardHandle refers to the unique underlying clipboard.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None provided.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TClipboardHandle::TClipboardHandle

TClipboardHandle ()

Interface Category:

API.

Purpose:

Default constructor.

Calling Context:

Called by the stream-in operators.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClipboardHandle::~TClipboardHandle

~ TClipboardHandle ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClipboardHandle::AdoptNewProvider

void AdoptNewProvider (TScrapItemProvider * adoptedProvider)

Interface Category:

API.

Purpose:

Adopts the specified provider to provide data to the clipboard when necessary.

Calling Context:

You can call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClipboardHandle::OfferDataTo

bool OfferDataTo (MScrapNegotiator & theScrapAcceptor)

Interface Category:

API.

Purpose:

Offers the clipboard data (contained by the provider) to the specified acceptor.

Calling Context:

You can call this function directly.

Parameters:

Return Value:

Returns true if the acceptor accepts the data.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClipboardHandle::CreateChangeInterest

TClipboardChangedInterest * CreateChangeInterest (TMemoryHeap * whichHeap =NIL)

Interface Category:

API.

Purpose:

Creates a new interest object used to register interest and notify clients in the event when the data within the clipboard changes.

Calling Context:

You can call this function directly.

Parameters:

Return Value:

Returns the newly created interest object.

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.
Copyright©1995 Taligent,Inc. All rights reserved.