AIArtboardSuite Struct Reference
[API Suite List]

This suite provides utilities that allow you to create and manipulate Artboards in a document. More...

#include <AIArtboard.h>

Public Attributes
AIAPI AIErr(*	Init )(ai::ArtboardProperties &artboard)
	Initializes an artboard properties object with default values.
AIAPI AIErr(*	CloneArtboard )(ai::ArtboardProperties &artboard, const ai::ArtboardProperties &newArtboard)
	Duplicates an artboard object.
AIAPI AIErr(*	Dispose )(ai::ArtboardProperties &properties)
	Disposes of an artboard properties object.
AIAPI AIErr(*	GetPosition )(const ai::ArtboardProperties &properties, AIRealRect &bounds)
	Retrieves the position and bounds of an artboard.
AIAPI AIErr(*	SetPosition )(ai::ArtboardProperties &properties, const AIRealRect &bounds)
	Modifies the position and bounds of an artboard.
AIAPI AIErr(*	GetPAR )(const ai::ArtboardProperties &properties, AIReal &par)
	Retrieves the pixel aspect ratio of the artboard ruler.
AIAPI AIErr(*	SetPAR )(ai::ArtboardProperties &properties, AIReal par)
	Modifies the pixel aspect ratio of the artboard ruler.
AIAPI AIErr(*	GetName )(const ai::ArtboardProperties &properties, ai::UnicodeString &name)
AIAPI AIErr(*	SetName )(ai::ArtboardProperties &properties, const ai::UnicodeString &name)
AIAPI AIErr(*	GetShowDisplayMark )(const ai::ArtboardProperties &properties, ai::ArtboardProperties::DisplayMarkType type, AIBoolean &show)
	Reports whether a particular type of artboard annotation is currently shown.
AIAPI AIErr(*	SetShowDisplayMark )(ai::ArtboardProperties &properties, ai::ArtboardProperties::DisplayMarkType type, AIBoolean show)
AIAPI AIErr(*	GetArtboardList )(ai::ArtboardList &artboardList)
	Retrieves the artboard list of the current document.
AIAPI AIErr(*	ReleaseArtboardList )(ai::ArtboardList &artboardList)
	Releases an artboard list object.
AIAPI AIErr(*	AddNew )(ai::ArtboardList &artboardList, ai::ArtboardProperties &newArtboard, ai::ArtboardID &index)
	Adds a new artboard to the current document and reports its index position in the artboard list.
AIAPI AIErr(*	Delete )(ai::ArtboardList &artboardList, ai::ArtboardID index)
	Deletes an artboard from an artboard list, and makes the next one in the list active.
AIAPI AIErr(*	GetCount )(const ai::ArtboardList &artboardList, ai::ArtboardID &count)
	Retrieves the number of artboards defined in an artboard list.
AIAPI AIErr(*	GetActive )(const ai::ArtboardList &artboardList, ai::ArtboardID &index)
	Retrieves the index position of the active artboard in the document's list.
AIAPI AIErr(*	SetActive )(ai::ArtboardList &artboardList, ai::ArtboardID index)
	Makes a specific artboard active, and makes it current in the iteration order.
AIAPI AIErr(*	Update )(ai::ArtboardList &artboardList, ai::ArtboardID index, const ai::ArtboardProperties &properties)
	Updates the properties of an artboard.
AIAPI AIErr(*	GetArtboardProperties )(ai::ArtboardList &artboardList, ai::ArtboardID index, ai::ArtboardProperties &properties)
	Retrieves the properties of an artboard from an artboard list.
AIAPI AIErr(*	GetRulerOrigin )(const ai::ArtboardProperties &properties, AIRealPoint &rulerOrigin)
	Retrieves the ruler origin of an artboard, relative to left-bottom corner.
AIAPI AIErr(*	SetRulerOrigin )(ai::ArtboardProperties &properties, const AIRealPoint &rulerOrigin)
	Sets the ruler origin of the artboard, relative to left-bottom corner.
AIAPI AIErr(*	Insert )(ai::ArtboardList &artboardList, ai::ArtboardProperties &artboard, ai::ArtboardID &index)
	Inserts a new Artboard at the specified location.
AIAPI AIErr(*	IsDefaultName )(const ai::ArtboardProperties &properties, AIBoolean &isDefault)
	Reports whether an artboard's current name is application-generated.
AIAPI AIErr(*	SetIsDefaultName )(ai::ArtboardProperties &properties, const AIBoolean &isDefault)
	Internal.
AIAPI AIErr(*	IsSelected )(const ai::ArtboardProperties &properties, AIBoolean &isSelected)
	Query artboard selection.
