Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
hdicoreSymbol.h
Go to the documentation of this file.
1 
7 #ifndef __HDI_CORE_SYMBOL__
8 #define __HDI_CORE_SYMBOL__
9 
10 #include "hdicorePattern.h"
11 
12 namespace hdi
13 {
14  namespace plugin
15  {
16  class Symbol;
17  }
18 
19  namespace core
20  {
24  class Symbol : public Pattern
25  {
26  public:
38  Symbol();
39 
47  Symbol(const Symbol& sym_);
48 
57  static Symbol create(const Art& src_);
58 
64  virtual ~Symbol();
65 
74  virtual Symbol& operator=(const Symbol& rhs_);
75 
86  virtual bool dispose();
87 
95  virtual bool valid() const;
96 
105  virtual bool operator==(const Symbol& rhs_) const;
106 
115  virtual bool operator!=(const Symbol& rhs_) const;
116 
124  virtual std::auto_ptr<Art> sourceArt() const;
125 
133  virtual void setSourceArt(const Art& art_);
134 
142  virtual bool isBeingEdited() const;
143 
157  virtual bool setBeingEdited(const Art* const inst_ = NULL);
158 
171  virtual std::auto_ptr<Art> newInstance(
172  const ArtboardPoint& center_,
173  const PaintOrder order_,
174  const Art* const prep_ = NULL
175  ) const;
176 
177 
178  private:
179  friend plugin::Symbol* __accessImpl(const Symbol&);
180  friend Symbol __accessCtor(plugin::Symbol*&);
181 
187  Symbol(plugin::Symbol*&);
188  };
189 
190  typedef std::auto_ptr<Symbol> SymbolAP;
191 
192  extern plugin::Symbol* __accessImpl(const Symbol&);
193  extern Symbol __accessCtor(plugin::Symbol*&);
194  }
195 }
196 
197 #endif
198 // __HDI_CORE_SYMBOL__
Handles general art-related functionality.
Definition: hdicoreArt.h:47
virtual bool operator!=(const Symbol &rhs_) const
Tests whether a given Symbol object is not the same as another.
virtual ~Symbol()
Symbol object destructor.
virtual std::auto_ptr< Art > newInstance(const ArtboardPoint &center_, const PaintOrder order_, const Art *const prep_=NULL) const
Creates a new instance of the symbol in the current document.
virtual void setSourceArt(const Art &art_)
Sets the Art object that defines the source art for the symbol.
virtual bool setBeingEdited(const Art *const inst_=NULL)
Puts the document into symbol editing mode, with the target symbol being the one to edit...
Header file for general Illustrator pattern manipulation.
Handles general pattern-related functionality.
Definition: hdicorePattern.h:27
Symbol()
Constructs an empty Symbol object.
Handles general symbol-related functionality.
Definition: hdicoreSymbol.h:24
virtual std::auto_ptr< Art > sourceArt() const
Gets the Art object that defines the source art for the symbol.
virtual bool valid() const
Tests the validity of the target symbol by searching for it in the document.
Definition: hdicoreaiArray.h:12
virtual Symbol & operator=(const Symbol &rhs_)
Assigns one Symbol object to another.
virtual bool dispose()
Removes the symbol from its document.
virtual bool isBeingEdited() const
Gets whether the target symbol is currently being edited in symbol editing mode.
virtual bool operator==(const Symbol &rhs_) const
Tests whether a given Symbol object is the same as another.
Describes a point on the Illustrator artboard.
Definition: hdicoreArtboardPoint.h:28
static Pattern create()
Creates a new Pattern object (and Illustrator pattern); set the source art for it with the setSourceA...