List view widget, much like a popup menu but allowing for multiple entries to be seen at a time.
More...
|
| ListView () |
| Constructs an empty ListView object.
|
|
| ListView (const ListView &listView_) |
| Constructs a new ListView object from an existing ListView object (copy constructor)
|
|
| ListView (const Rect &frame_) |
| Constructs a list view with a frame only, no contents.
|
|
| ListView (const Rect &frame_, const EntryVector &entries_, const int32_t index_) |
| Constructs a list view.
|
|
| ListView (const Rect &frame_, const EntryVector &entries_, const std::string &initialID_) |
| Constructor for a list view with an initial ID selected.
|
|
virtual ListView & | operator= (const ListView &rhs_) |
| Allows one ListView object to be assigned from another.
|
|
virtual | ~ListView () |
| ListView destructor.
|
|
virtual ListView * | clone () const |
| Convenience method to clone a ListView object on the heap.
|
|
virtual ListView * | duplicate () const |
| Convenience method to duplicate a ListView object, creating a new and identical UI element to the target (but not belonging to the same containing window)
|
|
virtual Type | type () const |
| Gets the type of the widget.
|
|
virtual void | deselectAll () |
| Deselects all currently selected entries in the list.
|
|
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::string | currentValue () const |
| Gets the string value of the currently selected entry.
|
|
virtual bool | setCurrentValue (const std::string &value_) |
| Sets the currently selected entry by string value.
|
|
virtual std::unique_ptr< ListEntry > | currentEntry () const |
| Gets the current entry object.
|
|
virtual bool | currentUserData (void *&data__) const |
| Gets the user data for the current entry.
|
|
virtual const std::vector< std::shared_ptr< ListEntry > > *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< ListEntry > | 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 list view to be changed out entirely.
|
|
virtual bool | pushEntry (const ListEntry &entry_) |
| Pushes an entry onto the list (i.e. at the end)
|
|
virtual bool | popEntry (ListEntry &entry__) |
| Pops an entry off the list (i.e. from the end)
|
|
virtual bool | insertEntry (const std::string &id_, const ListEntry &entry_) |
| Inserts an entry into the list of entries at a given position.
|
|
virtual bool | removeEntry (const std::string &id_, ListEntry &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 void | valueChanged () |
| Simulates the list view having its value changed.
|
|
virtual Callback *const | valueChangedCallback () const |
| Gets the value changed callback for the list view.
|
|
virtual void | setValueChangedCallback (const Callback &callback_) |
| Sets the value changed callback.
|
|
virtual void | update () |
| Force the list view to update its entries.
|
|
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< ListEntry > | changedEntry () const |
| Gets the entry that was last modified via double-click inline editing.
|
|
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.
|
|
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)
|
|
List view widget, much like a popup menu but allowing for multiple entries to be seen at a time.