AIDocumentView.h File Reference

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

Go to the source code of this file.

Classes
struct	AIPageTiling
	The page tiling structure that describes how artwork is printed on one or more pages. More...
struct	AIDocumentViewSuite
	Use these functions to get and set properties of a document view, including the bounds, center, zoom, and screen mode. More...
Defines
#define	kAIDocumentViewSuite   "AI Document View Suite"
#define	kAIDocumentViewSuiteVersion14   AIAPI_VERSION(14)
#define	kAIDocumentViewSuiteVersion   kAIDocumentViewSuiteVersion14
#define	kAIDocumentViewVersion   kAIDocumentViewSuiteVersion
#define	kAIDocumentViewChangedNotifier   "AI Document View Changed Notifier"
	Sent when the document view changes.
#define	kAIDocumentViewInvalidRectChangedNotifier   "AI Document View Invalid Rect Changed Notifier"
	See AIDocumentViewSuite::GetDocumentViewInvalidRect().
#define	kAIDocumentViewStyleChangedNotifier   "AI Document View Style Changed Notifier"
	Sent when the document view style changes.
#define	kAIDocumentViewActiveViewChangedNotifier   "AI Document View Style Active View Changed Notifier"
	Sent when the active view switches from one view window to another.
#define	kAIDocumentViewOPPPlateStateChangedNotifier   "AI Document View Plate State Changed Notifier"
	Sent when the active view's plate set's state changes.
#define	kAIDocumentViewEdgesVisibilityChangeNotifier   "AI Document View Edges Visibility Change Notifier"
	Sent when the edges visibility on the document is toggled.
#define	kAIActiveDocViewTitleChangedNotifier   "AI Document View Title Changed Notifier"
	Sent when title of the active document view is changed.
#define	kAIDocViewTrimViewStateChangedNotifier   "AI Document View Trim View State Changed Notifier"
	Sent when the trim view state of a document is toggled.
#define	kAIDocViewRenderModeChangedNotifier   "AI Document View Render Mode Changed Notifier"
	Sent when Document view render mode is changed
#define	kVsArtwork   0x0001
	Outline mode view style; see AIDocumentViewSuite::GetDocumentViewStyle().
#define	kVsPreview   0x0002
	Preview mode view style; see AIDocumentViewSuite::GetDocumentViewStyle().
#define	kVsRaster   0x0040
	Pixel preview mode view style; see AIDocumentViewSuite::GetDocumentViewStyle().
#define	kVsOpaque   0x0080
	Unimplemented.
#define	kVsInk   0x0100
	OPP preview mode view style; see AIDocumentViewSuite::GetDocumentViewStyle().
Typedefs
typedef void *	AIDocumentPlatformViewBitmap
	The same as a Macintosh GWorldPtr.
typedef struct _t_AIDocumentViewOpaque *	AIDocumentViewHandle
	An opaque reference for a document view.
Enumerations
enum	AIScreenMode {   kNoScreenMode, kNormalScreenMode, kFullScreenWithMenuMode, kFullScreenNoMenuMode,   kAIPresentationMode, kDummyWindowMode = 0xffffffff }
	Screen mode values, see AIDocumentViewSuite::GetScreenMode(), AIDocumentViewSuite::SetScreenMode(). More...

---

Detailed Description

---

Define Documentation

#define kAIDocumentViewSuite   "AI Document View Suite"

#define kAIDocumentViewSuiteVersion   kAIDocumentViewSuiteVersion14

#define kAIDocumentViewSuiteVersion14   AIAPI_VERSION(14)

#define kAIDocumentViewVersion   kAIDocumentViewSuiteVersion

#define kAIDocViewRenderModeChangedNotifier   "AI Document View Render Mode Changed Notifier"

Sent when Document view render mode is changed

#define kAIDocViewTrimViewStateChangedNotifier   "AI Document View Trim View State Changed Notifier"

Sent when the trim view state of a document is toggled.

#define kVsArtwork   0x0001

Outline mode view style; see AIDocumentViewSuite::GetDocumentViewStyle().

#define kVsInk   0x0100

OPP preview mode view style; see AIDocumentViewSuite::GetDocumentViewStyle().

#define kVsOpaque   0x0080

Unimplemented.

Transparency attributes and masks are ignored.

#define kVsPreview   0x0002

Preview mode view style; see AIDocumentViewSuite::GetDocumentViewStyle().

#define kVsRaster   0x0040

Pixel preview mode view style; see AIDocumentViewSuite::GetDocumentViewStyle().

---

Typedef Documentation

typedef void* AIDocumentPlatformViewBitmap

The same as a Macintosh GWorldPtr.

Applies only to version 2 of this suite.

typedef struct _t_AIDocumentViewOpaque* AIDocumentViewHandle

An opaque reference for a document view.

---

Enumeration Type Documentation

enum AIScreenMode

Screen mode values, see AIDocumentViewSuite::GetScreenMode(), AIDocumentViewSuite::SetScreenMode().

Enumerator:

kNoScreenMode	Null mode, used only when there is no visible document.
kNormalScreenMode	The normal display mode. Multiple windows are visible.
kFullScreenWithMenuMode	A single view takes up the whole screen but the menu is visible.
kFullScreenNoMenuMode	A single view takes up the whole screen, the menu is not visible.
kAIPresentationMode	A single artboard takes up the whole screen, annotations are not visible.
kDummyWindowMode	Large dummy value ensures enum is 32-bits.