AIAPI AIErr(*	SelectArtboard )(ai::ArtboardList &artboardList, ai::ArtboardID artboardID, AIBoolean exclusively)
	Select one artboard.
AIAPI AIErr(*	SelectArtboards )(ai::ArtboardList &artboardList, const ai::AutoBuffer< ai::ArtboardID > &artboardIDs, AIBoolean exclusively)
	Select multiple artboards.
AIAPI AIErr(*	SelectAllArtboards )(ai::ArtboardList &artboardList)
	Select all artboards.
AIAPI AIErr(*	DeleteArtboards )(ai::ArtboardList &artboardList, const ai::AutoBuffer< ai::ArtboardID > &artboardIDs)
	Delete set of artboards.
AIAPI AIErr(*	DeselectArtboard )(ai::ArtboardList &artboardList, ai::ArtboardID artboardID)
	Deselect an artboard.
AIAPI AIErr(*	DeselectAllArtboards )(ai::ArtboardList &artboardList)
	Deselect all artboards.
AIAPI AIErr(*	AreAnyArtboardsOverlapping )(ai::ArtboardList &artboardList, AIBoolean &isOverlapping)

Detailed Description

This suite provides utilities that allow you to create and manipulate Artboards in a document.

A document is associated with an ArtboardList object that contains multiple Artboard objects, each of which is associated with and ArtboardProperties object.

Note:: It is recommended that you use the wrapper class, ai::ArtboardProperties and ai::ArtboardList rather than calling these functions directly.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIArtboardSuite and kAIArtboardSuiteVersion.

Member Data Documentation

AIAPI AIErr(* AIArtboardSuite::AddNew)(ai::ArtboardList &artboardList, ai::ArtboardProperties &newArtboard, ai::ArtboardID &index)

Adds a new artboard to the current document and reports its index position in the artboard list.

Parameters:

	artboardList	The artboard list object.
	newArtboard	The new artboard's properties object.
	index	[out] A buffer in which to return the 0-based index position of the new artboard.

Returns:: The error kAIExceededMaxArtboardLimitErr if list size exceeds the application-defined limit.

Referenced by ai::ArtboardList::AddNew().

AIAPI AIErr(* AIArtboardSuite::AreAnyArtboardsOverlapping)(ai::ArtboardList &artboardList, AIBoolean &isOverlapping)

AIAPI AIErr(* AIArtboardSuite::CloneArtboard)(ai::ArtboardProperties &artboard, const ai::ArtboardProperties &newArtboard)

Duplicates an artboard object.

Parameters:

	artboard	The artboard properties object to clone.
	newArtboard	[out] A buffer in which to return the new artboard properties object.

Referenced by ai::ArtboardProperties::ArtboardProperties().

AIAPI AIErr(* AIArtboardSuite::Delete)(ai::ArtboardList &artboardList, ai::ArtboardID index)

Deletes an artboard from an artboard list, and makes the next one in the list active.

The last artboard cannot be deleted.

Parameters:

	artboardList	The artboard list object.
	index	The 0-based index position of the artboard to delete from the list.

Returns:: The error kAICantDeleteLastArtboardErr if you attempt to delete the last artboard.

Referenced by ai::ArtboardList::Delete().

AIAPI AIErr(* AIArtboardSuite::DeleteArtboards)(ai::ArtboardList &artboardList, const ai::AutoBuffer< ai::ArtboardID > &artboardIDs)

Delete set of artboards.

Parameters:

	artboardList	The ArtboardList object.
	artboardIDs	The artboards to delete.

Referenced by ai::ArtboardList::Delete().

AIAPI AIErr(* AIArtboardSuite::DeselectAllArtboards)(ai::ArtboardList &artboardList)

Deselect all artboards.

Parameters:

artboardList

The ArtboardList object.

Referenced by ai::ArtboardList::DeselectAll().

AIAPI AIErr(* AIArtboardSuite::DeselectArtboard)(ai::ArtboardList &artboardList, ai::ArtboardID artboardID)

Deselect an artboard.

Parameters:

	artboardList	The ArtboardList object.
	artboardID	The artboard to de-select.

Referenced by ai::ArtboardList::Deselect().

AIAPI AIErr(* AIArtboardSuite::Dispose)(ai::ArtboardProperties &properties)

Disposes of an artboard properties object.

Parameters:

artboard

The artboard properties object.

Referenced by ai::ArtboardProperties::~ArtboardProperties().

AIAPI AIErr(* AIArtboardSuite::GetActive)(const ai::ArtboardList &artboardList, ai::ArtboardID &index)

