Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
hdicoreArtboard.h
Go to the documentation of this file.
1 
7 #ifndef __HDI_CORE_ARTBOARD__
8 #define __HDI_CORE_ARTBOARD__
9 
10 #include <vector>
11 
12 #include "hdicoreMacros.h"
13 
14 #include "hdicoreArtboardPoint.h"
15 #include "hdicoreArtboardRect.h"
16 
17 namespace hdi
18 {
19  namespace plugin
20  {
21  class Artboard;
22  }
23 
24  namespace core
25  {
26  class Art;
27 
31  class Artboard
32  {
33  public:
34  typedef std::vector< Art* > ArtVector;
35 
47  Artboard();
48 
56  Artboard(const Artboard& a_);
57 
63  virtual ~Artboard();
64 
73  virtual Artboard& operator=(const Artboard& rhs_);
74 
82  virtual bool isEmpty() const;
83 
91  virtual bool valid() const;
92 
103  virtual bool dispose();
104 
113  virtual bool operator==(const Artboard& rhs_) const;
114 
123  virtual bool operator!=(const Artboard& rhs_) const;
124 
132  virtual ArtboardRect bounds() const;
133 
141  virtual void setBounds(const ArtboardRect& bounds_);
142 
157  virtual ArtboardPoint rulerOrigin() const;
158 
166  virtual void setRulerOrigin(const ArtboardPoint& origin_);
167 
175  virtual std::string name() const;
176 
184  virtual void setName(const std::string& name_);
185 
193  virtual bool active() const;
194 
205  virtual ArtVector allArtObjects() const;
206 
207 
208  private:
209  friend plugin::Artboard* __accessImpl(const Artboard&);
210  friend Artboard __accessCtor(plugin::Artboard*&);
211 
215  void* __data;
216 
222  void* __impl() const;
223 
229  Artboard(plugin::Artboard*&);
230  };
231 
232  typedef std::auto_ptr<Artboard> ArtboardAP;
233 
234  extern plugin::Artboard* __accessImpl(const Artboard&);
235  extern Artboard __accessCtor(plugin::Artboard*&);
236  }
237 }
238 
239 #endif
240 // __HDI_CORE_ARTBOARD__
virtual bool valid() const
Tests the validity of the target artboard.
virtual ArtboardPoint rulerOrigin() const
Gets the ruler origin point of the artboard, relative to the artboard itself.
virtual std::string name() const
Gets the artboard's name.
Describes a rectangular area on the Illustrator artboard.
Definition: hdicoreArtboardRect.h:25
Header file for geometric rectangle manipulation on the Illustrator artboard.
virtual ~Artboard()
Destructs an Artboard object.
virtual ArtVector allArtObjects() const
Gets all the art objects that "touch" 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 not the same as another.
Header file for geometric point manipulation on the Illustrator artboard.
virtual ArtboardRect bounds() const
Gets the position (bounds) of the artboard.
Header file for a variety of Illustrator plugin convenience macros.
Definition: hdicoreaiArray.h:12
virtual Artboard & operator=(const Artboard &rhs_)
Assigns one Artboard object to another.
virtual void setRulerOrigin(const ArtboardPoint &origin_)
Sets the ruler origin point of the artboard, relative to the artboard itself.
virtual void setBounds(const ArtboardRect &bounds_)
Sets the position (bounds) of the artboard.
Represents an individual artboard in the current document.
Definition: hdicoreArtboard.h:31
virtual bool isEmpty() const
Gets whether the target Artboard object is empty (constructed with the default ctor) ...
virtual bool operator==(const Artboard &rhs_) const
Tests whether a given Artboard object is the same as another.
virtual void setName(const std::string &name_)
Sets the artboard's name.
Describes a point on the Illustrator artboard.
Definition: hdicoreArtboardPoint.h:28
virtual bool active() const
Gets whether the target artboard is the current one in the current document.
Artboard()
Constructs an empty Artboard object.