Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
hdicoreTreeColumnEntry.h
Go to the documentation of this file.
1 
8 #ifndef __HDI_CORE_TREE_COLUMN_ENTRY__
9 #define __HDI_CORE_TREE_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 TreeColumnEntryData;
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 
53 
63 
76  const std::string& id_,
77  const ValueVector& values_,
78  const DataVector& userData_,
79  const bool enabled_ = true,
80  const bool expanded_ = false
81  );
82 
88  virtual ~TreeColumnEntry();
89 
99  virtual TreeColumnEntry& operator=(const TreeColumnEntry& rhs_);
100 
109  virtual bool isEmpty() const;
110 
118  virtual std::string entryID() const;
119 
130  virtual void setEntryID(const std::string& id_);
131 
139  virtual ValueVector values() const;
140 
148  virtual void setValues(const ValueVector& values_);
149 
157  virtual bool enabled() const;
158 
166  virtual void setEnabled(const bool enabled_);
167 
175  virtual bool expanded() const;
176 
184  virtual void setExpanded(const bool exp_);
185 
193  virtual DataVector userData() const;
194 
202  virtual void setUserData(const DataVector& data_);
203 
211  virtual uint32_t childCount() const;
212 
221  virtual std::auto_ptr<TreeColumnEntry> childAtIndex(const uint32_t index_) const;
222 
231  virtual bool pushChild(const TreeColumnEntry& child_);
232 
241  virtual bool popChild(TreeColumnEntry& child__);
242 
251  virtual bool operator==(const TreeColumnEntry& rhs_) const;
252 
261  virtual bool operator!=(const TreeColumnEntry& rhs_) const;
262 
263 
264  private:
265  friend plugin::TreeColumnEntryData* __accessImpl(const TreeColumnEntry&);
266 
270  void* __data;
271 
277  void* __impl() const;
278  };
279 
280  typedef std::auto_ptr<TreeColumnEntry> TreeColumnEntryAP;
281 
282  extern plugin::TreeColumnEntryData* __accessImpl(const TreeColumnEntry&);
283  }
284 }
285 
286 #endif
287 // __HDI_CORE_TREE_COLUMN_ENTRY__
virtual TreeColumnEntry & operator=(const TreeColumnEntry &rhs_)
Assigns one TreeColumnEntry object to another.
virtual bool popChild(TreeColumnEntry &child__)
Pops an existing entry off the end of the list of children of the target entry.
virtual void setExpanded(const bool exp_)
Sets whether the entry is expanded (i.e. its children are visible)
static const char * separatorValue
When you want a separator in a container widget, create a TreeColumnEntry object with this as its str...
Definition: hdicoreTreeColumnEntry.h:39
virtual uint32_t childCount() const
Gets the count of child entries in the target entry.
virtual bool operator==(const TreeColumnEntry &rhs_) const
Tests whether a given TreeColumnEntry object is the same as another.
virtual void setValues(const ValueVector &values_)
Sets the value objects of an entry.
virtual ValueVector values() const
Gets the value objects of an entry.
Header file for storing entry string values or image IDs.
virtual bool enabled() const
Gets whether the entry should be enabled (selectable by the user in the list)
virtual DataVector userData() const
Gets the custom data of an entry.
virtual ~TreeColumnEntry()
Destructs a TreeColumnEntry object.
virtual bool isEmpty() const
Gets whether the target TreeColumnEntry object is empty (constructed with the default ctor) ...
Allows hierarchical column views to store more data than simply strings and indices.
Definition: hdicoreTreeColumnEntry.h:29
Header file for a variety of Illustrator plugin convenience macros.
virtual void setEnabled(const bool enabled_)
Sets whether the entry should be enabled (selectable by the user in the list)
Definition: hdicoreaiArray.h:12
virtual std::string entryID() const
Gets the ID string of an entry.
TreeColumnEntry()
Constructs an empty TreeColumnEntry object.
virtual bool operator!=(const TreeColumnEntry &rhs_) const
Tests whether a given TreeColumnEntry object is not the same as another.
virtual void setEntryID(const std::string &id_)
Sets the ID string of an entry.
virtual void setUserData(const DataVector &data_)
Sets the custom data of an entry.
virtual std::auto_ptr< TreeColumnEntry > childAtIndex(const uint32_t index_) const
Gets a specific child of the target entry.
virtual bool expanded() const
Gets whether the entry is expanded (i.e. its children are visible)
virtual bool pushChild(const TreeColumnEntry &child_)
Pushes a new entry onto the end of the list of children of the target entry.