Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
|
Column view widget, much like a list view but allowing for entries with multiple columns. More...
#include <hdicoreColumnView.h>
Public Types | |
typedef std::vector< ColumnEntry > | EntryVector |
typedef std::vector< std::string > | ColumnNameVector |
typedef std::vector< double > | ColumnWidthVector |
Public Types inherited from hdi::core::Widget | |
enum | Type { UnknownType = 0 , BoxType = 10 , ButtonType = 20 , CheckboxType = 30 , ColumnViewType = 40 , ComboBoxType = 50 , ColorWellType = 60 , CustomType = 70 , DividerType = 80 , HierarchicalColumnViewType = 85 , HierarchicalViewType = 90 , LabelType = 100 , ListViewType = 110 , PopupMenuType = 120 , RadioButtonType = 130 , SliderType = 140 , StepperType = 150 , TextFieldType = 160 , TextViewType = 170 , WebViewType = 180 } |
Supported widget types. | |
Public Member Functions | |
ColumnView () | |
Constructs an empty ColumnView object. | |
ColumnView (const ColumnView &colView_) | |
Constructs a new ColumnView object from an existing ColumnView object (copy constructor) | |
ColumnView (const Rect &frame_, const uint16_t numCols_) | |
Constructs a column view with a frame only, no contents. | |
ColumnView (const Rect &frame_, const ColumnNameVector &colNames_) | |
Constructs a column view with a frame only, no contents. | |
ColumnView (const Rect &frame_, const uint16_t numCols_, const EntryVector &entries_, const int32_t index_) | |
Constructs a column view. | |
ColumnView (const Rect &frame_, const ColumnNameVector &colNames_, const EntryVector &entries_, const int32_t index_) | |
Constructs a column view. | |
ColumnView (const Rect &frame_, const uint16_t numCols_, const EntryVector &entries_, const std::string &initialID_) | |
Constructor for a column view with an initial ID selected. | |
ColumnView (const Rect &frame_, const ColumnNameVector &colNames_, const EntryVector &entries_, const std::string &initialID_) | |
Constructor for a column view with an initial ID selected. | |
virtual ColumnView & | operator= (const ColumnView &rhs_) |
Allows one ColumnView object to be assigned from another. | |
virtual | ~ColumnView () |
ColumnView destructor. | |
virtual ColumnView * | clone () const |
Convenience method to clone a ColumnView object on the heap. | |
virtual ColumnView * | duplicate () const |
Convenience method to duplicate a ColumnView object, creating a new and identical UI element to the target (but not belonging to the same containing window) | |
virtual void | deselectAll () |
Deselects all currently selected entries in the list. | |
virtual std::string | text () const |
Gets the current text value of the list. | |
virtual void | setText (const std::string &) |
Does nothing. | |
virtual int32_t | currentIndex () const |
Gets the index of the currently selected entry. | |
virtual bool | setCurrentIndex (const int32_t index_) |
Sets the currently selected entry by index. | |
virtual std::string | currentID () const |
Gets the ID of the currently selected entry. | |
virtual bool | setCurrentID (const std::string &id_) |
Sets the currently selected entry by ID. | |
virtual std::unique_ptr< ColumnEntry > | currentEntry () const |
Gets the current entry object. | |
virtual const std::vector< std::shared_ptr< ColumnEntry > > *const | entries () const |
Gets the entries vector. | |
virtual bool | hasEntry (const std::string &id_) const |
Gets whether the entries vector already contains an entry, based on its ID. | |
virtual std::shared_ptr< ColumnEntry > | entryWithID (const std::string &id_) const |
Gets the entry with the given ID, provided it exists within the widget. | |
virtual void | setEntries (const EntryVector &entries_) |
Allows the entries in a column view to be changed out entirely. | |
virtual bool | pushEntry (const ColumnEntry &entry_) |
Pushes an entry onto the list (i.e. at the end) | |
virtual bool | popEntry (ColumnEntry &entry__) |
Pops an entry off the list (i.e. from the end) | |
virtual bool | insertEntry (const std::string &id_, const ColumnEntry &entry_) |
Inserts an entry into the list of entries at a given position. | |
virtual bool | removeEntry (const std::string &id_, ColumnEntry &entry__) |
Removes a specific entry from the list of entries. | |
virtual bool | reorderEntry (const std::string &targetID_, const std::string &positionID_) |
Reorders a target entry (based on ID) to be newly located just after another existing entry in the list. | |
virtual void | clearEntries () |
Clears all entries contained by the widget. | |
virtual bool | hasHeader () const |
Gets whether the widget has a header component to show the names of the columns. | |
virtual uint16_t | columnCount () const |
Gets the number of columns in the widget. | |
virtual ColumnNameVector | columnNames () const |
Gets the column names vector. | |
virtual ColumnWidthVector | columnWidths () const |
Gets the widths of each column in the view. | |
virtual void | setColumnWidths (const ColumnWidthVector &widths_) |
Sets the widths of each column in the view. | |
virtual bool | columnWidthsLocked () const |
Gets whether the column widths are locked (i.e. the user cannot change them) | |
virtual void | setColumnWidthsLocked (const bool locked_) |
Sets whether the column widths are locked (i.e. the user cannot change them) | |
virtual void | valueChanged () |
Simulates the column view having its value changed. | |
virtual Callback *const | valueChangedCallback () const |
Gets the value changed callback for the column view. | |
virtual void | setValueChangedCallback (const Callback &callback_) |
Sets the value changed callback. | |
virtual void | update () |
Force the column view to update its entries. | |
virtual Callback *const | cellClickCallback () const |
Gets the callback set for when a cell is clicked. | |
virtual void | setCellClickCallback (const Callback &callback_) |
Sets/updates the callback for when a cell is clicked. | |
virtual std::unique_ptr< ColumnEntry > | clickedEntry () const |
Gets the entry of the cell that was last clicked. | |
virtual int32_t | clickedColumnIndex () const |
Gets the column index of the cell in the entry that was last clicked. | |
virtual Callback *const | cellChangedCallback () const |
Gets the callback for when a cell is modified via double-click inline editing. | |
virtual void | setCellChangedCallback (const Callback &callback_) |
Sets the callback for when a cell is modified via double-click inline editing. | |
virtual std::unique_ptr< ColumnEntry > | changedEntry () const |
Gets the entry that was last modified via double-click inline editing. | |
virtual int32_t | changedColumnIndex () const |
Gets the column index of the cell in the entry that was last modified. | |
virtual bool | reorderable () const |
Gets whether reordering support for the list is enabled. | |
virtual void | setReorderable (const bool enable_) |
Sets whether reordering support for the list is enabled. | |
virtual Callback *const | potentialReorderCallback () const |
Gets the current potential-reorder callback for the list. | |
virtual void | setPotentialReorderCallback (const Callback &callback_) |
Sets the potential-reorder callback for the widget. | |
virtual std::vector< std::string > | potentialReorderSource () const |
Gets the source item involved in the potential reorder, i.e. the entry being dragged. | |
virtual std::vector< std::string > | potentialReorderPosition () const |
Gets the position for the reorder, i.e. the entry just before the proposed reposition. | |
virtual bool | potentialReorderGood () const |
Gets whether the potential reorder is acceptable; if not, the drag cursor will indicate the proposed drop position is not allowed. | |
virtual void | setPotentialReorderGood (const bool good_) |
Sets whether the potential reorder is acceptable; if not, the drag cursor will indicate the proposed drop position is not allowed. | |
virtual Callback *const | reorderCallback () const |
Gets the current reorder callback for the widget. | |
virtual void | setReorderCallback (const Callback &callback_) |
Sets the reorder callback for the widget. | |
virtual std::vector< std::string > | reorderSource () const |
Gets the source item involved in the reorder, i.e. the entry being dropped. | |
virtual std::vector< std::string > | reorderPosition () const |
Gets the position for the reorder, i.e. the entry just before the reposition. | |
Public Member Functions inherited from hdi::core::Widget | |
virtual | ~Widget () |
Destructs a Widget. | |
virtual Widget * | clone () const =0 |
Convenience method to clone a Widget object in memory, taking its subclass type into account. | |
virtual Widget * | duplicate () const =0 |
Convenience method to duplicate a Widget object, creating a new and identical UI element to the target (but not belonging to the same containing window) | |
virtual PlatformWidgetPtr | platformWidget () const |
Gets the platform-specific widget, around which the target object is wrapped. | |
virtual bool | isEmpty () const |
Gets whether the target Widget object is empty (constructed with the default ctor) | |
virtual bool | operator== (const Widget &rhs_) const |
Tests whether a given Widget object is the same as another. | |
virtual bool | operator!= (const Widget &rhs_) const |
Tests whether a given Widget object is not the same as another. | |
virtual Type | type () const |
Gets the type of the widget. | |
virtual Window *const | window () const |
Gets the parent window of the widget. | |
virtual Rect | frame () const |
Gets the widget frame. | |
virtual void | setFrame (const Rect &frame_) |
Sets the widget frame. | |
virtual void | offset (const double x_, const double y_) |
Offsets the widget from its current location by the given amounts, in 1x resolution coordinates. | |
virtual std::string | text () const |
Gets the current text value of the widget. | |
virtual void | setText (const std::string &text_) |
Sets the current text value of the widget. | |
virtual bool | enabled () |
Gets whether the widget is enabled. | |
virtual void | setEnabled (const bool enable_) |
Enables or disables the widget. | |
virtual bool | visible () |
Gets whether the widget is visible. | |
virtual void | setVisible (const bool visible_) |
Shows or hides the widget. | |
virtual void | setOrigin (const Point &p_) |
Convenience method to set just the origin of the target widget's frame. | |
virtual void | setSize (const Size &s_) |
Convenience method to set just the size of the target widget's frame. | |
virtual void | setWidth (const double w_) |
Convenience method to set just the width of the target widget's frame. | |
virtual void | setHeight (const double h_) |
Convenience method to set just the height of the target widget's frame. | |
virtual bool | hasFocus () const |
Gets whether the widget currently has focus. | |
virtual void | focus () const |
Forces the widget to have focus, taking it from any other focused widget of the same window. | |
virtual Callback *const | focusCallback () const |
Gets the current focus callback for the widget. | |
virtual void | setFocusCallback (const Callback &callback_) |
Sets the focus callback for the widget. | |
virtual void | blur () const |
Removes focus from the widget. | |
virtual Callback *const | blurCallback () const |
Gets the current blur callback for the widget. | |
virtual void | setBlurCallback (const Callback &callback_) |
Sets the blur callback for the widget. | |
virtual std::string | tooltip () const |
Gets the tool tip string for the widget. | |
virtual void | setTooltip (const std::string &tip_) |
Sets the tool tip string for the widget. | |
virtual void | update () |
Force the widget to update (i.e. cause it to redraw) | |
Additional Inherited Members | |
Static Public Member Functions inherited from hdi::core::Widget | |
static bool | isCoreWidget (const PlatformWidgetPtr widget_) |
Gets whether the given platform widget is a hdi_core widget. | |
static std::unique_ptr< Widget > | lastClickedWidget () |
Gets the last widget that received a click event (either by the user or programmatically) | |
static std::unique_ptr< Widget > | lastValueChangingWidget () |
Gets the last widget that received a value changing event (either by the user or programmatically) | |
static std::unique_ptr< Widget > | lastValueChangedWidget () |
Gets the last widget that received a value changed event (either by the user or programmatically) | |
static std::unique_ptr< Widget > | lastDropWidget () |
Gets the last widget that received a drag-and-drop drop event (either by the user or programmatically) | |
static std::unique_ptr< Widget > | lastPotentialReorderWidget () |
Gets the last widget that received a potential-reorder event. | |
static std::unique_ptr< Widget > | lastReorderWidget () |
Gets the last widget that received a reorder event. | |
Protected Member Functions inherited from hdi::core::Widget | |
void * | _impl () const |
Internal use only. | |
Widget () | |
Constructs an empty Widget object. | |
Widget (const Widget &w_) | |
Constructs a new Widget object from an existing Widget object (copy constructor) | |
Widget (pui::Widget *&) | |
Internal use only. | |
virtual Widget & | operator= (const Widget &) |
Internal use only. | |
Protected Attributes inherited from hdi::core::Widget | |
void * | _data |
Private implementation data. | |
Column view widget, much like a list view but allowing for entries with multiple columns.
hdi::core::ColumnView::ColumnView | ( | ) |
Constructs an empty ColumnView object.
hdi::core::ColumnView::ColumnView | ( | const ColumnView & | colView_ | ) |
Constructs a new ColumnView object from an existing ColumnView object (copy constructor)
colView_ | Existing ColumnView object |
hdi::core::ColumnView::ColumnView | ( | const Rect & | frame_, |
const uint16_t | numCols_ | ||
) |
Constructs a column view with a frame only, no contents.
frame_ | Position and size of the list, in 1x resolution coordinates |
numCols_ | The number of columns in the list |
hdi::core::ColumnView::ColumnView | ( | const Rect & | frame_, |
const ColumnNameVector & | colNames_ | ||
) |
Constructs a column view with a frame only, no contents.
frame_ | Position and size of the list, in 1x resolution coordinates |
colNames_ | Names of each of the columns - also controls the number of columns in the list |
hdi::core::ColumnView::ColumnView | ( | const Rect & | frame_, |
const uint16_t | numCols_, | ||
const EntryVector & | entries_, | ||
const int32_t | index_ | ||
) |
Constructs a column view.
frame_ | Position and size of the list, in 1x resolution coordinates |
numCols_ | The number of columns in the list |
entries_ | Vector of entries |
index_ | Initial index to select (must exist in entries_) |
hdi::core::ColumnView::ColumnView | ( | const Rect & | frame_, |
const ColumnNameVector & | colNames_, | ||
const EntryVector & | entries_, | ||
const int32_t | index_ | ||
) |
Constructs a column view.
frame_ | Position and size of the list, in 1x resolution coordinates |
colNames_ | Names of each of the columns - also controls the number of columns in the list |
entries_ | Vector of entries |
index_ | Initial index to select (must exist in entries_) |
hdi::core::ColumnView::ColumnView | ( | const Rect & | frame_, |
const uint16_t | numCols_, | ||
const EntryVector & | entries_, | ||
const std::string & | initialID_ | ||
) |
Constructor for a column view with an initial ID selected.
frame_ | Position and size of the list, in 1x resolution coordinates |
numCols_ | The number of columns in the list |
entries_ | Vector of entries |
initialID_ | Initial ID to select (must exist in entries_, and must not be a separator), as UTF-8 |
hdi::core::ColumnView::ColumnView | ( | const Rect & | frame_, |
const ColumnNameVector & | colNames_, | ||
const EntryVector & | entries_, | ||
const std::string & | initialID_ | ||
) |
Constructor for a column view with an initial ID selected.
frame_ | Position and size of the list, in 1x resolution coordinates |
colNames_ | Names of each of the columns - also controls the number of columns in the list |
entries_ | Vector of entries |
initialID_ | Initial ID to select (must exist in entries_, and must not be a separator), as UTF-8 |
|
virtual |
ColumnView destructor.
|
virtual |
Gets the callback for when a cell is modified via double-click inline editing.
|
virtual |
Gets the callback set for when a cell is clicked.
|
virtual |
Gets the column index of the cell in the entry that was last modified.
|
virtual |
Gets the entry that was last modified via double-click inline editing.
|
virtual |
Clears all entries contained by the widget.
|
virtual |
Gets the column index of the cell in the entry that was last clicked.
|
virtual |
Gets the entry of the cell that was last clicked.
|
virtual |
Convenience method to clone a ColumnView object on the heap.
Implements hdi::core::Widget.
|
virtual |
Gets the number of columns in the widget.
|
virtual |
Gets the column names vector.
|
virtual |
Gets the widths of each column in the view.
|
virtual |
Gets whether the column widths are locked (i.e. the user cannot change them)
|
virtual |
Gets the current entry object.
|
virtual |
Gets the ID of the currently selected entry.
|
virtual |
Gets the index of the currently selected entry.
|
virtual |
Deselects all currently selected entries in the list.
|
virtual |
Convenience method to duplicate a ColumnView object, creating a new and identical UI element to the target (but not belonging to the same containing window)
Implements hdi::core::Widget.
|
virtual |
Gets the entries vector.
|
virtual |
Gets the entry with the given ID, provided it exists within the widget.
id_ | ID of the entry to search for |
|
virtual |
Gets whether the entries vector already contains an entry, based on its ID.
id_ | ID of the entry to search for, as UTF-8 |
|
virtual |
Gets whether the widget has a header component to show the names of the columns.
|
virtual |
Inserts an entry into the list of entries at a given position.
id_ | Existing entry immediately before the position at which the new entry will be inserted, as UTF-8 |
entry_ | New entry object to insert into the list of entries |
|
virtual |
Allows one ColumnView object to be assigned from another.
rhs_ | Righthand side of the = operator; the object to copy values from |
|
virtual |
Pops an entry off the list (i.e. from the end)
entry__ | Return-by-reference for the popped entry, so the caller can inspect which one was removed |
|
virtual |
Gets the current potential-reorder callback for the list.
|
virtual |
Gets whether the potential reorder is acceptable; if not, the drag cursor will indicate the proposed drop position is not allowed.
|
virtual |
Gets the position for the reorder, i.e. the entry just before the proposed reposition.
|
virtual |
Gets the source item involved in the potential reorder, i.e. the entry being dragged.
|
virtual |
Pushes an entry onto the list (i.e. at the end)
entry_ | New entry object to insert into the list of entries |
|
virtual |
Removes a specific entry from the list of entries.
id_ | ID of the entry to be removed, as UTF-8 |
entry__ | Return-by-reference for the removed entry, so the caller can inspect which one was removed |
|
virtual |
Gets whether reordering support for the list is enabled.
|
virtual |
Gets the current reorder callback for the widget.
|
virtual |
Reorders a target entry (based on ID) to be newly located just after another existing entry in the list.
targetID_ | ID of an existing entry in the list to be relocated |
positionID_ | ID of an existing entry immediately before the position at which targetID_ should be moved; if the passed value is an empty string, targetID_ will be repositioned at the beginning |
|
virtual |
Gets the position for the reorder, i.e. the entry just before the reposition.
|
virtual |
Gets the source item involved in the reorder, i.e. the entry being dropped.
|
virtual |
Sets the callback for when a cell is modified via double-click inline editing.
callback_ | New callback for a user modifying a cell via inline editing |
|
virtual |
Sets/updates the callback for when a cell is clicked.
callback_ | New callback for a user clicking a cell |
|
virtual |
Sets the widths of each column in the view.
widths_ | Vector of new column widths to set, at 1x resolution |
|
virtual |
Sets whether the column widths are locked (i.e. the user cannot change them)
locked_ | true to lock widths, false otherwise |
|
virtual |
Sets the currently selected entry by ID.
id_ | ID of new value to select in the column view, as UTF-8 |
|
virtual |
Sets the currently selected entry by index.
index_ | New index to select |
|
virtual |
Allows the entries in a column view to be changed out entirely.
entries_ | New set of entries that the widget will contain |
|
virtual |
Sets the potential-reorder callback for the widget.
callback_ | New callback (target and action) for each time the potential reorder target changes |
|
virtual |
Sets whether the potential reorder is acceptable; if not, the drag cursor will indicate the proposed drop position is not allowed.
good_ | Whether the potential reorder position is acceptable |
|
virtual |
Sets whether reordering support for the list is enabled.
enable_ | true to enable drag-and-drop reordering support, false otherwise |
|
virtual |
Sets the reorder callback for the widget.
callback_ | New callback (target and action) for when a reorder is finalized (via dropping) |
|
virtual |
Does nothing.
Reimplemented from hdi::core::Widget.
|
virtual |
Sets the value changed callback.
callback_ | New callback for when the column view's value has changed |
|
virtual |
Gets the current text value of the list.
Reimplemented from hdi::core::Widget.
|
virtual |
|
virtual |
Simulates the column view having its value changed.
|
virtual |
Gets the value changed callback for the column view.