Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
hdicoreColumnEntry.h
Go to the documentation of this file.
1 
8 #ifndef __HDI_CORE_COLUMN_ENTRY__
9 #define __HDI_CORE_COLUMN_ENTRY__
10 
11 #include <vector>
12 
13 #include "hdicoreMacros.h"
14 
15 #include "hdicoreEntryValue.h"
16 
17 namespace hdi
18 {
19  namespace plugin
20  {
21  class ColumnEntryData;
22  }
23 
24  namespace core
25  {
30  {
31  public:
32  typedef std::vector<EntryValue> ValueVector;
33  typedef std::vector< void* > DataVector;
34 
39  static const char* separatorValue;
40 
52  ColumnEntry();
53 
62  ColumnEntry(const ColumnEntry& e_);
63 
75  const std::string& id_,
76  const ValueVector& values_,
77  const DataVector& userData_,
78  const bool enabled_ = true
79  );
80 
86  virtual ~ColumnEntry();
87 
97  virtual ColumnEntry& operator=(const ColumnEntry& rhs_);
98 
107  virtual bool isEmpty() const;
108 
116  virtual std::string entryID() const;
117 
128  virtual void setEntryID(const std::string& id_);
129 
137  virtual ValueVector values() const;
138 
146  virtual void setValues(const ValueVector& values_);
147 
155  virtual bool enabled() const;
156 
164  virtual void setEnabled(const bool enabled_);
165 
173  virtual DataVector userData() const;
174 
182  virtual void setUserData(const DataVector& data_);
183 
192  virtual bool operator==(const ColumnEntry& rhs_) const;
193 
202  virtual bool operator!=(const ColumnEntry& rhs_) const;
203 
204 
205  private:
206  friend plugin::ColumnEntryData* __accessImpl(const ColumnEntry&);
207 
211  void* __data;
212 
218  void* __impl() const;
219  };
220 
221  typedef std::auto_ptr<ColumnEntry> ColumnEntryAP;
222 
223  extern plugin::ColumnEntryData* __accessImpl(const ColumnEntry&);
224  }
225 }
226 
227 #endif
228 // __HDI_CORE_COLUMN_ENTRY__
virtual void setEnabled(const bool enabled_)
Sets whether the entry should be enabled (selectable by the user in the list)
virtual DataVector userData() const
Gets the custom data of an entry.
static const char * separatorValue
When you want a separator in a container widget, create a ColumnEntry object with this as its string ...
Definition: hdicoreColumnEntry.h:39
ColumnEntry()
Constructs an empty ColumnEntry object.
virtual ValueVector values() const
Gets the value objects of an entry.
virtual bool operator==(const ColumnEntry &rhs_) const
Tests whether a given ColumnEntry object is the same as another.
virtual std::string entryID() const
Gets the ID string of an entry.
Header file for storing entry string values or image IDs.
virtual bool isEmpty() const
Gets whether the target ColumnEntry object is empty (constructed with the default ctor) ...
virtual bool operator!=(const ColumnEntry &rhs_) const
Tests whether a given ColumnEntry object is not the same as another.
virtual void setEntryID(const std::string &id_)
Sets the ID string of an entry.
Header file for a variety of Illustrator plugin convenience macros.
virtual ~ColumnEntry()
Destructs a ColumnEntry object.
Definition: hdicoreaiArray.h:12
virtual void setUserData(const DataVector &data_)
Sets the custom data of an entry.
virtual bool enabled() const
Gets whether the entry should be enabled (selectable by the user in the list)
Allows column views to store more data than simply strings and indices.
Definition: hdicoreColumnEntry.h:29
virtual ColumnEntry & operator=(const ColumnEntry &rhs_)
Assigns one ColumnEntry object to another.
virtual void setValues(const ValueVector &values_)
Sets the value objects of an entry.