ai::ArtboardList Class Reference

The ArtboardList object is the interface to the set of artboards associated with a document. More...

#include <IAIArtboards.hpp>

List of all members.

Public Member Functions
	ArtboardList ()
	~ArtboardList ()
	Destructor.
bool	IsValid () const
	Checks for a valid object, Invalid objects return an error on every operation.
AIErr	AddNew (ArtboardProperties &newArtboard, ArtboardID &index)
	Adds a new artboard to the document and reports its index position in this artboard list.
AIErr	Insert (ArtboardProperties &artboard, ArtboardID &index)
	Inserts a new artboard to the document at the specified location.
AIErr	Delete (ArtboardID index)
	Deletes an artboard from the document list, makes the next one in the list active.
AIErr	GetCount (ArtboardID &count) const
	Retrieves the number of artboards defined in the artboard list.
ArtboardProperties	GetArtboardProperties (ArtboardID index)
	Retrieves the properties of an artboard.
AIErr	Update (ArtboardID index, const ArtboardProperties &artboard)
	Updates the properties of an artboard.
AIErr	GetActive (ArtboardID &index) const
	Retrieves the index position of the active artboard in the document's list.
AIErr	SetActive (ArtboardID index)
	Makes a specific artboard active, and makes it current in the iteration order.
	ArtboardList (const ArtboardList &)
ArtboardList &	operator= (const ArtboardList &)
	ArtboardList (ArtboardListRef)
void	deleteImpl ()

---

Detailed Description

The ArtboardList object is the interface to the set of artboards associated with a document.

It encapsulate all artboard operations.

---

Constructor & Destructor Documentation

ai::ArtboardList::ArtboardList

(

)

References AIArtboardSuite::GetArtboardList, and sAIArtboard.

ai::ArtboardList::~ArtboardList

(

)

Destructor.

References AIArtboardSuite::ReleaseArtboardList, and sAIArtboard.

ai::ArtboardList::ArtboardList

(

const ArtboardList &

)

ai::ArtboardList::ArtboardList

(

ArtboardListRef

)

---

Member Function Documentation

AIErr ai::ArtboardList::AddNew	(	ArtboardProperties &	newArtboard,
		ArtboardID &	index
	)

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

Parameters:

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

Returns:

The error kAIExceededMaxArtboardLimitErr if the number of artboards exceeds kAIMAX_ARTBOARD_LIMIT.

References AIArtboardSuite::AddNew, and sAIArtboard.

AIErr ai::ArtboardList::Delete

(

ArtboardID

index

)

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

Parameters:

index

The 0-based index position of the artboard to delete.

Returns:

The error kAICantDeleteLastArtboardErr if this is the last artboard in the list.

References AIArtboardSuite::Delete, and sAIArtboard.

void ai::ArtboardList::deleteImpl

(

)

AIErr ai::ArtboardList::GetActive

(

ArtboardID &

index

)

const

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

Parameters:

index

[out] A buffer in which to return the 0-based index, or -1 if there are no artboards in the current document.

References AIArtboardSuite::GetActive, and sAIArtboard.

Referenced by ai::ArtboardUtils::GetActiveArtboardIndex(), and ai::ArtboardUtils::GetActiveArtboardPosition().

ArtboardProperties ai::ArtboardList::GetArtboardProperties

(

ArtboardID

index

)

Retrieves the properties of an artboard.

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

Parameters:

index

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

Returns:

The artboard properties object. On error returns an invalid object.

References AIArtboardSuite::GetArtboardProperties, NULL, and sAIArtboard.

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

AIErr ai::ArtboardList::GetCount

(

ArtboardID &

count

)

const

Retrieves the number of artboards defined in the artboard list.

Parameters:

count

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

References AIArtboardSuite::GetCount, and sAIArtboard.

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

AIErr ai::ArtboardList::Insert	(	ArtboardProperties &	artboard,
		ArtboardID &	index
	)

Inserts a new artboard to the document at the specified location.

Parameters:

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

Returns:

The error kAIExceededMaxArtboardLimitErr if the number of artboards exceeds kAIMAX_ARTBOARD_LIMIT.

References AIArtboardSuite::Insert, and sAIArtboard.

bool ai::ArtboardList::IsValid

(

)

const [inline]

Checks for a valid object, Invalid objects return an error on every operation.

Returns:

True if this object is valid.

References NULL.

ArtboardList& ai::ArtboardList::operator=

(

const ArtboardList &

)

AIErr ai::ArtboardList::SetActive

(

ArtboardID

index

)

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

Parameters:

index

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

References sAIArtboard, and AIArtboardSuite::SetActive.

AIErr ai::ArtboardList::Update	(	ArtboardID	index,
		const ArtboardProperties &	artboard
	)

Updates the properties of an artboard.

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

Parameters:

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

References sAIArtboard, and AIArtboardSuite::Update.

---

The documentation for this class was generated from the following files:

• IAIArtboards.hpp
• IAIArtboards.cpp