AIDocumentViewSuite Struct Reference
[API Suite List]

Use these functions to get and set properties of a document view, including the bounds, center, zoom, and screen mode. More...

#include <AIDocumentView.h>

List of all members.

Public Attributes
AIAPI AIErr(*	GetDocumentViewBounds )(AIDocumentViewHandle view, AIRealRect *bounds)
	Retrieves the bounds of a document view in artwork coordinates (that is, the portion of the artboard that is visible in the window).
AIAPI AIErr(*	GetDocumentViewCenter )(AIDocumentViewHandle view, AIRealPoint *center)
	Retrieves the center of a document view in artwork coordinates (that is, the point of the artboard that maps to the center of the window).
AIAPI AIErr(*	SetDocumentViewCenter )(AIDocumentViewHandle view, const AIRealPoint *center)
	Sets the point of the artboard that maps to the center of the window for a view.
AIAPI AIErr(*	GetDocumentViewZoom )(AIDocumentViewHandle view, AIReal *zoom)
	Retrieves the zoom factor for a view.
AIAPI AIErr(*	SetDocumentViewZoom )(AIDocumentViewHandle view, AIReal zoom)
	Sets the scale factor from artwork coordinates to window coordinates for a view.
AIAPI AIErr(*	ArtworkPointToViewPoint )(AIDocumentViewHandle view, const AIRealPoint artworkPoint, AIPoint viewPoint)
	Converts a point from artwork coordinates to view (window) coordinates.
AIAPI AIErr(*	ViewPointToArtworkPoint )(AIDocumentViewHandle view, const AIPoint viewPoint, AIRealPoint artworkPoint)
	Converts a point from view coordinates to artwork coordinates.
AIAPI AIErr(*	CountDocumentViews )(ai::int32 *count)
	Gets the number of open views for the current document.
AIAPI AIErr(*	GetNthDocumentView )(ai::int32 n, AIDocumentViewHandle *view)
	Retrieves a document view for the current document by position index.
AIAPI AIErr(*	FixedArtworkPointToViewPoint )(AIDocumentViewHandle view, const AIRealPoint artworkPoint, AIRealPoint viewPoint)
	Converts a point from artwork coordinates to view (window) coordinates.
AIAPI AIErr(*	FixedViewPointToArtworkPoint )(AIDocumentViewHandle view, const AIRealPoint viewPoint, AIRealPoint artworkPoint)
	Converts a point from view coordinates to artwork coordinates.
AIAPI AIErr(*	SetScreenMode )(AIDocumentViewHandle view, AIScreenMode mode)
	Sets the screen mode of a view.
AIAPI AIErr(*	GetScreenMode )(AIDocumentViewHandle view, AIScreenMode *mode)
	Retrieves the screen mode of a view.
AIAPI AIErr(*	GetPageTiling )(AIPageTiling *pageTiling)
	Retrieves the page tiling information that describes how the artwork is printed onto one or more pages.
AIAPI AIErr(*	GetTemplateVisible )(AIDocumentViewHandle view, AIBoolean *visible)
	Reports whether there is a visible template layer.
AIAPI AIErr(*	DocumentViewScrollDelta )(AIDocumentViewHandle view, AIRealPoint *delta)
	Scrolls a document window.
AIAPI AIErr(*	GetDocumentViewInvalidRect )(AIDocumentViewHandle view, AIRealRect *invalidRect)
	Retrieves a rectangle that encloses (at least) the portions of the viewed document that have been changed and so need to be redrawn.
AIAPI AIErr(*	SetDocumentViewInvalidRect )(AIDocumentViewHandle view, const AIRealRect *invalidRect)
	Sets the invalid rectangle for a view.
AIAPI AIErr(*	GetDocumentViewStyle )(AIDocumentViewHandle view, ai::int16 *style)
	Retrieves the display mode for a view.
AIAPI AIErr(*	SetDocumentViewInvalidDocumentRect )(AIDocumentViewHandle view, const AIRealRect *invalidRect)
	Sets the invalid rectangle for all views of a viewed document.
AIAPI AIErr(*	GetShowPageTiling )(AIBoolean *show)
	Reports whether page tiling is shown for the current view.
AIAPI AIErr(*	SetShowPageTiling )(AIBoolean show)
	Sets the page tiling mode for the current view.
