Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
|
Allows hierarchical column views to store more data than simply strings and indices. More...
#include <hdicoreTreeColumnEntry.h>
Public Types | |
typedef std::vector< EntryValue > | ValueVector |
typedef std::vector< bool > | EditableVector |
typedef std::vector< void * > | DataVector |
Public Member Functions | |
TreeColumnEntry () | |
Constructs an empty TreeColumnEntry object. | |
TreeColumnEntry (const TreeColumnEntry &e_) | |
Constructs a new TreeColumnEntry object from an existing TreeColumnEntry object (copy constructor) | |
TreeColumnEntry (const std::string &id_, const ValueVector &values_, const DataVector &userData_, const bool enabled_, const bool expanded_, const EditableVector &editable_) | |
Constructs a TreeColumnEntry object with some custom data. | |
virtual | ~TreeColumnEntry () |
Destructs a TreeColumnEntry object. | |
virtual TreeColumnEntry & | operator= (const TreeColumnEntry &rhs_) |
Assigns one TreeColumnEntry object to another. | |
virtual bool | isEmpty () const |
Gets whether the target TreeColumnEntry object is empty (constructed with the default ctor) | |
virtual std::vector< std::string > | idPath () const |
Gets the full ID path of the target entry. | |
virtual std::string | entryID () const |
Gets the ID string of an entry. | |
virtual void | setEntryID (const std::string &id_) |
Sets the ID string of an entry. | |
virtual ValueVector | values () const |
Gets the value objects of an entry. | |
virtual void | setValues (const ValueVector &values_) |
Sets the value objects of an entry. | |
virtual bool | enabled () const |
Gets whether the entry should be enabled (selectable by the user in the list) | |
virtual void | setEnabled (const bool enabled_) |
Sets whether the entry should be enabled (selectable by the user in the list) | |
virtual bool | expanded () const |
Gets whether the entry is expanded (i.e. its children are visible) | |
virtual void | setExpanded (const bool exp_) |
Sets whether the entry is expanded (i.e. its children are visible) | |
virtual EditableVector | editable () const |
Gets the editability of each cell in the entry (whether the user can edit it inline) | |
virtual void | setEditable (const EditableVector &editable_) |
Sets the editability of each cell in the entry (whether the user can edit it inline) | |
virtual DataVector | userData () const |
Gets the custom data of an entry. | |
virtual void | setUserData (const DataVector &data_) |
Sets the custom data of an entry. | |
virtual bool | hasChild (const std::string &id_) const |
Gets whether the entry has a child with the given ID string. | |
virtual std::unique_ptr< TreeColumnEntry > | childWithID (const std::string &id_) const |
Get the child entry with the given ID string, if it exists within the target. | |
virtual uint32_t | childCount () const |
Gets the count of child entries in the target entry. | |
virtual std::unique_ptr< TreeColumnEntry > | childAtIndex (const uint32_t index_) const |
Gets a specific child of the target entry. | |
virtual bool | pushChild (const TreeColumnEntry &child_) |
Pushes a new entry onto the end of the list of children of the target entry. | |
virtual bool | popChild (TreeColumnEntry &child__) |
Pops an existing entry off the end of the list of children of the target entry. | |
virtual bool | insertChild (const std::string &id_, const TreeColumnEntry &child_) |
Inserts an entry into the list of child entries at a given position. | |
virtual bool | removeChild (const std::string &id_, TreeColumnEntry &child__) |
Removes a specific entry from the list of child entries. | |
virtual bool | operator== (const TreeColumnEntry &rhs_) const |
Tests whether a given TreeColumnEntry object is the same as another. | |
virtual bool | operator!= (const TreeColumnEntry &rhs_) const |
Tests whether a given TreeColumnEntry object is not the same as another. | |
Static Public Attributes | |
static const char * | separatorValue |
When you want a separator in a container widget, create a TreeColumnEntry object with this as its string value. | |
Friends | |
pui::TreeColumnEntryData * | __accessImpl (const TreeColumnEntry &) |
Allows hierarchical column views to store more data than simply strings and indices.
hdi::core::TreeColumnEntry::TreeColumnEntry | ( | ) |
Constructs an empty TreeColumnEntry object.
hdi::core::TreeColumnEntry::TreeColumnEntry | ( | const TreeColumnEntry & | e_ | ) |
Constructs a new TreeColumnEntry object from an existing TreeColumnEntry object (copy constructor)
e_ | Existing TreeColumnEntry object |
hdi::core::TreeColumnEntry::TreeColumnEntry | ( | const std::string & | id_, |
const ValueVector & | values_, | ||
const DataVector & | userData_, | ||
const bool | enabled_, | ||
const bool | expanded_, | ||
const EditableVector & | editable_ | ||
) |
Constructs a TreeColumnEntry object with some custom data.
id_ | Entry ID string, as UTF-8 (must form a unique ID path in the target container) |
values_ | Entry value objects, one for each column |
userData_ | Data to store in each column of the entry |
enabled_ | Whether the entry should be enabled |
expanded_ | true to expand the entry, false to collapse |
editable_ | Whether each cell in the entry should be inline editable |
|
virtual |
Destructs a TreeColumnEntry object.
|
virtual |
Gets a specific child of the target entry.
index_ | Index of the desired child entry |
|
virtual |
Gets the count of child entries in the target entry.
|
virtual |
Get the child entry with the given ID string, if it exists within the target.
id_ | ID of the child to search for |
|
virtual |
Gets the editability of each cell in the entry (whether the user can edit it inline)
|
virtual |
Gets whether the entry should be enabled (selectable by the user in the list)
|
virtual |
Gets the ID string of an entry.
|
virtual |
Gets whether the entry is expanded (i.e. its children are visible)
|
virtual |
Gets whether the entry has a child with the given ID string.
id_ | ID of the child to search for |
|
virtual |
Gets the full ID path of the target entry.
|
virtual |
Inserts an entry into the list of child entries at a given position.
id_ | Existing entry immediately before the position at which the new entry will be inserted, as UTF-8; pass "" to insert at the beginning |
child_ | New entry object to insert into the list of children |
|
virtual |
Gets whether the target TreeColumnEntry object is empty (constructed with the default ctor)
|
virtual |
Tests whether a given TreeColumnEntry object is not the same as another.
rhs_ | TreeColumnEntry to compare against (righthand side of inequality operator) |
|
virtual |
Assigns one TreeColumnEntry object to another.
rhs_ | Existing TreeColumnEntry object to copy values from |
|
virtual |
Tests whether a given TreeColumnEntry object is the same as another.
rhs_ | TreeColumnEntry to compare against (righthand side of equality operator) |
|
virtual |
Pops an existing entry off the end of the list of children of the target entry.
child__ | Return-by-reference for the child entry that was removed |
|
virtual |
Pushes a new entry onto the end of the list of children of the target entry.
child_ | New child to add to the end of the list of children |
|
virtual |
Removes a specific entry from the list of child entries.
id_ | ID of the entry to be removed, as UTF-8 |
entry__ | Return-by-reference for the removed child, so the caller can inspect which one was removed |
|
virtual |
Sets the editability of each cell in the entry (whether the user can edit it inline)
enabled_ | true for enabled, false otherwise |
|
virtual |
Sets whether the entry should be enabled (selectable by the user in the list)
enabled_ | true for enabled, false otherwise |
|
virtual |
Sets the ID string of an entry.
id_ | New entry ID string, as UTF-8 |
|
virtual |
Sets whether the entry is expanded (i.e. its children are visible)
exp_ | true for expanded, false for collapsed |
|
virtual |
Sets the custom data of an entry.
data_ | New custom data to store |
|
virtual |
Sets the value objects of an entry.
values_ | New entry value objects |
|
virtual |
Gets the custom data of an entry.
|
virtual |
Gets the value objects of an entry.