Class: TClipboardTypes

Declaration: Clipboard.h

Class: TClipboardTypes::TClipboardTypesIterator

Declaration: Clipboard.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

TClipboardTypesIterator implements an iterator appropriate for iterating over a sequence of clipboard type descriptions.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None provided.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TClipboardTypesIterator::~TClipboardTypesIterator

~ TClipboardTypesIterator ()

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClipboardTypesIterator::TClipboardTypesIterator

TClipboardTypesIterator (TClipboardTypes * aliasedTypes)
TClipboardTypesIterator (const TClipboardTypesIterator & copyFrom)

Interface Category:

API.

Purpose:

Creates a new iterator for the specified TClipboardTypes object.
Copy constructor.

Calling Context:

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

Parameters:

TClipboardTypes * aliasedTypes -The TClipboardTypes object whose types shall be iterated over by the new iterator.
const TClipboardTypesIterator & copyFrom -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClipboardTypesIterator::operator=

TClipboardTypesIterator & operator =(const TClipboardTypesIterator & assignFrom)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const const TClipboardTypesIterator & assignFrom -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: TClipboardTypesIterator::First

const TTypeDescription * First ()

Interface Category:

API.

Purpose:

Returns the type description for the first set of data on the clipboard.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the type description for the first set of data on the clipboard.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClipboardTypesIterator::Next

const TTypeDescription * Next ()

Interface Category:

API.

Purpose:

Returns the type description for the next set of data on the clipboard.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the type description for the next set of data on the clipboard.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Class: TClipboardTypes

Declaration: Clipboard.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

TClipboardTypes object is a cache of the data types available from the clipboard. So anyone wanting to update appearance based on the types available in the clipboard can use this class and will benefit from several levels of caching of type information. This class is intended for the use of classes that want to investigate the clipboard without actually accepting the data on the clipboard. It is intended for use in conjunction with registering for clipboard changed notification. NOTE: All the data obtained via this interface is stale the moment you get it. The only way to get typedata followed by correct data is to use ClipboardHandle.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None provided.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TClipboardTypes::~TClipboardTypes

~ TClipboardTypes ()

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

TClipboardTypes ()
TClipboardTypes (TClipboardTypes & copy)

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.
TClipboardTypes & copy -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClipboardTypes::operator=

TClipboardTypes & operator =(const TClipboardTypes &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TClipboardTypes & -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: TClipboardTypes::Update

bool Update ()

Interface Category:

API.

Purpose:

Check if the type data contained in this object is accurate. If it isn't, this function updates the type data with the contents of the global clipboard.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns true if the data was updated.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClipboardTypes::IsTypeAvailable

bool IsTypeAvailable (const TTypeDescription & theType)

Interface Category:

API.

Purpose:

Determines whether or not the specified data type is available on the clipboard.

Calling Context:

You can call this function directly.

Parameters:

const TTypeDescription & theType -The type to check for on the global clipboard.

Return Value:

Returns true if the specified type is available on the clipboard.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClipboardTypes::IsAnyTypeAvailable

bool IsAnyTypeAvailable (const TCollectionOf < TTypeDescription > & possibleTypes)

Interface Category:

API.

Purpose:

Determines whether or not any of the types contained in the specified collection are available on the clipboard. This function stops searching after it's found a match.

Calling Context:

You can call this function directly.

Parameters:

const TCollectionOf < TTypeDescription > & possibleTypes -The collection of types to check for on the clipboard.

Return Value:

Returns true if at least one of the types contained in the specified collection is available on the global clipboard.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClipboardTypes::GetCurrentTypesAlias

const TSequenceOf < TTypeDescription > * GetCurrentTypesAlias () const

Interface Category:

API.

Purpose:

Returns the sequence of type descriptions in which this object has cached the clipboard's data types.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a const pointer to the sequence of type descriptions.

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.