Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
hdicoreListEntry.h
Go to the documentation of this file.
1 
7 #ifndef __HDI_CORE_LIST_ENTRY__
8 #define __HDI_CORE_LIST_ENTRY__
9 
10 #include "hdicoreTypes.h"
11 
12 namespace hdi
13 {
14  namespace plugin
15  {
16  class BaseEntryData;
17  }
18 
19  namespace core
20  {
24  class ListEntry
25  {
26  public:
31  static const char* separatorValue;
32 
44  ListEntry();
45 
53  ListEntry(const ListEntry& e_);
54 
66  ListEntry(const std::string& id_, const std::string& value_, void* userData_, const bool enabled_ = true);
67 
73  virtual ~ListEntry();
74 
84  virtual ListEntry& operator=(const ListEntry& rhs_);
85 
93  virtual bool isEmpty() const;
94 
102  virtual std::string entryID() const;
103 
114  virtual void setEntryID(const std::string& id_);
115 
123  virtual std::string value() const;
124 
132  virtual void setValue(const std::string& value_);
133 
141  virtual bool enabled() const;
142 
150  virtual void setEnabled(const bool enabled_);
151 
159  virtual void* const userData() const;
160 
168  virtual void setUserData(void* data_);
169 
178  virtual bool operator==(const ListEntry& rhs_) const;
179 
188  virtual bool operator!=(const ListEntry& rhs_) const;
189 
190 
191  private:
192  friend plugin::BaseEntryData* __accessImpl(const ListEntry&);
193 
197  void* __data;
198 
204  void* __impl() const;
205  };
206 
207  typedef std::auto_ptr<ListEntry> ListEntryAP;
208 
209  extern plugin::BaseEntryData* __accessImpl(const ListEntry&);
210  }
211 }
212 
213 #endif
214 // __HDI_CORE_LIST_ENTRY__
virtual void setValue(const std::string &value_)
Sets the string value of an entry (what the user sees in the popup/list/etc.)
virtual ListEntry & operator=(const ListEntry &rhs_)
Assigns one ListEntry object to another.
virtual ~ListEntry()
Destructs an ListEntry object.
virtual void *const userData() const
Gets the custom data of an entry.
virtual bool enabled() const
Gets whether the entry should be enabled (selectable by the user in the popup/list/etc.)
Allows combo boxes, popups, and lists to store more data than simply strings and indices.
Definition: hdicoreListEntry.h:24
virtual bool operator!=(const ListEntry &rhs_) const
Tests whether a given ListEntry object is not the same as another.
virtual void setEnabled(const bool enabled_)
Sets whether the entry should be enabled (selectable by the user in the popup/list/etc.)
Header file for a wide variety of necessary typedefs, enums, and forwards declarations.
virtual std::string value() const
Gets the string value of an entry (what the user sees in the popup/list/etc.)
virtual std::string entryID() const
Gets the ID string of an entry.
ListEntry()
Constructs an empty ListEntry object.
Definition: hdicoreaiArray.h:12
virtual void setUserData(void *data_)
Sets the custom data of an entry.
virtual bool isEmpty() const
Gets whether the target ListEntry object is empty (constructed with the default ctor) ...
virtual bool operator==(const ListEntry &rhs_) const
Tests whether a given ListEntry object is the same as another.
virtual void setEntryID(const std::string &id_)
Sets the ID string of an entry.
static const char * separatorValue
When you want a separator in a container widget, create a ListEntry object with this as its value...
Definition: hdicoreListEntry.h:31