Hot Door CORE 0.8.4
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
hdicoreArtboard.h
Go to the documentation of this file.
1
6
7#ifndef __HDI_CORE_ARTBOARD__
8#define __HDI_CORE_ARTBOARD__
9
10#if defined(HDI_CORE_AIP_MODE)
11
12#include <vector>
13
14#include "hdicoreMacros.h"
15
17#include "hdicoreArtboardRect.h"
18#include "hdicoreArtColor.h"
19
20namespace hdi
21{
22 namespace aip
23 {
24 class Artboard;
25 }
26
27 namespace core
28 {
29 class Art;
30 class Layer;
31
36 {
37 public:
38 typedef std::vector< std::shared_ptr<Art> > ArtVector;
39
52
60 Artboard(const Artboard& a_);
61
67 virtual ~Artboard();
68
77 virtual Artboard& operator=(const Artboard& rhs_);
78
86 virtual bool isEmpty() const;
87
95 virtual bool valid() const;
96
107 virtual bool dispose();
108
117 virtual bool operator==(const Artboard& rhs_) const;
118
127 virtual bool operator!=(const Artboard& rhs_) const;
128
136 virtual ArtboardRect bounds() const;
137
145 virtual void setBounds(const ArtboardRect& bounds_);
146
161 virtual ArtboardPoint rulerOrigin() const;
162
170 virtual void setRulerOrigin(const ArtboardPoint& origin_);
171
179 virtual std::string name() const;
180
188 virtual void setName(const std::string& name_);
189
190 #if HDI_CORE_COMPILE_AI30_PLUS
198 virtual ArtColor color() const;
199
207 virtual void setColor(const ArtColor& color_);
208
218 virtual bool editable() const;
219
229 virtual void setEditable(const bool editable_);
230
240 virtual bool locked() const;
241
251 virtual void setLocked(const bool lock_);
252
260 virtual bool hidden() const;
261
269 virtual void setHidden(const bool hidden_);
270 #endif
271 // HDI_CORE_COMPILE_AI30_PLUS
272
280 virtual bool active() const;
281
290 virtual ArtVector allArtObjects() const;
291
292
293 private:
294 friend aip::Artboard* __accessImpl(const Artboard&);
295 friend Artboard __accessCtor(aip::Artboard*&);
296
300 void* __data;
301
307 void* __impl() const;
308
314 Artboard(aip::Artboard*&);
315 };
316
317 typedef std::unique_ptr<Artboard> ArtboardUP;
318 typedef std::shared_ptr<Artboard> ArtboardSP;
319 typedef std::weak_ptr<Artboard> ArtboardWP;
320
321 extern aip::Artboard* __accessImpl(const Artboard&);
322 extern Artboard __accessCtor(aip::Artboard*&);
323 }
324}
325
326#endif
327// HDI_CORE_AIP_MODE
328
329#endif
330// __HDI_CORE_ARTBOARD__
Describes the color of art on the artboard.
Definition hdicoreArtColor.h:42
Handles general art-related functionality.
Definition hdicoreArt.h:51
Represents an individual artboard in the current document.
Definition hdicoreArtboard.h:36
virtual bool dispose()
Removes the artboard from the document.
virtual ArtboardRect bounds() const
Gets the position (bounds) of the artboard.
virtual void setColor(const ArtColor &color_)
Sets the color for the artboard.
virtual void setBounds(const ArtboardRect &bounds_)
Sets the position (bounds) of the artboard.
virtual void setRulerOrigin(const ArtboardPoint &origin_)
Sets the ruler origin point of the artboard, relative to the artboard itself.
Artboard(const Artboard &a_)
Constructs a new Artboard object from an existing Artboard object (copy constructor)
virtual void setHidden(const bool hidden_)
Sets whether the artboard is hidden.
virtual void setLocked(const bool lock_)
Sets whether the artboard is locked.
virtual ArtVector allArtObjects() const
Gets all the art objects that "touch" the target artboard.
virtual bool valid() const
Tests the validity of the target artboard.
virtual bool operator!=(const Artboard &rhs_) const
Tests whether a given Artboard object is not the same as another.
virtual bool active() const
Gets whether the target artboard is the current one in the current document.
virtual ArtColor color() const
Gets the color for the artboard.
virtual std::string name() const
Gets the artboard's name.
virtual void setEditable(const bool editable_)
Sets whether the artboard is editable.
virtual ArtboardPoint rulerOrigin() const
Gets the ruler origin point of the artboard, relative to the artboard itself.
Artboard()
Constructs an empty Artboard object.
virtual bool locked() const
Gets whether the artboard is locked.
virtual bool editable() const
Gets whether the artboard is editable.
virtual void setName(const std::string &name_)
Sets the artboard's name.
virtual bool hidden() const
Gets whether the artboard is hidden.
virtual bool isEmpty() const
Gets whether the target Artboard object is empty (constructed with the default ctor)
virtual ~Artboard()
Destructs an Artboard object.
virtual Artboard & operator=(const Artboard &rhs_)
Assigns one Artboard object to another.
virtual bool operator==(const Artboard &rhs_) const
Tests whether a given Artboard object is the same as another.
Describes a point on the Illustrator artboard.
Definition hdicoreArtboardPoint.h:31
Describes a rectangular area on the Illustrator artboard.
Definition hdicoreArtboardRect.h:28
Allows for layer metadata access, visibility manipulation, locking, etc.
Definition hdicoreLayer.h:39
Header file for art color manipulation.
Header file for geometric point manipulation on the Illustrator artboard.
Header file for geometric rectangle manipulation on the Illustrator artboard.
Header file for a variety of plugin convenience macros.