ai::ArtboardProperties Class Reference

The ArtboardProperties object encapsulates all the attributes associated with an artboard. More...

#include <IAIArtboards.hpp>

List of all members.

Public Types
enum	DisplayMarkType { kNone = 0, kCenter = 1, kCrossHair = 1<<1, kSafeAreas = 1<<2 }
	Types of artboard display marks and annotations. More...
Public Member Functions
	ArtboardProperties ()
	Default constructor.
	ArtboardProperties (const ArtboardProperties &)
	Copy Constructor.
	~ArtboardProperties ()
	Destructor.
ArtboardProperties &	operator= (const ArtboardProperties &)
	Assignment operator.
bool	IsValid () const
	Checks for a valid object, Invalid objects return an error on every operation.
AIErr	GetPosition (AIRealRect &value) const
	Retrieves the position and bounds of this artboard.
AIErr	SetPosition (AIRealRect value)
	Modifies the position and bounds of this artboard.
AIErr	GetPAR (AIReal &value) const
	Retrieves the pixel aspect ratio of the artboard ruler.
AIErr	SetPAR (AIReal value)
	Modifies the pixel aspect ratio of the artboard ruler.
AIErr	GetShowDisplayMark (DisplayMarkType mark, bool &show) const
	Reports whether a particular type of annotation is shown or hidden.
AIErr	SetShowDisplayMark (DisplayMarkType mark, bool show)
	Shows or hides a particular type of annotation.
AIErr	GetName (ai::UnicodeString &name) const
	Retrieves the name associated with this artboard.
AIErr	SetName (const ai::UnicodeString &name)
	Sets the name associated with this artboard.
AIErr	GetRulerOrigin (AIRealPoint &rulerOrigin) const
	Retrieves the ruler origin of the artboard.
AIErr	SetRulerOrigin (const AIRealPoint &rulerOrigin)
	Sets the ruler origin of the artboard.
AIErr	IsDefaultName (AIBoolean &isDefault) const
	Reports whether this artboard has an application-generated name.
AIErr	SetIsDefaultName (const AIBoolean &isDefault)
	Internal.
	ArtboardProperties (const ArtboardRef ref)
void	deleteImpl ()
Friends
class	ArtboardList

---

Detailed Description

The ArtboardProperties object encapsulates all the attributes associated with an artboard.

These are not live objects but a snapshot at any given time. To update an object, you must call ai::ArtboardList::Update.

---

Member Enumeration Documentation

enum ai::ArtboardProperties::DisplayMarkType

Types of artboard display marks and annotations.

Enumerator:

kNone
kCenter
kCrossHair
kSafeAreas

---

Constructor & Destructor Documentation

ai::ArtboardProperties::ArtboardProperties

(

)

Default constructor.

References AIArtboardSuite::Init, and sAIArtboard.

ai::ArtboardProperties::ArtboardProperties

(

const ArtboardProperties &

artboard

)

Copy Constructor.

References AIArtboardSuite::CloneArtboard, and sAIArtboard.

ai::ArtboardProperties::~ArtboardProperties

(

)

Destructor.

References AIArtboardSuite::Dispose, and sAIArtboard.

ai::ArtboardProperties::ArtboardProperties

(

const ArtboardRef

ref

)

---

Member Function Documentation

void ai::ArtboardProperties::deleteImpl

(

)

AIErr ai::ArtboardProperties::GetName

(

ai::UnicodeString &

name

)

const

Retrieves the name associated with this artboard.

Parameters:

name

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

References AIArtboardSuite::GetName, and sAIArtboard.

AIErr ai::ArtboardProperties::GetPAR

(

AIReal &

value

)

const

Retrieves the pixel aspect ratio of the artboard ruler.

Parameters:

value

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

References AIArtboardSuite::GetPAR, and sAIArtboard.

AIErr ai::ArtboardProperties::GetPosition

(

AIRealRect &

value

)

const

Retrieves the position and bounds of this artboard.

Parameters:

value

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

References AIArtboardSuite::GetPosition, and sAIArtboard.

AIErr ai::ArtboardProperties::GetRulerOrigin

(

AIRealPoint &

rulerOrigin

)

const

Retrieves the ruler origin of the artboard.

Ruler origin is relative to left-bottom corner of the artboard

Parameters:

rulerOrigin

[out] A buffer in which to return the ruler origin.

References AIArtboardSuite::GetRulerOrigin, and sAIArtboard.

AIErr ai::ArtboardProperties::GetShowDisplayMark	(	DisplayMarkType	mark,
		bool &	show
	)			const

Reports whether a particular type of annotation is shown or hidden.

Parameters:

	mark	The type of annotation.
	show	[out] A buffer in which to return true if the mark is shown, false if hidden.

References AIArtboardSuite::GetShowDisplayMark, kNoErr, and sAIArtboard.

AIErr ai::ArtboardProperties::IsDefaultName

(

AIBoolean &

isDefault

)

const

Reports whether this artboard has an application-generated name.

This affects the file name of the artboard if it is saved as part of an export-to-JPEG operation.

Parameters:

isDefault

[out] A buffer in which to return true if the name is generated, false if it has been explicitly set.

References AIArtboardSuite::IsDefaultName, and sAIArtboard.

bool ai::ArtboardProperties::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.

ArtboardProperties & ai::ArtboardProperties::operator=

(

const ArtboardProperties &

object

)

Assignment operator.

AIErr ai::ArtboardProperties::SetIsDefaultName

(

const AIBoolean &

isDefault

)

Internal.

Do not use.

References sAIArtboard, and AIArtboardSuite::SetIsDefaultName.

AIErr ai::ArtboardProperties::SetName

(

const ai::UnicodeString &

name

)

Sets the name associated with this artboard.

Parameters:

name

The new name.

References sAIArtboard, and AIArtboardSuite::SetName.

AIErr ai::ArtboardProperties::SetPAR

(

AIReal

value

)

Modifies the pixel aspect ratio of the artboard ruler.

Call ai::ArtboardList::Update() with this object to make the change in the artboard

Parameters:

value

The new value.

References sAIArtboard, and AIArtboardSuite::SetPAR.

AIErr ai::ArtboardProperties::SetPosition

(

AIRealRect

value

)

Modifies the position and bounds of this artboard.

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

Parameters:

value

The new position and bounds value.

References sAIArtboard, and AIArtboardSuite::SetPosition.

AIErr ai::ArtboardProperties::SetRulerOrigin

(

const AIRealPoint &

rulerOrigin

)

Sets the ruler origin of the artboard.

Ruler origin is relative to left-bottom corner of the artboard

Parameters:

rulerOrigin

The new ruler origin.

References sAIArtboard, and AIArtboardSuite::SetRulerOrigin.

AIErr ai::ArtboardProperties::SetShowDisplayMark	(	DisplayMarkType	mark,
		bool	show
	)

Shows or hides a particular type of annotation.

Parameters:

	mark	The type of annotation.
	show	True to show, false to hide.

References sAIArtboard, and AIArtboardSuite::SetShowDisplayMark.

---

Friends And Related Function Documentation

friend class ArtboardList [friend]

---

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

• IAIArtboards.hpp
• IAIArtboards.cpp