Represents an individual artboard in the current document. More...

#include <hdicoreArtboard.h>

Public Types
typedef std::vector< std::shared_ptr< Art > >	ArtVector

Public Member Functions
	Artboard ()
	Constructs an empty Artboard object.

	Artboard (const Artboard &a_)
	Constructs a new Artboard object from an existing Artboard object (copy constructor)

virtual	~Artboard ()
	Destructs an Artboard object.

virtual Artboard &	operator= (const Artboard &rhs_)
	Assigns one Artboard object to another.

virtual bool	isEmpty () const
	Gets whether the target Artboard object is empty (constructed with the default ctor)

virtual bool	valid () const
	Tests the validity of the target artboard.

virtual bool	dispose ()
	Removes the artboard from the document.

virtual bool	operator== (const Artboard &rhs_) const
	Tests whether a given Artboard object is the same as another.

virtual bool	operator!= (const Artboard &rhs_) const
	Tests whether a given Artboard object is not the same as another.

virtual ArtboardRect	bounds () const
	Gets the position (bounds) of the artboard.

virtual void	setBounds (const ArtboardRect &bounds_)
	Sets the position (bounds) of the artboard.

virtual ArtboardPoint	rulerOrigin () const
	Gets the ruler origin point of the artboard, relative to the artboard itself.

virtual void	setRulerOrigin (const ArtboardPoint &origin_)
	Sets the ruler origin point of the artboard, relative to the artboard itself.

virtual std::string	name () const
	Gets the artboard's name.

virtual void	setName (const std::string &name_)
	Sets the artboard's name.

virtual ArtColor	color () const
	Gets the color for the artboard.

virtual void	setColor (const ArtColor &color_)
	Sets the color for the artboard.

virtual bool	editable () const
	Gets whether the artboard is editable.

virtual void	setEditable (const bool editable_)
	Sets whether the artboard is editable.

virtual bool	locked () const
	Gets whether the artboard is locked.

virtual void	setLocked (const bool lock_)
	Sets whether the artboard is locked.

virtual bool	hidden () const
	Gets whether the artboard is hidden.

virtual void	setHidden (const bool hidden_)
	Sets whether the artboard is hidden.

virtual bool	active () const
	Gets whether the target artboard is the current one in the current document.

virtual ArtVector	allArtObjects () const
	Gets all the art objects that "touch" the target artboard.

Friends
aip::Artboard *	__accessImpl (const Artboard &)

Artboard	__accessCtor (aip::Artboard *&)

Detailed Description

Represents an individual artboard in the current document.

Constructor & Destructor Documentation

◆ Artboard() [1/2]

hdi::core::Artboard::Artboard ( )

Constructs an empty Artboard object.

Author: GW

Date: 08/2013

Note: To test if an Artboard object is empty, call isEmpty() on it; Empty Artboard objects do not relate to any artboard in an Illustrator document; they are designed to be "receivers" of some other Artboard object via the overloaded assignment operator. Empty Artboard objects are useless until such time (though it is safe to call any of their methods)

◆ Artboard() [2/2]

hdi::core::Artboard::Artboard ( const Artboard & a_ )

Constructs a new Artboard object from an existing Artboard object (copy constructor)

Author: GW

Date: 08/2013

Parameters

a_	Existing Artboard object

◆ ~Artboard()

virtual hdi::core::Artboard::~Artboard ( )

virtual

Destructs an Artboard object.

Author: GW

Date: 08/2013

Member Function Documentation

◆ active()

virtual bool hdi::core::Artboard::active ( ) const

virtual

Gets whether the target artboard is the current one in the current document.

Author: GW

Date: 08/2013

Returns: true if the target artboard is currently selected

◆ allArtObjects()

virtual ArtVector hdi::core::Artboard::allArtObjects ( ) const

virtual

Gets all the art objects that "touch" the target artboard.

Author: GW

Date: 01/2015

Returns: A vector of art objects whose bounds intersect the bounds of the target artboard in any way

◆ bounds()

virtual ArtboardRect hdi::core::Artboard::bounds ( ) const

virtual

Gets the position (bounds) of the artboard.

Author: GW

Date: 08/2013

Returns: Bounds rect of the target artboard, relative to the document's absolute (0,0) coordinate

◆ color()

virtual ArtColor hdi::core::Artboard::color ( ) const

virtual

Gets the color for the artboard.

Author: GW

Date: 09/2025

Returns: The artboard color

◆ dispose()

virtual bool hdi::core::Artboard::dispose ( )

virtual

Removes the artboard from the document.

Author: GW

Date: 08/2013

Returns: true for successful disposal, false otherwise

Note: After calling dispose(), the target object is useless! The actual artboard is gone, so obviously none of these methods will work after that.

◆ editable()

virtual bool hdi::core::Artboard::editable ( ) const

virtual

Gets whether the artboard is editable.

Author: GW

Date: 09/2025

Returns: true for the artboard being editable (unlocked), false otherwise

Note: Always returns the opposite of locked() method.

◆ hidden()

virtual bool hdi::core::Artboard::hidden ( ) const

virtual