AIAPI AIErr(*	GetGridOptions )(AIDocumentViewHandle view, AIBoolean show, AIBoolean snap)
	Retrieves grid options for a view.
AIAPI AIErr(*	SetGridOptions )(AIDocumentViewHandle view, AIBoolean show, AIBoolean snap)
	Sets grid options for a view.
AIAPI AIErr(*	GetShowTransparencyGrid )(AIDocumentViewHandle view, AIBoolean *show)
	Reports whether the transparency grid is shown in a view.
AIAPI AIErr(*	SetShowTransparencyGrid )(AIDocumentViewHandle view, AIBoolean show)
	Sets whether the transparency grid is shown in the view.
AIAPI AIErr(*	GetDocumentViewDocument )(AIDocumentViewHandle view, AIDocumentHandle *document)
	Retrieves the document displayed in a view.
AIAPI AIErr(*	ForceDocumentViewsOnScreen )(void)
	Forces all document views to not be obscured by the Control palette.
AIAPI AIErr(*	GetShowGuides )(AIDocumentViewHandle view, AIBoolean *show)
	Retrieves the visibility state of the guides.
AIAPI AIErr(*	SetShowGuides )(AIDocumentViewHandle view, AIBoolean show)
	Sets the visibility state of the guides.
AIAPI AIErr(*	GetShowEdges )(AIDocumentViewHandle view, AIBoolean *show)
	Retrieves the visibility state of the edges of the selection.
AIAPI AIErr(*	SetShowEdges )(AIDocumentViewHandle view, AIBoolean show)
	Sets the visibility state of the edges of the selection.