Retrieves the index position of the active artboard in the document's list.

Parameters:

	artboardList	The artboard list object.
	index	[out] A buffer in which to return the 0-based index of the active artboard, or -1 if there are no artboards in the current document.

Referenced by ai::ArtboardList::GetActive().

AIAPI AIErr(* AIArtboardSuite::GetArtboardList)(ai::ArtboardList &artboardList)

Retrieves the artboard list of the current document.

Parameters:

artboardList

[out] A buffer in which to return the artboard list object.

Referenced by ai::ArtboardList::ArtboardList().

AIAPI AIErr(* AIArtboardSuite::GetArtboardProperties)(ai::ArtboardList &artboardList, ai::ArtboardID index, ai::ArtboardProperties &properties)

Retrieves the properties of an artboard from an artboard list.

Use with GetCount() and Update() to modify an artboard without changing which artboard is active in the document.

Parameters:

	artboardList	The artboard list object.
	index	The 0-based index position of the artboard in the list.
	properties	[out] A buffer in which to return the artboard properties object. On error, returns an invalid object

Referenced by ai::ArtboardList::GetArtboardProperties().

AIAPI AIErr(* AIArtboardSuite::GetCount)(const ai::ArtboardList &artboardList, ai::ArtboardID &count)

Retrieves the number of artboards defined in an artboard list.

Parameters:

	artboardList	The artboard list object.
	count	[out] A buffer in which to return the number of artboards.

Referenced by ai::ArtboardList::GetCount().

AIAPI AIErr(* AIArtboardSuite::GetName)(const ai::ArtboardProperties &properties, ai::UnicodeString &name)

Referenced by ai::ArtboardProperties::GetName().

AIAPI AIErr(* AIArtboardSuite::GetPAR)(const ai::ArtboardProperties &properties, AIReal &par)

Retrieves the pixel aspect ratio of the artboard ruler.

Parameters:

	properties	The artboard properties object.
	par	[out] A buffer in which to return the pixel aspect ratio.

Referenced by ai::ArtboardProperties::GetPAR().

AIAPI AIErr(* AIArtboardSuite::GetPosition)(const ai::ArtboardProperties &properties, AIRealRect &bounds)

Retrieves the position and bounds of an artboard.

Parameters:

	properties	The artboard properties object.
	bounds	[out] A rectangle object in which to return the position and bounds of the artboard.

Referenced by ai::ArtboardProperties::GetPosition().

AIAPI AIErr(* AIArtboardSuite::GetRulerOrigin)(const ai::ArtboardProperties &properties, AIRealPoint &rulerOrigin)

Retrieves the ruler origin of an artboard, relative to left-bottom corner.

Parameters:

	properties	The artboard properties object.
	rulerOrigin	[out] A buffer in which to return ruler origin.

Referenced by ai::ArtboardProperties::GetRulerOrigin().

AIAPI AIErr(* AIArtboardSuite::GetShowDisplayMark)(const ai::ArtboardProperties &properties, ai::ArtboardProperties::DisplayMarkType type, AIBoolean &show)

Reports whether a particular type of artboard annotation is currently shown.

Parameters:

	properties	The artboard properties object.
	type	The annotation type.
	show	A buffer in which to return true if the type is shown, false if it is hidden.

Referenced by ai::ArtboardProperties::GetShowDisplayMark().

AIAPI AIErr(* AIArtboardSuite::Init)(ai::ArtboardProperties &artboard)

Initializes an artboard properties object with default values.

Parameters:

artboard

The artboard properties object.

Referenced by ai::ArtboardProperties::ArtboardProperties().

AIAPI AIErr(* AIArtboardSuite::Insert)(ai::ArtboardList &artboardList, ai::ArtboardProperties &artboard, ai::ArtboardID &index)

Inserts a new Artboard at the specified location.

Parameters:

	artboardList	The ArtboardList object.
	artboard	The new artboard's properties.
	index	0-based index position of the new artboard.

Returns:: The error kAIExceededMaxArtboardLimitErr if maximum number of allowed artboards is exceeded.

Referenced by ai::ArtboardList::Insert().

AIAPI AIErr(* AIArtboardSuite::IsDefaultName)(const ai::ArtboardProperties &properties, AIBoolean &isDefault)

Reports whether an artboard's current name is application-generated.

When this is the case, and the user chooses to export art as JPEG, and to save artboards as separate files, the files are distinguished only by number, rather than the full generated name; for example, myArt-01.jpg. When an artboard name has been explicitly set, that name is used in the exported JPEG filename.

Parameters:

	properties	The artboard properties object.
	isDefault	A buffer in which to return true if the name is generated, false if it has been explicitly set.

