Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
hdicoreaiArray.h
Go to the documentation of this file.
1
7#ifndef __HDI_CORE_AI_ARRAY__
8#define __HDI_CORE_AI_ARRAY__
9
10#if defined(HDI_CORE_AIP_MODE)
11
12#include "hdicoreTypes.h"
13
14namespace hdi
15{
16 namespace aip
17 {
18 class IllustratorArray;
19 }
20
21 namespace core
22 {
23 class Art;
24 class UID;
25
26 namespace ai
27 {
28 class Entry;
29 class Dictionary;
30
34 class Array
35 {
36 public:
43
51 Array(const Array& a_);
52
60 Array(const AIArrayRef aiArray_);
61
67 virtual ~Array();
68
79 virtual Array& operator=(const Array& rhs_);
80
89 virtual bool operator==(const Array& rhs_) const;
90
99 virtual bool operator!=(const Array& rhs_) const;
100
115 virtual AIArrayRef aiArrayRef() const;
116
127 virtual bool getEntry(const uint32_t index_, Entry& e__) const;
128
141 virtual bool setEntry(const uint32_t index_, const Entry& entry_);
142
151 virtual bool appendEntry(const Entry& entry_);
152
161 virtual bool deleteEntry(const uint32_t index_);
162
170 virtual uint32_t count() const;
171
181 virtual bool getArrayEntry(const uint32_t index_, Array& array__) const;
182
195 virtual bool setArrayEntry(const uint32_t index_, const Array& value_);
196
206 virtual bool getDictEntry(const uint32_t index_, Dictionary& dict__) const;
207
220 virtual bool setDictEntry(const uint32_t index_, const Dictionary& value_);
221
231 virtual bool getBoolEntry(const uint32_t index_, bool& value__) const;
232
245 virtual bool setBoolEntry(const uint32_t index_, const bool value_);
246
256 virtual bool getIntEntry(const uint32_t index_, int64_t& value__) const;
257
270 virtual bool setIntEntry(const uint32_t index_, const int64_t value_);
271
281 virtual bool getFloatEntry(const uint32_t index_, double& value__) const;
282
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 aip::IllustratorArray* __accessImpl(const Array&);
408 friend Array __accessCtor(const aip::IllustratorArray&);
409
413 aip::IllustratorArray* __impl;
414
420 Array(const aip::IllustratorArray&);
421 };
422
423 typedef std::unique_ptr<Array> ArrayUP;
424 typedef std::shared_ptr<Array> ArraySP;
425 typedef std::weak_ptr<Array> ArrayWP;
426
427 extern aip::IllustratorArray* __accessImpl(const Array&);
428 extern Array __accessCtor(const aip::IllustratorArray&);
429 }
430 }
431}
432
433#endif
434// HDI_CORE_AIP_MODE
435
436#endif
437// __HDI_CORE_AI_ARRAY__
Handles general art-related functionality.
Definition: hdicoreArt.h:51
Allows for easy UID acquisition, art access, etc.
Definition: hdicoreUID.h:32
Embodies Illustrator's array storage containers; can be placed inside a dictionary or another array.
Definition: hdicoreaiArray.h:35
virtual bool getIntEntry(const uint32_t index_, int64_t &value__) const
Gets an integer entry from the array by index.
virtual bool operator!=(const Array &rhs_) const
Tests whether a given Array object is not the same as another.
virtual AIArrayRef aiArrayRef() const
Gets the array ref around which the target object is wrapped.
virtual ~Array()
Destructs an Array object.
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.
virtual bool setFloatEntry(const uint32_t index_, const double value_)
Sets a floating point entry in 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 setDictEntry(const uint32_t index_, const Dictionary &value_)
Sets a dictionary entry in the array by index.
virtual uint32_t count() const
Gets the count of the array elements.
virtual bool getFloatEntry(const uint32_t index_, double &value__) const
Gets a floating point entry from the array by index.
virtual bool getArtEntry(const uint32_t index_, Art &art__) const
Gets an Art entry from the array by index.
virtual bool getDictEntry(const uint32_t index_, Dictionary &dict__) const
Gets a dictionary 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 appendEntry(const Entry &entry_)
Appends an entry to the end of the array.
virtual bool setBoolEntry(const uint32_t index_, const bool value_)
Sets a bool entry in the array by index.
virtual bool setStringEntry(const uint32_t index_, const std::string &value_)
Sets a string entry in the array by index.
Array(const AIArrayRef aiArray_)
Constructs a new Array object from an AIArrayRef.
virtual Array & operator=(const Array &rhs_)
Overloaded assignment operator for Array objects.
virtual bool operator==(const Array &rhs_) const
Tests whether a given Array object is the same as another.
virtual bool getEntry(const uint32_t index_, Entry &e__) const
Gets an entry from the array by index.
virtual bool deleteEntry(const uint32_t index_)
Removes an entry in the array by index.
virtual bool getUIDEntry(const uint32_t index_, UID &uid__) const
Gets a UID entry from the array by index.
virtual bool setArrayEntry(const uint32_t index_, const Array &value_)
Sets an array entry in the array by index.
virtual bool setEntry(const uint32_t index_, const Entry &entry_)
Sets an entry in the array by index.
virtual bool getBoolEntry(const uint32_t index_, bool &value__) const
Gets a bool entry from the array by index.
virtual bool clear()
Removes all entries from the array.
virtual bool setArtEntry(const uint32_t index_, const Art &value_)
Sets an Art entry in the array by index.
virtual Array duplicate() const
Duplicates the target Array object and the data it's wrapped around.
virtual bool setIntEntry(const uint32_t index_, const int64_t value_)
Sets an integer entry in the array by index.
Array(const Array &a_)
Array copy constructor.
Array()
Constructs an Array object as a new data container.
Embodies Illustrator's dictionary storage containers; can be placed inside an array,...
Definition: hdicoreaiDictionary.h:36
Illustrator entry wrapper class to allow for entry creation, manipulation, storage,...
Definition: hdicoreaiEntry.h:35
Header file for a wide variety of necessary typedefs, enums, and forwards declarations.