AIAPI AIErr(*	SaveImage )(AIDocumentViewHandle view, const ai::UnicodeString &saveFilename, const AIPoint &windowSize)
	Captures the contents of the view window (excluding scrollbars, etc.
AIAPI AIErr(*	IsArtboardRulerVisible )(const AIDocumentViewHandle view, AIBoolean *visible)
	Determines the current state of video rulers if they are visible or not.
AIAPI AIErr(*	SetArtboardRulerVisible )(const AIDocumentViewHandle view, const AIBoolean visible)
	Sets the video rulers visibility on or off.
AIAPI AIErr(*	CountOPPPlates )(AIDocumentViewHandle view, ai::int32 &count)
	Returns the number plates in the plate set for the view.
AIAPI AIErr(*	GetNthOPPPlate )(AIDocumentViewHandle view, ai::int32 n, ai::ColorSpace &plate)
	Get an identifier for the nth plate in the view's plate set.
AIAPI AIErr(*	GetOPPPlateState )(AIDocumentViewHandle view, const ai::ColorSpace &plate, AIBoolean &isOn)
	Get the visibility state for `plate` in the current view's plate state.
AIAPI AIErr(*	SetOPPPlateState )(AIDocumentViewHandle view, const ai::ColorSpace &plate, const AIBoolean isOn)
	Set the visibility state for `plate` in the current view's plate state.
AIAPI AIErr(*	SetDocumentViewStyle )(AIDocumentViewHandle view, ai::int16 style, ai::int16 mask)
	Sets the display mode for a view.
AIAPI AIErr(*	IsRulerInArtboardCoordinates )(const AIDocumentViewHandle view, ASBoolean *isYes)
	Determines whether the rulers are shown in Artboard co-ordinates.
AIAPI AIErr(*	UseArtboardCoordinatesInRuler )(const AIDocumentViewHandle view, const ASBoolean state)
	Sets the rulers to use Artboard co-ordinates.
AIAPI AIBoolean(*	IsGPUPreviewModeOn )(const AIDocumentViewHandle view)
	Returns whether GPU Preview mode is enabled for the view.
AIAPI AIErr(*	GetGPUPixel )(AIWindowRef window, AIPoint location, AIColor &color)
	Returns color value of location inside document window.
AIAPI AIErr(*	GetDocumentViewVisibleArea )(AIDocumentViewHandle view, AIRealRect *bounds)
	Returns the bounds of the area visible to the user, ie after excluding the area covered by ruler and isolation mode UI.

Detailed Description

Use these functions to get and set properties of a document view, including the bounds, center, zoom, and screen mode.

To operate on the current view, you can usually pass NULL for the view parameter. To get a view reference for the current view, pass 0 to AIDocumentViewSuite::GetNthDocumentView().

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIDocumentViewSuite and kAIDocumentViewVersion.

Member Data Documentation

AIAPI AIErr(* AIDocumentViewSuite::ArtworkPointToViewPoint)(AIDocumentViewHandle view, const AIRealPoint *artworkPoint, AIPoint *viewPoint)

Converts a point from artwork coordinates to view (window) coordinates.

The resulting view coordinate is rounded to the nearest pixel.

Parameters:

	view	The view reference, or `NULL` for the current view.
	artworkPoint	The point to convert, in artwork coordinates.
	viewPoint	[out] A buffer in which to return the converted point, in window coordinates.

See also:: FixedArtworkPointToViewPoint() (does not round)

AIAPI AIErr(* AIDocumentViewSuite::CountDocumentViews)(ai::int32 *count)

Gets the number of open views for the current document.

Use with GetNthDocumentView() to iterate through views.

Parameters:

count

[out] A buffer in which to return the number of views.

AIAPI AIErr(* AIDocumentViewSuite::CountOPPPlates)(AIDocumentViewHandle view, ai::int32 &count)

Returns the number plates in the plate set for the view.

The plate set is only relevant for OPP view mode.

Parameters:

	view	The view reference, or `NULL` for the current view.
	count	[out] The number of plates.

AIAPI AIErr(* AIDocumentViewSuite::DocumentViewScrollDelta)(AIDocumentViewHandle view, AIRealPoint *delta)

Scrolls a document window.

Parameters:

	view	The view reference, or `NULL` for the current view.
	delta	The vector by which to scroll, a horizontal and vertical distance in points.

AIAPI AIErr(* AIDocumentViewSuite::FixedArtworkPointToViewPoint)(AIDocumentViewHandle view, const AIRealPoint *artworkPoint, AIRealPoint *viewPoint)

Converts a point from artwork coordinates to view (window) coordinates.

Does not round the result.

Parameters:

	view	The view reference, or `NULL` for the current view.
	artworkPoint	The point to convert, in artwork coordinates.
	viewPoint	[out] A buffer in which to return the converted point, in window coordinates.

See also:: ArtworkPointToViewPoint() (rounds result to nearest pixel)

AIAPI AIErr(* AIDocumentViewSuite::FixedViewPointToArtworkPoint)(AIDocumentViewHandle view, const AIRealPoint *viewPoint, AIRealPoint *artworkPoint)

Converts a point from view coordinates to artwork coordinates.

Parameters:

	view	The view reference, or `NULL` for the current view.
	viewPoint	The point to convert, in window floating-point coordinates.
	artworkPoint	[out] A buffer in which to return the converted point, in artboard coordinates.

See also:: ViewPointToArtworkPoint() (takes pixel coordinate values)

AIAPI AIErr(* AIDocumentViewSuite::ForceDocumentViewsOnScreen)(void)

Forces all document views to not be obscured by the Control palette.

AIAPI AIErr(* AIDocumentViewSuite::GetDocumentViewBounds)(AIDocumentViewHandle view, AIRealRect *bounds)

Retrieves the bounds of a document view in artwork coordinates (that is, the portion of the artboard that is visible in the window).

Parameters:

	view	The view reference, or `NULL` for the current view.
	bounds	[out] A buffer in which to return the bounding box.

AIAPI AIErr(* AIDocumentViewSuite::GetDocumentViewCenter)(AIDocumentViewHandle view, AIRealPoint *center)

Retrieves the center of a document view in artwork coordinates (that is, the point of the artboard that maps to the center of the window).

Parameters:

	view	The view reference, or `NULL` for the current view.
	center	[out] A buffer in which to return the center point.

AIAPI AIErr(* AIDocumentViewSuite::GetDocumentViewDocument)(AIDocumentViewHandle view, AIDocumentHandle *document)

Retrieves the document displayed in a view.

Parameters:

	view	The view reference, or `NULL` for the current view.
	document	[out] A buffer in which to return the document reference.

AIAPI AIErr(* AIDocumentViewSuite::GetDocumentViewInvalidRect)(AIDocumentViewHandle view, AIRealRect *invalidRect)

Retrieves a rectangle that encloses (at least) the portions of the viewed document that have been changed and so need to be redrawn.

This rectangle is reset to be empty each time the kAIDocumentViewInvalidRectChangedNotifier is sent.

Parameters:

	view	The view reference, or `NULL` for the current view.
	invalidRect	[out] A buffer in which to return the invalid area, in artwork coordinates.

AIAPI AIErr(* AIDocumentViewSuite::GetDocumentViewStyle)(AIDocumentViewHandle view, ai::int16 *style)

Retrieves the display mode for a view.

Parameters:

	view	The view reference, or `NULL` for the current view.
	style	[out] A buffer in which to return the style, a logical OR of these bit flags: `kVsArtwork`, `kVsPreview`, `kVsRaster`, `kVsOpaque`, `kVsInk`

AIAPI AIErr(* AIDocumentViewSuite::GetDocumentViewVisibleArea)(AIDocumentViewHandle view, AIRealRect *bounds)

Returns the bounds of the area visible to the user, ie after excluding the area covered by ruler and isolation mode UI.

Parameters:

	view	The view reference, or `NULL` for the current view.
	bounds	[out] A buffer in which to return the bounding box.

AIAPI AIErr(* AIDocumentViewSuite::GetDocumentViewZoom)(AIDocumentViewHandle view, AIReal *zoom)

Retrieves the zoom factor for a view.

This is the scale factor from artwork coordinates to window coordinates.

Parameters:

	view	The view reference, or `NULL` for the current view.
	zoom	[out] A buffer in which to return the zoom factor, a percentage value where 1 is 100% (actual size), 0.5 is 50% and 2 is 200%.

AIAPI AIErr(* AIDocumentViewSuite::GetGPUPixel)(AIWindowRef window, AIPoint location, AIColor &color)

Returns color value of location inside document window.

If location or window does not correspond to any document window of AI which is in GPU preview mode, bad parameter error is returned Only implemented for windows platform.

AIAPI AIErr(* AIDocumentViewSuite::GetGridOptions)(AIDocumentViewHandle view, AIBoolean *show, AIBoolean *snap)

Retrieves grid options for a view.

Parameters:

	view	The view reference, or `NULL` for the current view.
	show	[out] A buffer in which to return true if the grid is visible.
	snap	[out] A buffer in which to return true if the snap-to-grid is on.

AIAPI AIErr(* AIDocumentViewSuite::GetNthDocumentView)(ai::int32 n, AIDocumentViewHandle *view)

Retrieves a document view for the current document by position index.

Use with CountDocumentViews() to iterate through views.

Parameters:

	n	The index, in the range `[1..numViews]`, or 0 to get the current view.
	view	[out] A buffer in which to return the view reference.

AIAPI AIErr(* AIDocumentViewSuite::GetNthOPPPlate)(AIDocumentViewHandle view, ai::int32 n, ai::ColorSpace &plate)

Get an identifier for the nth plate in the view's plate set.

Parameters:

	view	The view reference, or `NULL` for the current view.
	plate	[out] The plate identifier.

AIAPI AIErr(* AIDocumentViewSuite::GetOPPPlateState)(AIDocumentViewHandle view, const ai::ColorSpace &plate, AIBoolean &isOn)

Get the visibility state for plate in the current view's plate state.

Visibility is only recognized for OPP view mode.

Parameters:

	view	The view reference, or `NULL` for the current view.
	plate	Identifier for the plate to get the state of.
	isOn	[out] The current visibility state of `plate`.

AIAPI AIErr(* AIDocumentViewSuite::GetPageTiling)(AIPageTiling *pageTiling)

Retrieves the page tiling information that describes how the artwork is printed onto one or more pages.

Parameters:

pageTiling

[out] A buffer in which to return the tiling information.

AIAPI AIErr(* AIDocumentViewSuite::GetScreenMode)(AIDocumentViewHandle view, AIScreenMode *mode)

Retrieves the screen mode of a view.

In the UI, the screen mode is shown by icons at the bottom of the Tool palette.

Parameters:

	view	The view reference, or `NULL` for the current view.
	mode	[out] A buffer in which to return the screen mode.

AIAPI AIErr(* AIDocumentViewSuite::GetShowEdges)(AIDocumentViewHandle view, AIBoolean *show)

Retrieves the visibility state of the edges of the selection.

Parameters:

	view	The view reference, or `NULL` for the current view.
	show	True to make the edges visible, false to hide them.

AIAPI AIErr(* AIDocumentViewSuite::GetShowGuides)(AIDocumentViewHandle view, AIBoolean *show)

Retrieves the visibility state of the guides.

Parameters:

	view	The view reference, or `NULL` for the current view.
	show	[out] A buffer in which to return true if the guides are visible.

AIAPI AIErr(* AIDocumentViewSuite::GetShowPageTiling)(AIBoolean *show)

Reports whether page tiling is shown for the current view.

Each view has its own setting.

Parameters:

show

[out] A buffer in which to return true if page tiling is shown.

AIAPI AIErr(* AIDocumentViewSuite::GetShowTransparencyGrid)(AIDocumentViewHandle view, AIBoolean *show)

Reports whether the transparency grid is shown in a view.

Parameters:

	view	The view reference, or `NULL` for the current view.
	show	[out] A buffer in which to return true if the transparency grid is visible.

AIAPI AIErr(* AIDocumentViewSuite::GetTemplateVisible)(AIDocumentViewHandle view, AIBoolean *visible)

Reports whether there is a visible template layer.

Parameters:

	view	The view reference, or `NULL` for the current view.
	visible	[out] A buffer in which to return true if the template layer is shown.

AIAPI AIErr(* AIDocumentViewSuite::IsArtboardRulerVisible)(const AIDocumentViewHandle view, AIBoolean *visible)

Determines the current state of video rulers if they are visible or not.

Parameters:

	view	The view reference, or `NULL` for the current view.
	visible	True if the artboard rulers are visible, false otherwise.

AIAPI AIBoolean(* AIDocumentViewSuite::IsGPUPreviewModeOn)(const AIDocumentViewHandle view)

Returns whether GPU Preview mode is enabled for the view.

[WIN Only]

Parameters:

view The view reference, or NULL for the current view.

Returns:: True if Accelerated Preview mode is ON, false if CPU rendering mode is on.

AIAPI AIErr(* AIDocumentViewSuite::IsRulerInArtboardCoordinates)(const AIDocumentViewHandle view, ASBoolean *isYes)

Determines whether the rulers are shown in Artboard co-ordinates.

Parameters:

	view	The view reference, or `NULL` for the current view.
	isYes	True if the rulers are shown in Artboard co-ordinates, false otherwise.

AIAPI AIErr(* AIDocumentViewSuite::SaveImage)(AIDocumentViewHandle view, const ai::UnicodeString &saveFilename, const AIPoint &windowSize)

Captures the contents of the view window (excluding scrollbars, etc.

) to a TIFF file. Artboards are centered in window before capture.

Parameters:

	view	The view reference, or `NULL` for the current view.
	saveFilename	Full path and name of TIFF file to create.
	windowSize	Size to set window before capture. Will restore original window size before returning.

AIAPI AIErr(* AIDocumentViewSuite::SetArtboardRulerVisible)(const AIDocumentViewHandle view, const AIBoolean visible)

Sets the video rulers visibility on or off.

Parameters:

	view	The view reference, or `NULL` for the current view.
	visible	True if artboard ruler visibility is to be turned on, false otherwise.

AIAPI AIErr(* AIDocumentViewSuite::SetDocumentViewCenter)(AIDocumentViewHandle view, const AIRealPoint *center)

Sets the point of the artboard that maps to the center of the window for a view.

Parameters:

	view	The view reference, or `NULL` for the current view.
	center	The new center point.

AIAPI AIErr(* AIDocumentViewSuite::SetDocumentViewInvalidDocumentRect)(AIDocumentViewHandle view, const AIRealRect *invalidRect)

Sets the invalid rectangle for all views of a viewed document.

This is the area that encloses (at least) the portions of the viewed document that have been changed and so need to be redrawn in all views of that document.

Parameters:

	view	The view reference, or `NULL` for the current view.
	invalidRect	The new area, in artwork coordinates.

See also:: SetDocumentViewInvalidRect()

AIAPI AIErr(* AIDocumentViewSuite::SetDocumentViewInvalidRect)(AIDocumentViewHandle view, const AIRealRect *invalidRect)

Sets the invalid rectangle for a view.

This is the area that encloses (at least) the portions of the viewed document that have been changed and so need to be redrawn in the given view.

Parameters:

	view	The view reference, or `NULL` for the current view.
	invalidRect	The new area, in artwork coordinates.

See also:: GetDocumentViewInvalidRect(), SetDocumentViewInvalidDocumentRect()

AIAPI AIErr(* AIDocumentViewSuite::SetDocumentViewStyle)(AIDocumentViewHandle view, ai::int16 style, ai::int16 mask)

Sets the display mode for a view.

Currently these flags are mostly mutually exclusive. kVsInk only makes sense combined with kVsPreview. kVsArtwork, kVsPreview, and kVsRaster are mutually exclusive.

Parameters:

	view	The view reference, or `NULL` for the current view.
	style	A logical OR of these bit flags: `kVsArtwork`, `kVsPreview`, `kVsRaster`, `kVsOpaque`, `kVsInk`
	mask	A logical OR of the same bit values as style indicating which bits from style to change.

AIAPI AIErr(* AIDocumentViewSuite::SetDocumentViewZoom)(AIDocumentViewHandle view, AIReal zoom)

Sets the scale factor from artwork coordinates to window coordinates for a view.

The scale factor is silently clamped to lie between the minimum and maximum values supported (currently between 1/32 and 64). After adjusting the zoom, the document view center remains unchanged.

Parameters:

	view	The view reference, or `NULL` for the current view.
	zoom	The new zoom factor, a percentage value where 1 is 100% (actual size), 0.5 is 50% and 2 is 200%.

AIAPI AIErr(* AIDocumentViewSuite::SetGridOptions)(AIDocumentViewHandle view, AIBoolean show, AIBoolean snap)

Sets grid options for a view.

Parameters:

	view	The view reference, or `NULL` for the current view.
	show	True to make the grid visible, false to hide it.
	snap	True to turn snap-to-grid on, false to turn it off.

AIAPI AIErr(* AIDocumentViewSuite::SetOPPPlateState)(AIDocumentViewHandle view, const ai::ColorSpace &plate, const AIBoolean isOn)

Set the visibility state for plate in the current view's plate state.

Visibility is only recognized for OPP view mode. Invalid plate identifiers are ignored.

Parameters:

	view	The view reference, or `NULL` for the current view.
	plate	Identifier for the plate to get the state of.
	isOn	The new visibility state of `plate`.

AIAPI AIErr(* AIDocumentViewSuite::SetScreenMode)(AIDocumentViewHandle view, AIScreenMode mode)

Sets the screen mode of a view.

In the UI, the screen mode is selected with icons at the bottom of the Tool palette.

Parameters:

	view	The view reference, or `NULL` for the current view.
	mode	The new screen mode.

AIAPI AIErr(* AIDocumentViewSuite::SetShowEdges)(AIDocumentViewHandle view, AIBoolean show)

Sets the visibility state of the edges of the selection.

Parameters:

	view	The view reference, or `NULL` for the current view.
	show	True to make the edges visible, false to hide them.

AIAPI AIErr(* AIDocumentViewSuite::SetShowGuides)(AIDocumentViewHandle view, AIBoolean show)

Sets the visibility state of the guides.

Parameters:

	view	The view reference, or `NULL` for the current view.
	show	True to make the guides visible, false to hide them.

AIAPI AIErr(* AIDocumentViewSuite::SetShowPageTiling)(AIBoolean show)

Sets the page tiling mode for the current view.

Each view has its own setting.

Parameters:

show

True to turn page tiling on, false to turn it off.

AIAPI AIErr(* AIDocumentViewSuite::SetShowTransparencyGrid)(AIDocumentViewHandle view, AIBoolean show)

Sets whether the transparency grid is shown in the view.

Parameters:

	view	The view reference, or `NULL` for the current view.
	show	True to make the transparency grid visible, false to hide it.

AIAPI AIErr(* AIDocumentViewSuite::UseArtboardCoordinatesInRuler)(const AIDocumentViewHandle view, const ASBoolean state)

Sets the rulers to use Artboard co-ordinates.

Parameters:

	view	The view reference, or `NULL` for the current view.
	state	True if the rulers are shown in Artboard co-ordinates, false otherwise.

AIAPI AIErr(* AIDocumentViewSuite::ViewPointToArtworkPoint)(AIDocumentViewHandle view, const AIPoint *viewPoint, AIRealPoint *artworkPoint)

Converts a point from view coordinates to artwork coordinates.

Parameters:

	view	The view reference, or `NULL` for the current view.
	viewPoint	The point to convert, in window pixel coordinates.
	artworkPoint	[out] A buffer in which to return the converted point, in artboard coordinates.

See also:: FixedViewPointToArtworkPoint() (takes floating-point coordinate values)

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

AIDocumentView.h

AIDocumentViewSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIDocumentViewSuite Struct Reference
[API Suite List]