AIClipboardSuite Struct Reference
[API Suite List]

The clipboard suite enables plug-ins to register new clipboard format handlers. More...

#include <AIClipboard.h>

List of all members.

Public Attributes
AIAPI AIErr(*	AddClipboard )(SPPluginRef self, AIClipboardData *data, ai::int32 options, AIClipboardHandle *Clipboard)
	Registers a new clipboard format handler.
AIAPI AIErr(*	RemoveClipboard )(AIClipboardHandle Clipboard)
	Unregisters a clipboard format handler.
AIAPI AIErr(*	GetClipboardName )(AIClipboardHandle Clipboard, const char **name)
	Retrieves the registered name of a clipboard format handler.
AIAPI AIErr(*	GetClipboardOleType )(AIClipboardHandle Clipboard, ai::int32 *OleType)
	Retrieves Windows OLE type of the data handled by the format handler.
AIAPI AIErr(*	GetClipboardPlugin )(AIClipboardHandle Clipboard, SPPluginRef *plugin)
	Retrieves the plug-in reference for the plug-in supplying the format handler.
AIAPI AIErr(*	GetClipboardType )(AIClipboardHandle Clipboard, DDType *uniqueType)
	Retrieves Mac OS resource type of the data handled by the format handler.
AIAPI AIErr(*	GetClipboardOptions )(AIClipboardHandle Clipboard, ai::int32 *options)
	Retrieves the options describing the capabilities of the format handler.
AIAPI AIErr(*	SetClipboardOptions )(AIClipboardHandle Clipboard, ai::int32 options)
	Sets the options describing the capabilities of the format handler.
AIAPI AIErr(*	CountClipboards )(ai::int32 *count)
	Counts the number of registered clipboard format handlers.
AIAPI AIErr(*	GetNthClipboard )(ai::int32 n, AIClipboardHandle *Clipboard)
	Retrieves a clipboard format handler by position index.

---

Detailed Description

The clipboard suite enables plug-ins to register new clipboard format handlers.

The handler's main entry point then receives messages requesting it to copy data to and from the clipboard as needed. The messages have caller kCallerAIClipboard. The possible selectors are:

• kSelectorAIGoClipboard
• kSelectorAICanCopyClipboard
• kSelectorAICloneClipboard
• kSelectorAIDisposeClipboard

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIClipboardSuite and kAIClipboardVersion.

---

Member Data Documentation

AIAPI AIErr(* AIClipboardSuite::AddClipboard)(SPPluginRef self, AIClipboardData *data, ai::int32 options, AIClipboardHandle *Clipboard)

Registers a new clipboard format handler.

Parameters:

	self	The plug-in.
	data	The types of clipboard data handled.
	options	The capabilities of the format handler. A logical OR of AIClipboardFormatOptions values.
	Clipboard	[out] A buffer in which to return the clipboard handler reference.

AIAPI AIErr(* AIClipboardSuite::CountClipboards)(ai::int32 *count)

Counts the number of registered clipboard format handlers.

Use with GetNthClipboard() to iterate through handlers.

Parameters:

count

[out] A buffer in which to return the number of handlers.

AIAPI AIErr(* AIClipboardSuite::GetClipboardName)(AIClipboardHandle Clipboard, const char **name)

Retrieves the registered name of a clipboard format handler.

Parameters:

	Clipboard	The clipboard handler reference.
	name	[out] A buffer in which to return the name.

AIAPI AIErr(* AIClipboardSuite::GetClipboardOleType)(AIClipboardHandle Clipboard, ai::int32 *OleType)

Retrieves Windows OLE type of the data handled by the format handler.

Parameters:

	Clipboard	The clipboard handler reference.
	OleType	[out] A buffer in which to return the OLE data type.

AIAPI AIErr(* AIClipboardSuite::GetClipboardOptions)(AIClipboardHandle Clipboard, ai::int32 *options)

Retrieves the options describing the capabilities of the format handler.

Parameters:

	Clipboard	The clipboard handler reference.
	options	[out] A buffer in which to return the capabilities of the format handler. A logical OR of AIClipboardFormatOptions values.

AIAPI AIErr(* AIClipboardSuite::GetClipboardPlugin)(AIClipboardHandle Clipboard, SPPluginRef *plugin)

Retrieves the plug-in reference for the plug-in supplying the format handler.

Parameters:

	Clipboard	The clipboard handler reference.
	plugin	[out] A buffer in which to return the plug-in reference.

AIAPI AIErr(* AIClipboardSuite::GetClipboardType)(AIClipboardHandle Clipboard, DDType *uniqueType)

Retrieves Mac OS resource type of the data handled by the format handler.

Parameters:

	Clipboard	The clipboard handler reference.
	uniqueType	[out] A buffer in which to return the data resource type.

AIAPI AIErr(* AIClipboardSuite::GetNthClipboard)(ai::int32 n, AIClipboardHandle *Clipboard)

Retrieves a clipboard format handler by position index.

Use with CountClipboards() to iterate through handlers.

Parameters:

	n	The index, in the range [0..numHandlers-1] .
	Clipboard	[out] A buffer in which to return the clipboard handler reference.

AIAPI AIErr(* AIClipboardSuite::RemoveClipboard)(AIClipboardHandle Clipboard)

Unregisters a clipboard format handler.

Parameters:

Clipboard

The clipboard handler reference.

AIAPI AIErr(* AIClipboardSuite::SetClipboardOptions)(AIClipboardHandle Clipboard, ai::int32 options)

Sets the options describing the capabilities of the format handler.

Parameters:

	Clipboard	The clipboard handler reference.
	options	The capabilities of the format handler. A logical OR of AIClipboardFormatOptions values.

---

The documentation for this struct was generated from the following file:

• AIClipboard.h