AIGrid.h File Reference

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

Go to the source code of this file.

Classes
struct	AIGridSpacing
	Grid spacing information. More...
struct	AIGridSettings
	Grid settings information. More...
struct	AIGridSuite
	This suite allows you to access the grid settings for the current document. More...
Defines
#define	kAIGridSuite   "AI Grid Suite"
	Grid suite name.
#define	kAIGridSuiteVersion5   AIAPI_VERSION(5)
	Grid suite version.
#define	kAIGridSuiteVersion   kAIGridSuiteVersion5
	Grid suite version.
#define	kAIGridVersion   kAIGridSuiteVersion
	Grid suite version.
Typedefs
typedef ASErr ASAPI(*	AIGridLineProc )(void *data, AIRealPoint p0, AIRealPoint p1)
	Callback prototype for AIGridSuite::EnumGridLines(), which iterates over the grid lines that intersect a given rectangle.
typedef ASErr ASAPI(*	AIPageLineProc )(void *data, AIRealPoint p0, AIRealPoint p1)
	Callback prototype for AIGridSuite::EnumPageLines(), which iterates over the page tile lines that intersect a given rectangle.
Enumerations
enum	{ kAIGridStyleGraph = 0, kAIGridStyleDotted }
	Grid styles, graph or dotted. More...

---

Detailed Description

---

Define Documentation

#define kAIGridSuite   "AI Grid Suite"

Grid suite name.

#define kAIGridSuiteVersion   kAIGridSuiteVersion5

Grid suite version.

#define kAIGridSuiteVersion5   AIAPI_VERSION(5)

Grid suite version.

#define kAIGridVersion   kAIGridSuiteVersion

Grid suite version.

---

Typedef Documentation

typedef ASErr ASAPI(* AIGridLineProc)(void *data, AIRealPoint p0, AIRealPoint p1)

Callback prototype for AIGridSuite::EnumGridLines(), which iterates over the grid lines that intersect a given rectangle.

Parameters:

	data	The developer-defined data passed to the enumeration function.
	p0	The first point at which the current grid line intersects the rectangle.
	p1	The second point at which the current grid line intersects the rectangle.

typedef ASErr ASAPI(* AIPageLineProc)(void *data, AIRealPoint p0, AIRealPoint p1)

Callback prototype for AIGridSuite::EnumPageLines(), which iterates over the page tile lines that intersect a given rectangle.

Parameters:

	data	The developer-defined data passed to the enumeration function.
	p0	The first point at which the current page tile line intersects the rectangle.
	p1	The second point at which the current page tile line intersects the rectangle.

---

Enumeration Type Documentation

anonymous enum

Grid styles, graph or dotted.

Enumerator:

kAIGridStyleGraph	The grid is shown as graph lines.
kAIGridStyleDotted	The grid is shown as dots at intersection points.