AIAnnotator.h File Reference

#include "AITypes.h"
#include "AIDocumentView.h"
#include "AIFixedMath.h"
#include "AIRealMath.h"
#include "AIPlugin.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIUpdateBezier
	Not used. More...
struct	AIAnnotatorMessage
	A plug-in that has registered an annotator receives this message with kSelectorAIInvalAnnotation and kSelectorAIDrawAnnotation. More...
struct	AIAnnotatorSuite
	The annotator suite allows plug-ins to draw annotations into the document window that are not a part of the artwork. More...
Defines
#define	kAIAnnotatorSuite   "AI Annotator Suite"
#define	kAIAnnotatorSuiteVersion6   AIAPI_VERSION(6)
#define	kAIAnnotatorSuiteVersion   kAIAnnotatorSuiteVersion6
#define	kAIAnnotatorVersion   kAIAnnotatorSuiteVersion
#define	kCallerAIAnnotation   "AI Annotation"
	The annotation caller.
#define	kSelectorAIDrawAnnotation   "AI Draw"
	Sent when the plug-in implementing a plug-in annotator should draw its annotations.
#define	kSelectorAIInvalAnnotation   "AI Invalidate"
	Sent when the plug-in implementing a plug-in annotator should invalidate the regions occupied by its annotations.
#define	kAnnotateNothing   0
	Update type for the kSelectorAIInvalAnnotation message.
#define	kAnnotateBetaObject   1
	Not used.
#define	kAnnotateBetaObjects   2
	Not used.
#define	kAnnotateBeziers   3
	Not used.
#define	kAnnotateText   4
	Not used.
#define	kAnnotateArtObject   5
	Update type for the kSelectorAIDrawAnnotation message.
#define	kAnnotateNoPortType   0
	Port type for the kSelectorAIInvalAnnotation message.
#define	kAnnotateWindowPortType   1
	Port type for the kSelectorAIDrawAnnotation message.
#define	kAnnotateGWorldPortType   2
	Not used.
Typedefs
typedef struct _t_AIAnnotatorOpaque *	AIAnnotatorHandle
	This is a reference to an annotator.
typedef ai::int32	AIAnnotatorOptionsFlags
Enumerations
enum	AIAnnotatorOptionsFlagValues { kDrawBeforeAllOthers = 1, kDrawOnInactiveDocuments = 1<<1, kDontDrawOnInactiveView = 1<<2, AIAnnotatorOptionsFlagValuesDummy = 0xFFFFFFFF }
	Bit flag values for annotators, which determine how an annotation is drawn. More...

---

Detailed Description

---

Define Documentation

#define kAIAnnotatorSuite   "AI Annotator Suite"

#define kAIAnnotatorSuiteVersion   kAIAnnotatorSuiteVersion6

#define kAIAnnotatorSuiteVersion6   AIAPI_VERSION(6)

#define kAIAnnotatorVersion   kAIAnnotatorSuiteVersion

#define kAnnotateArtObject   5

Update type for the kSelectorAIDrawAnnotation message.

#define kAnnotateBetaObject   1

Not used.

#define kAnnotateBetaObjects   2

Not used.

#define kAnnotateBeziers   3

Not used.

#define kAnnotateGWorldPortType   2

Not used.

#define kAnnotateNoPortType   0

Port type for the kSelectorAIInvalAnnotation message.

#define kAnnotateNothing   0

Update type for the kSelectorAIInvalAnnotation message.

#define kAnnotateText   4

Not used.

#define kAnnotateWindowPortType   1

Port type for the kSelectorAIDrawAnnotation message.

---

Typedef Documentation

typedef struct _t_AIAnnotatorOpaque* AIAnnotatorHandle

This is a reference to an annotator.

It is never dereferenced.

typedef ai::int32 AIAnnotatorOptionsFlags

---

Enumeration Type Documentation

enum AIAnnotatorOptionsFlagValues

Bit flag values for annotators, which determine how an annotation is drawn.

See also:

AIAnnotatorSuite::SetAnnotatorOptions()

Enumerator:

kDrawBeforeAllOthers	Send notification to this annotator before other annotators, but after selection.
kDrawOnInactiveDocuments	Send notification for inactive documents. By default notification is sent only to the active document.
kDontDrawOnInactiveView	Do not send notification for inactive views. By default notification is sent to all views.
AIAnnotatorOptionsFlagValuesDummy	Dummy value to ensure 32 bit enums.