ai::ArtboardUtils Namespace Reference

The ArtboardUtils object is a collection of utility functions for common operations. More...

Functions
AIErr	GetArtboardName (ai::UnicodeString &name, bool &isDefault, ArtboardID index)
	Retrieves the name of the specified artboard.
AIErr	GetArtboardIndexByName (const ai::UnicodeString &name, ai::ArtboardID &index)
	Retrieves the index of the artboard with specified name.
AIErr	GetCount (ArtboardID &count)
	Retrieves the number of artboards defined in the artboard list of the current document.
AIErr	GetPosition (ArtboardID index, AIRealRect &rect)
	Retrieves the position and bounds of an artboard.
AIErr	GetActiveArtboardPosition (AIRealRect &rect)
	Retrieves the position and bounds of the currently active artboard.
AIErr	GetActiveArtboardIndex (ArtboardID &index)
	Retrieves the index of the currently active artboard.

---

Detailed Description

The ArtboardUtils object is a collection of utility functions for common operations.

---

Function Documentation

AIErr ai::ArtboardUtils::GetActiveArtboardIndex

(

ArtboardID &

index

)

[inline]

Retrieves the index of the currently active artboard.

Parameters:

index

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

References ai::ArtboardList::GetActive(), and kNoErr.

AIErr ai::ArtboardUtils::GetActiveArtboardPosition

(

AIRealRect &

rect

)

[inline]

Retrieves the position and bounds of the currently active artboard.

Parameters:

rect

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

References ai::ArtboardList::GetActive(), GetPosition(), and kNoErr.

AIErr ai::ArtboardUtils::GetArtboardIndexByName	(	const ai::UnicodeString &	name,
		ai::ArtboardID &	index
	)

Retrieves the index of the artboard with specified name.

Parameters:

	name	[in] The name of the Artboard.
	index	[out] The artboard index .

AIErr ai::ArtboardUtils::GetArtboardName	(	ai::UnicodeString &	name,
		bool &	isDefault,
		ArtboardID	index
	)

Retrieves the name of the specified artboard.

if the index is -1 it gets the name of the active artboard

Parameters:

	name	[out] A buffer in which to return the name.
	isDefault	[out] A bool which indicates if the name is default or not.
	index	[in] The artboard index (-1 if active artboard).
	name	[out] A buffer in which to return the name.
	isDefault	[out] True if the name is the default name.
	index	[in] The 0-based position index of the artboard, or -1 to get the active artboard.

AIErr ai::ArtboardUtils::GetCount

(

ArtboardID &

count

)

[inline]

Retrieves the number of artboards defined in the artboard list of the current document.

Parameters:

count

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

References ai::ArtboardList::GetCount().

AIErr ai::ArtboardUtils::GetPosition	(	ArtboardID	index,
		AIRealRect &	rect
	)			[inline]

Retrieves the position and bounds of an artboard.

Parameters:

	index	The 0-based index position of the artboard in the document list.
	rect	[out] A buffer in which to return the value.

References ai::ArtboardList::GetArtboardProperties(), and kBadParameterErr.

Referenced by GetActiveArtboardPosition().