Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
hdicoreaiArray.h
Go to the documentation of this file.
1 
7 #ifndef __HDI_CORE_AI_ARRAY__
8 #define __HDI_CORE_AI_ARRAY__
9 
10 #include "hdicoreTypes.h"
11 
12 namespace hdi
13 {
14  namespace plugin
15  {
16  class IllustratorArray;
17  }
18 
19  namespace core
20  {
21  class Art;
22  class UID;
23 
24  namespace ai
25  {
26  class Entry;
27  class Dictionary;
28 
32  class Array
33  {
34  public:
40  Array();
41 
49  Array(const Array& a_);
50 
58  Array(const AIArrayRef aiArray_);
59 
65  virtual ~Array();
66 
77  virtual Array& operator=(const Array& rhs_);
78 
87  virtual bool operator==(const Array& rhs_) const;
88 
97  virtual bool operator!=(const Array& rhs_) const;
98 
113  virtual AIArrayRef aiArrayRef() const;
114 
125  virtual bool getEntry(const uint32_t index_, Entry& e__) const;
126 
139  virtual bool setEntry(const uint32_t index_, const Entry& entry_);
140 
149  virtual bool appendEntry(const Entry& entry_);
150 
159  virtual bool deleteEntry(const uint32_t index_);
160 
168  virtual uint32_t count() const;
169 
179  virtual bool getArrayEntry(const uint32_t index_, Array& array__) const;
180 
193  virtual bool setArrayEntry(const uint32_t index_, const Array& value_);
194 
204  virtual bool getDictEntry(const uint32_t index_, Dictionary& dict__) const;
205 
218  virtual bool setDictEntry(const uint32_t index_, const Dictionary& value_);
219 
229  virtual bool getBoolEntry(const uint32_t index_, bool& value__) const;
230 
243  virtual bool setBoolEntry(const uint32_t index_, const bool value_);
244 
254  virtual bool getIntEntry(const uint32_t index_, int64_t& value__) const;
255 
268  virtual bool setIntEntry(const uint32_t index_, const int64_t value_);
269 
279  virtual bool getFloatEntry(const uint32_t index_, double& value__) const;
280 
299  virtual bool setFloatEntry(const uint32_t index_, const double value_);
300 
310  virtual bool getStringEntry(const uint32_t index_, std::string& value__) const;
311 
324  virtual bool setStringEntry(const uint32_t index_, const std::string& value_);
325 
335  virtual bool getUIDEntry(const uint32_t index_, UID& uid__) const;
336 
349  virtual bool setUIDEntry(const uint32_t index_, const UID& value_);
350 
360  virtual bool getArtEntry(const uint32_t index_, Art& art__) const;
361 
374  virtual bool setArtEntry(const uint32_t index_, const Art& value_);
375 
383  virtual Array duplicate() const;
384 
394  virtual bool swapEntries(const uint32_t index1_, const uint32_t index2_);
395 
403  virtual bool clear();
404 
405 
406  private:
407  friend plugin::IllustratorArray* __accessImpl(const Array&);
408  friend Array __accessCtor(const plugin::IllustratorArray&);
409 
413  plugin::IllustratorArray* __impl;
414 
420  Array(const plugin::IllustratorArray&);
421  };
422 
423  typedef std::auto_ptr<Array> ArrayAP;
424 
425  extern plugin::IllustratorArray* __accessImpl(const Array&);
426  extern Array __accessCtor(const plugin::IllustratorArray&);
427  }
428  }
429 }
430 
431 #endif
432 // __HDI_CORE_AI_ARRAY__
virtual bool setArrayEntry(const uint32_t index_, const Array &value_)
Sets an array entry in the array by index.
virtual bool operator==(const Array &rhs_) const
Tests whether a given Array object is the same as another.
Handles general art-related functionality.
Definition: hdicoreArt.h:47
Allows for easy UID acquisition, art access, etc.
Definition: hdicoreUID.h:29
Illustrator entry wrapper class to allow for entry creation, manipulation, storage, etc.
Definition: hdicoreaiEntry.h:32
virtual bool setBoolEntry(const uint32_t index_, const bool value_)
Sets a bool entry in the array by index.
virtual bool setDictEntry(const uint32_t index_, const Dictionary &value_)
Sets a dictionary entry in the array by index.
virtual bool setFloatEntry(const uint32_t index_, const double value_)
Sets a floating point entry in the array by index.
Embodies Illustrator's dictionary storage containers; can be placed inside an array, or another dictionary.
Definition: hdicoreaiDictionary.h:33
virtual bool setArtEntry(const uint32_t index_, const Art &value_)
Sets an Art entry in the array by index.
virtual uint32_t count() const
Gets the count of the array elements.
virtual bool appendEntry(const Entry &entry_)
Appends an entry to the end of the array.
virtual bool clear()
Removes all entries from the array.
virtual bool getIntEntry(const uint32_t index_, int64_t &value__) const
Gets an integer entry from the array by index.
virtual bool deleteEntry(const uint32_t index_)
Removes an entry in the array by index.
virtual bool setIntEntry(const uint32_t index_, const int64_t value_)
Sets an integer entry in the array by index.
Array()
Constructs an Array object as a new data container.
virtual bool getBoolEntry(const uint32_t index_, bool &value__) const
Gets a bool entry from the array by index.
virtual ~Array()
Destructs an Array object.
virtual Array & operator=(const Array &rhs_)
Overloaded assignment operator for Array objects.
virtual bool getUIDEntry(const uint32_t index_, UID &uid__) const
Gets a UID entry from the array by index.
Header file for a wide variety of necessary typedefs, enums, and forwards declarations.
virtual bool getStringEntry(const uint32_t index_, std::string &value__) const
Gets a string entry from the array by index.
virtual bool setUIDEntry(const uint32_t index_, const UID &value_)
Sets a UID entry in the array by index.
Definition: hdicoreaiArray.h:12
virtual bool getArtEntry(const uint32_t index_, Art &art__) const
Gets an Art entry from the array by index.
virtual bool getArrayEntry(const uint32_t index_, Array &array__) const
Gets an array entry from the array by index.
virtual bool setStringEntry(const uint32_t index_, const std::string &value_)
Sets a string entry in the array by index.
virtual AIArrayRef aiArrayRef() const
Gets the array ref around which the target object is wrapped.
Embodies Illustrator's array storage containers; can be placed inside a dictionary or another array...
Definition: hdicoreaiArray.h:32
virtual bool operator!=(const Array &rhs_) const
Tests whether a given Array object is not the same as another.
virtual bool getDictEntry(const uint32_t index_, Dictionary &dict__) const
Gets a dictionary entry from the array by index.
virtual bool getFloatEntry(const uint32_t index_, double &value__) const
Gets a floating point entry from the array by index.
virtual bool swapEntries(const uint32_t index1_, const uint32_t index2_)
Swaps entries in the target Array object.
virtual bool getEntry(const uint32_t index_, Entry &e__) const
Gets an entry from the array by index.
virtual Array duplicate() const
Duplicates the target Array object and the data it's wrapped around.
virtual bool setEntry(const uint32_t index_, const Entry &entry_)
Sets an entry in the array by index.