Gets whether the artboard is hidden.

Author: GW

Date: 09/2025

Returns: true for artboard being hidden, false otherwise

◆ isEmpty()

virtual bool hdi::core::Artboard::isEmpty ( ) const

virtual

Gets whether the target Artboard object is empty (constructed with the default ctor)

Author: GW

Date: 08/2013

Returns: true if the target Artboard object is empty, false otherwise

◆ locked()

virtual bool hdi::core::Artboard::locked ( ) const

virtual

Gets whether the artboard is locked.

Author: GW

Date: 09/2025

Returns: true for the artboard being locked (uneditable), false otherwise

Note: Always returns the opposite of editable() method.

◆ name()

virtual std::string hdi::core::Artboard::name ( ) const

virtual

Gets the artboard's name.

Author: GW

Date: 08/2013

Returns: Name of the target artboard, as UTF-8

◆ operator!=()

virtual bool hdi::core::Artboard::operator!= ( const Artboard & rhs_ ) const

virtual

Tests whether a given Artboard object is not the same as another.

Author: GW

Date: 08/2013

Parameters

rhs_	Artboard to compare against

Returns: true for the target and rhs_ being different artboards, false otherwise

◆ operator=()

virtual Artboard & hdi::core::Artboard::operator= ( const Artboard & rhs_ )

virtual

Assigns one Artboard object to another.

Author: GW

Date: 08/2013

Parameters

rhs_	Existing Artboard object to copy values from

Returns: The target Artboard object, but with its values updated to match that of the rhs_ argument

◆ operator==()

virtual bool hdi::core::Artboard::operator== ( const Artboard & rhs_ ) const

virtual

Tests whether a given Artboard object is the same as another.

Author: GW

Date: 08/2013

Parameters

rhs_	Artboard to compare against

Returns: true for the target and rhs_ being the same artboard, false otherwise

◆ rulerOrigin()

virtual ArtboardPoint hdi::core::Artboard::rulerOrigin ( ) const

virtual

Gets the ruler origin point of the artboard, relative to the artboard itself.

Author: GW

Date: 08/2013

Returns: Origin point of the artboard, typically the top-left

Note: Artboard ruler origins have been known to be the cause of some confusion. This method gives the ruler origin relative to the artboard's position in the document and NOT relative to the document's absolute (0,0) coordinate. If you had an artboard located at (200,100) relative to the document (0,0) and the artboard had its individual ruler origin set to (20,10) relative to the artboard, then the ruler origin relative to the document's absolute (0,0) coordinate is (220,110). Got it?

◆ setBounds()

virtual void hdi::core::Artboard::setBounds ( const ArtboardRect & bounds_ )

virtual

Sets the position (bounds) of the artboard.

Author: GW

Date: 08/2013

Parameters

bounds_ New artboard bounds, relative to the document's absolute (0,0) coordinate

◆ setColor()

virtual void hdi::core::Artboard::setColor ( const ArtColor & color_ )

virtual

Sets the color for the artboard.

Author: GW

Date: 09/2025

Parameters

color_ The new artboard color

◆ setEditable()

virtual void hdi::core::Artboard::setEditable ( const bool editable_ )

virtual

Sets whether the artboard is editable.

Author: GW

Date: 09/2025

Parameters

editable_ true to allow editing, false otherwise

Note: Always sets the artboard to be locked.

◆ setHidden()

virtual void hdi::core::Artboard::setHidden ( const bool hidden_ )

virtual

Sets whether the artboard is hidden.

Author: GW

Date: 09/2025

Parameters

hidden_ true to hide, false otherwise

◆ setLocked()

virtual void hdi::core::Artboard::setLocked ( const bool lock_ )

virtual

Sets whether the artboard is locked.

Author: GW

Date: 09/2025

Parameters

lock_ true to lock, false otherwise

Note: Always sets the artboard to be uneditable.

◆ setName()

virtual void hdi::core::Artboard::setName ( const std::string & name_ )

virtual

Sets the artboard's name.

Author: GW

Date: 08/2013

Parameters

name_ New name for the artboard, as UTF-8

◆ setRulerOrigin()

virtual void hdi::core::Artboard::setRulerOrigin ( const ArtboardPoint & origin_ )

virtual

Sets the ruler origin point of the artboard, relative to the artboard itself.

Author: GW

Date: 08/2013

Parameters

origin_ New artboard origin

◆ valid()

virtual bool hdi::core::Artboard::valid ( ) const

virtual

Tests the validity of the target artboard.

Author: GW

Date: 08/2013

Returns: true for a valid artboard, false otherwise

Public Types

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Artboard() [1/2]

◆ Artboard() [2/2]

◆ ~Artboard()

Member Function Documentation

◆ active()

◆ allArtObjects()

◆ bounds()

◆ color()

◆ dispose()

◆ editable()

◆ hidden()

◆ isEmpty()

◆ locked()

◆ name()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ rulerOrigin()

◆ setBounds()

◆ setColor()

◆ setEditable()

◆ setHidden()

◆ setLocked()

◆ setName()

◆ setRulerOrigin()

◆ valid()