Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
hdicoreSymbol.h
Go to the documentation of this file.
1
7#ifndef __HDI_CORE_SYMBOL__
8#define __HDI_CORE_SYMBOL__
9
10#if defined(HDI_CORE_AIP_MODE)
11
12#include "hdicorePattern.h"
13
14namespace hdi
15{
16 namespace aip
17 {
18 class Symbol;
19 }
20
21 namespace core
22 {
26 class Symbol : public Pattern
27 {
28 public:
41
49 Symbol(const Symbol& sym_);
50
59 static Symbol create(const Art& src_);
60
66 virtual ~Symbol();
67
76 virtual Symbol& operator=(const Symbol& rhs_);
77
88 virtual bool dispose();
89
97 virtual bool valid() const;
98
107 virtual bool operator==(const Symbol& rhs_) const;
108
117 virtual bool operator!=(const Symbol& rhs_) const;
118
126 virtual std::unique_ptr<Art> sourceArt() const;
127
135 virtual void setSourceArt(const Art& art_);
136
144 virtual bool isBeingEdited() const;
145
159 virtual bool setBeingEdited(const Art* const inst_ = NULL);
160
173 virtual std::unique_ptr<Art> newInstance(
174 const ArtboardPoint& center_,
175 const PaintOrder order_,
176 const Art* const prep_ = NULL
177 ) const;
178
179
180 private:
181 friend aip::Symbol* __accessImpl(const Symbol&);
182 friend Symbol __accessCtor(aip::Symbol*&);
183
189 Symbol(aip::Symbol*&);
190 };
191
192 typedef std::unique_ptr<Symbol> SymbolUP;
193 typedef std::shared_ptr<Symbol> SymbolSP;
194 typedef std::weak_ptr<Symbol> SymbolWP;
195
196 extern aip::Symbol* __accessImpl(const Symbol&);
197 extern Symbol __accessCtor(aip::Symbol*&);
198 }
199}
200
201#endif
202// HDI_CORE_AIP_MODE
203
204#endif
205// __HDI_CORE_SYMBOL__
Handles general art-related functionality.
Definition: hdicoreArt.h:51
Describes a point on the Illustrator artboard.
Definition: hdicoreArtboardPoint.h:31
Handles general pattern-related functionality.
Definition: hdicorePattern.h:30
Handles general symbol-related functionality.
Definition: hdicoreSymbol.h:27
virtual std::unique_ptr< Art > sourceArt() const
Gets the Art object that defines the source art for the symbol.
virtual bool isBeingEdited() const
Gets whether the target symbol is currently being edited in symbol editing mode.
virtual std::unique_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 bool setBeingEdited(const Art *const inst_=NULL)
Puts the document into symbol editing mode, with the target symbol being the one to edit.
virtual Symbol & operator=(const Symbol &rhs_)
Assigns one Symbol object to another.
Symbol(const Symbol &sym_)
Constructs a new Symbol object from an existing Symbol object (copy constructor)
virtual bool dispose()
Removes the symbol from its document.
virtual ~Symbol()
Symbol object destructor.
virtual bool operator!=(const Symbol &rhs_) const
Tests whether a given Symbol object is not the same as another.
virtual void setSourceArt(const Art &art_)
Sets 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.
static Symbol create(const Art &src_)
Creates a new Symbol object (and Illustrator symbol)
Symbol()
Constructs an empty Symbol object.
virtual bool operator==(const Symbol &rhs_) const
Tests whether a given Symbol object is the same as another.
Header file for general Illustrator pattern manipulation.
PaintOrder
Indicates the position of art or layers when during creation or reordering.
Definition: hdicoreTypes.h:316