AIGridSuite Struct Reference
[API Suite List]

This suite allows you to access the grid settings for the current document. More...

#include <AIGrid.h>

List of all members.

Public Attributes
AIAPI AIErr(*	GetGridSettings )(AIGridSettings *settings)
	Retrieves the grid settings for the current document.
AIAPI AIErr(*	SetGridSettings )(AIGridSettings *settings)
	Sets the grid settings for the current document.
AIAPI AIErr(*	EnumGridLines )(AIDocumentViewHandle view, AIRealRect *rect, AIGridLineProc proc, void *data)
	Enumerates the grid lines that intersect a specified rectangle to the callback function that you provide.
AIAPI AIErr(*	EnumPageLines )(AIDocumentViewHandle view, AIRealRect *rect, AIPageLineProc proc, void *data)
	Enumerates the page tile lines that intersect a specified rectangle to the callback function that you provide.
AIAPI AIBoolean(*	IsVisible )(AIDocumentViewHandle view)
	Reports whether the grid is visible in a document view.
AIAPI AIBoolean(*	IsSnapOn )(AIDocumentViewHandle view)
	Reports whether snap-to-grid is turned on in a document view.

---

Detailed Description

This suite allows you to access the grid settings for the current document.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIGridSuite and kAIGridVersion.

---

Member Data Documentation

AIAPI AIErr(* AIGridSuite::EnumGridLines)(AIDocumentViewHandle view, AIRealRect *rect, AIGridLineProc proc, void *data)

Enumerates the grid lines that intersect a specified rectangle to the callback function that you provide.

Parameters:

	view	The document view.
	rect	A pointer to the rectangle of interest.
	proc	The callback procedure you have defined.
	data	Developer-defined data that is passed through to the callback.

AIAPI AIErr(* AIGridSuite::EnumPageLines)(AIDocumentViewHandle view, AIRealRect *rect, AIPageLineProc proc, void *data)

Enumerates the page tile lines that intersect a specified rectangle to the callback function that you provide.

Parameters:

	view	The document view.
	rect	A pointer to the rectangle of interest.
	proc	The callback procedure you have defined.
	data	Developer-defined data that is passed through to the callback.

AIAPI AIErr(* AIGridSuite::GetGridSettings)(AIGridSettings *settings)

Retrieves the grid settings for the current document.

Parameters:

settings

[out] A buffer in which to return the settings.

AIAPI AIBoolean(* AIGridSuite::IsSnapOn)(AIDocumentViewHandle view)

Reports whether snap-to-grid is turned on in a document view.

(Note that this function returns a boolean value, not an error code.)

Parameters:

view

The document view.

Returns:

True if snap-to-grid is on.

AIAPI AIBoolean(* AIGridSuite::IsVisible)(AIDocumentViewHandle view)

Reports whether the grid is visible in a document view.

(Note that this function returns a boolean value, not an error code.)

Parameters:

view

The document view.

Returns:

True if the grid is visible.

AIAPI AIErr(* AIGridSuite::SetGridSettings)(AIGridSettings *settings)

Sets the grid settings for the current document.

Parameters:

settings

A pointer to a structure that you have filled with the new settings..

---

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

• AIGrid.h