Referenced by ai::ArtboardProperties::IsDefaultName().

AIAPI AIErr(* AIArtboardSuite::IsSelected)(const ai::ArtboardProperties &properties, AIBoolean &isSelected)

Query artboard selection.

Parameters:

	properties	The artboard properties object.
	isSelected	[out] A buffer in which to return the selection

Referenced by ai::ArtboardProperties::IsSelected().

AIAPI AIErr(* AIArtboardSuite::ReleaseArtboardList)(ai::ArtboardList &artboardList)

Releases an artboard list object.

Parameters:

artboardList

The artboard list object.

Referenced by ai::ArtboardList::~ArtboardList().

AIAPI AIErr(* AIArtboardSuite::SelectAllArtboards)(ai::ArtboardList &artboardList)

Select all artboards.

Parameters:

artboardList

The ArtboardList object.

Referenced by ai::ArtboardList::SelectAll().

AIAPI AIErr(* AIArtboardSuite::SelectArtboard)(ai::ArtboardList &artboardList, ai::ArtboardID artboardID, AIBoolean exclusively)

Select one artboard.

Parameters:

	artboardList	The ArtboardList object.
	artboardID	The artboard to select.
	exclusively	if true, clear existing selection first.

Referenced by ai::ArtboardList::Select().

AIAPI AIErr(* AIArtboardSuite::SelectArtboards)(ai::ArtboardList &artboardList, const ai::AutoBuffer< ai::ArtboardID > &artboardIDs, AIBoolean exclusively)

Select multiple artboards.

Parameters:

	artboardList	The ArtboardList object.
	artboardIDs	The artboards to select.
	exclusively	if true, clear existing selection first.

Referenced by ai::ArtboardList::Select().

AIAPI AIErr(* AIArtboardSuite::SetActive)(ai::ArtboardList &artboardList, ai::ArtboardID index)

Makes a specific artboard active, and makes it current in the iteration order.

Parameters:

	artboardList	The artboard list object.
	index	The 0-based index position of the artboard in the list.

Referenced by ai::ArtboardList::SetActive().

AIAPI AIErr(* AIArtboardSuite::SetIsDefaultName)(ai::ArtboardProperties &properties, const AIBoolean &isDefault)

Internal.

Do not use.

Referenced by ai::ArtboardProperties::SetIsDefaultName().

AIAPI AIErr(* AIArtboardSuite::SetName)(ai::ArtboardProperties &properties, const ai::UnicodeString &name)

Referenced by ai::ArtboardProperties::SetName().

AIAPI AIErr(* AIArtboardSuite::SetPAR)(ai::ArtboardProperties &properties, AIReal par)

Modifies the pixel aspect ratio of the artboard ruler.

Call AIArtboardSuite::Update() with this object to make the change.

Parameters:

	properties	The artboard properties object.
	par	The new pixel aspect ratio.

Referenced by ai::ArtboardProperties::SetPAR().

AIAPI AIErr(* AIArtboardSuite::SetPosition)(ai::ArtboardProperties &properties, const AIRealRect &bounds)

Modifies the position and bounds of an artboard.

Call AIArtboardSuite::Update() with this object to make the change.

Parameters:

	properties	The artboard properties object.
	bounds	The new position and bounds.

Referenced by ai::ArtboardProperties::SetPosition().

AIAPI AIErr(* AIArtboardSuite::SetRulerOrigin)(ai::ArtboardProperties &properties, const AIRealPoint &rulerOrigin)

Sets the ruler origin of the artboard, relative to left-bottom corner.

Parameters:

	properties	The artboard properties object.
	rulerOrigin	The new ruler origin.

Referenced by ai::ArtboardProperties::SetRulerOrigin().

AIAPI AIErr(* AIArtboardSuite::SetShowDisplayMark)(ai::ArtboardProperties &properties, ai::ArtboardProperties::DisplayMarkType type, AIBoolean show)

Referenced by ai::ArtboardProperties::SetShowDisplayMark().

AIAPI AIErr(* AIArtboardSuite::Update)(ai::ArtboardList &artboardList, ai::ArtboardID index, const ai::ArtboardProperties &properties)

Updates the properties of an artboard.

Use with GetCount() and GetArtboardProperties() to modify the artboard without changing which artboard is active in the document.

Parameters:

	artboardList	The artboard list object.
	index	The 0-based index position of the artboard in the document list.
	properties	The object containing the new artboard properties.

Referenced by ai::ArtboardList::Update().

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

AIArtboard.h

AIArtboardSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIArtboardSuite Struct Reference
[API Suite List]