AIClipboard.h File Reference

#include "AITypes.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIClipboardData
	Data used to register a clipboard format handler. More...
struct	AIClipboardMessage
	The message structure received when the clipboard format handler's main entry point receives a message with caller kCallerAIClipboard. More...
struct	AIClipboardSuite
	The clipboard suite enables plug-ins to register new clipboard format handlers. More...
Defines
#define	kAIClipboardSuite   "AI Clipboard Suite"
#define	kAIClipboardSuiteVersion5   AIAPI_VERSION(5)
#define	kAIClipboardSuiteVersion   kAIClipboardSuiteVersion5
#define	kAIClipboardVersion   kAIClipboardSuiteVersion
#define	kCallerAIClipboard   "AI Clipboard"
	The clipboard caller.
#define	kSelectorAIGoClipboard   "AI Go"
	Execute a clipboard operation.
#define	kSelectorAICanCopyClipboard   "AI Can Copy"
	Check if you can copy the data in the current document to your format.
#define	kSelectorAICloneClipboard   "AI Clone"
	Requests a duplicate of the data in the ClipboardData field of AIClipboardMessage, which is in a format your plug-in handles.
#define	kSelectorAIDisposeClipboard   "AI Dispose"
	Delete the data in the ClipboardData field of the AIClipboardMessage, which is in a format your plug-in handles.
#define	kCantCopyErr   'CLP?'
	Return from kSelectorAICanCopyClipboard if you cannot perform copy.
Typedefs
typedef struct _t_AIClipboardOpaque *	AIClipboardHandle
	Identifies a registered clipboard format handler.
typedef ai::uint32	DDType
	Identifies a resource type.
Enumerations
enum	AIClipboardFormatOptions { kClipboardCopy = (1<<1), kClipboardPaste = (1<<2), kClipboardCannotCopy = (1<<3) }
	Option flags for registering a clipboard format handler with AIClipboardSuite::AddClipboard(), specifies which operations are supported. More...

---

Detailed Description

---

Define Documentation

#define kAIClipboardSuite   "AI Clipboard Suite"

#define kAIClipboardSuiteVersion   kAIClipboardSuiteVersion5

#define kAIClipboardSuiteVersion5   AIAPI_VERSION(5)

#define kAIClipboardVersion   kAIClipboardSuiteVersion

---

Typedef Documentation

typedef struct _t_AIClipboardOpaque* AIClipboardHandle

Identifies a registered clipboard format handler.

typedef ai::uint32 DDType

Identifies a resource type.

---

Enumeration Type Documentation

enum AIClipboardFormatOptions

Option flags for registering a clipboard format handler with AIClipboardSuite::AddClipboard(), specifies which operations are supported.

Enumerator:

kClipboardCopy	This format knows how to copy to the clipboard.
kClipboardPaste	This format knows how to paste from the clipboard.
kClipboardCannotCopy	This format cannot copy data to the clipboard. If set, user cannot enable the preference for copying data on exit. This is needed because the kClipboardCopy flag is also used internally to track the state of the user preference.