List view widget, much like a popup menu but allowing for multiple entries to be seen at a time. More...

#include <hdicoreListView.h>

Inheritance diagram for hdi::core::ListView:

Collaboration diagram for hdi::core::ListView:

Public Types
typedef std::vector< ListEntry >	EntryVector
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
	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 Callback *const	doubleClickCallback () const
	Gets the double-click callback for the list view.
virtual void	setDoubleClickCallback (const Callback &callback_)
	Sets the double-click 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.
Public Member Functions inherited from hdi::core::Widget
virtual	~Widget ()
	Destructs a Widget.
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 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.

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.

Detailed Description

List view widget, much like a popup menu but allowing for multiple entries to be seen at a time.

Constructor & Destructor Documentation

◆ ListView() [1/5]

hdi::core::ListView::ListView ( )

Constructs an empty ListView object.

Author: GW

Date: 09/2013

Note: To test if a ListView object is empty, call isEmpty() on it; Empty ListView objects do not relate to any actual UI widget; they are designed to be "receivers" of some other ListView object via the overloaded assignment operator. Empty ListView objects are useless until such time (though it is safe to call any of their methods).

◆ ListView() [2/5]

hdi::core::ListView::ListView ( const ListView & listView_ )

Constructs a new ListView object from an existing ListView object (copy constructor).

Author: GW

Date: 09/2013

Parameters

listView_ Existing ListView object

◆ ListView() [3/5]

hdi::core::ListView::ListView ( const Rect & frame_ )

Constructs a list view with a frame only, no contents.

Author: GW

Date: 09/2013

Parameters

frame_ Position and size of the list, in 1x resolution coordinates

◆ ListView() [4/5]

hdi::core::ListView::ListView	(	const Rect &	frame_,
		const EntryVector &	entries_,
		const int32_t	index_ )

Constructs a list view.

Author: GW

Date: 09/2013

Parameters

frame_	Position and size of the list, in 1x resolution coordinates
entries_	Vector of entries
index_	Initial index to select (must exist in entries_)

◆ ListView() [5/5]

hdi::core::ListView::ListView	(	const Rect &	frame_,
		const EntryVector &	entries_,
		const std::string &	initialID_ )

Constructor for a list view with an initial ID selected.

Author: GW

Date: 09/2013

Parameters

frame_	Position and size of the list, in 1x resolution coordinates
entries_	Vector of entries
initialID_	Initial ID to select (must exist in entries_, and must not be a separator), as UTF-8

◆ ~ListView()

virtual hdi::core::ListView::~ListView ( )

virtual

ListView destructor.

Author: GW

Date: 09/2013

Member Function Documentation

◆ cellChangedCallback()

virtual Callback *const hdi::core::ListView::cellChangedCallback ( ) const

virtual

Gets the callback for when a cell is modified via double-click inline editing.

Author: GW

Date: 07/2022

Returns: A pointer to the currently registered cell modification callback

◆ changedEntry()

virtual std::unique_ptr< ListEntry > hdi::core::ListView::changedEntry ( ) const

virtual

Gets the entry that was last modified via double-click inline editing.

Author: GW

Date: 07/2022

Returns: The changed entry object

Note: The return value of this method is only guaranteed to be valid during the execution of the cell changed callback.

◆ clearEntries()

virtual void hdi::core::ListView::clearEntries ( )

virtual

Clears all entries contained by the widget.

Author: GW

Date: 09/2013

◆ clone()

virtual ListView * hdi::core::ListView::clone ( ) const

virtual

Convenience method to clone a ListView object on the heap.

Author: GW

Date: 10/2013

Returns: A pointer to the new ListView object

Note: If you subclass ListView, you MUST overload this method yourself! If you don't and/or your clone() method does not return an instance of your ListView subclass, you will experience "object slicing" when adding the widget to a window.

Warning: The caller must manage the memory for the returned ListView object.

Implements hdi::core::Widget.

◆ currentEntry()

virtual std::unique_ptr< ListEntry > hdi::core::ListView::currentEntry ( ) const

virtual

Gets the current entry object.

Author: GW

Date: 09/2013

Returns: The ListEntry object for the currently selected item

◆ currentID()

virtual std::string hdi::core::ListView::currentID ( ) const

virtual

Gets the ID of the currently selected entry.

Author: GW

Date: 09/2013

Returns: UTF-8 ID string of the currently selected entry, or "" if no entry is currently selected

◆ currentIndex()

virtual int32_t hdi::core::ListView::currentIndex ( ) const

virtual

Gets the index of the currently selected entry.

Author: GW

Date: 09/2013

Returns: The index number of the currently selected entry, or -1 if no entry is selected

◆ currentUserData()

virtual bool hdi::core::ListView::currentUserData ( void *& data__ ) const

virtual

Gets the user data for the current entry.

Author: GW

Date: 09/2013

Parameters

data__ Return-by-reference for the current user data; ignore if false is returned

Returns: true if the method succeeds in acquiring the contained entry data, false otherwise

◆ currentValue()

virtual std::string hdi::core::ListView::currentValue ( ) const

virtual

Gets the string value of the currently selected entry.

Author: GW

Date: 09/2013

Returns: Value string of the list view, as UTF-8

◆ deselectAll()

virtual void hdi::core::ListView::deselectAll ( )

virtual

Deselects all currently selected entries in the list.

Author: GW

Date: 09/2013

◆ doubleClickCallback()

virtual Callback *const hdi::core::ListView::doubleClickCallback ( ) const

virtual

Gets the double-click callback for the list view.

Author: GW

Date: 11/2024

Returns: A pointer to the currently registered double-click callback

◆ duplicate()

virtual ListView * hdi::core::ListView::duplicate ( ) const

virtual

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).

Author: GW

Date: 11/2013

Returns: A pointer to the new ListView object (and new UI element)

Note: The new list view will have copies of all entries present in the target, but be aware that copies of the user data in each entry cannot be made (because they are simply void* variables). As such, the user data in the copies will simply be set to NULL by this method.

Warning: The caller must manage the memory for the returned ListView object.

Implements hdi::core::Widget.

◆ entries()

virtual const std::vector< std::shared_ptr< ListEntry > > *const hdi::core::ListView::entries ( ) const

virtual

Gets the entries vector.

Author: GW

Date: 09/2013

Returns: The entries vector for the target widget, containing all currently known entries

Note: Modifying any value in an entry will not cause the widget to update automatically; call update() to update the UI for changes made to entry data.

◆ entryWithID()

virtual std::shared_ptr< ListEntry > hdi::core::ListView::entryWithID ( const std::string & id_ ) const

virtual

Gets the entry with the given ID, provided it exists within the widget.

Author: GW

Date: 12/2022

Parameters

id_	ID of the entry to search for

Returns: The entry with the given ID, or NULL if not found

◆ hasEntry()

virtual bool hdi::core::ListView::hasEntry ( const std::string & id_ ) const

virtual

Gets whether the entries vector already contains an entry, based on its ID.

Author: GW

Date: 09/2013

Parameters

id_	ID of the entry to search for, as UTF-8

Returns: true if the widget already contains an entry with the given ID, false otherwise

◆ insertEntry()

virtual bool hdi::core::ListView::insertEntry	(	const std::string &	id_,
		const ListEntry &	entry_ )

virtual

Inserts an entry into the list of entries at a given position.

Author: GW

Date: 09/2013

Parameters

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

Returns: true if the entry is inserted successfully, false otherwise

Note: If the entry for id_ doesn't exist in the list, the new entry will not be inserted.; If the passed entry is already present in the list (based on its ID), it will not be inserted.

◆ operator=()

virtual ListView & hdi::core::ListView::operator= ( const ListView & rhs_ )

virtual

Allows one ListView object to be assigned from another.

Author: GW

Date: 10/2013

Parameters

rhs_	Righthand side of the = operator; the object to copy values from

Returns: The target ListView object, but with its value updated to match that of rhs_

◆ popEntry()

virtual bool hdi::core::ListView::popEntry ( ListEntry & entry__ )

virtual

Pops an entry off the list (i.e. from the end).

Author: GW

Date: 09/2013

Parameters

entry__ Return-by-reference for the popped entry, so the caller can inspect which one was removed

Returns: true if an entry was popped and acquired, false otherwise

◆ potentialReorderCallback()

virtual Callback *const hdi::core::ListView::potentialReorderCallback ( ) const

virtual

Gets the current potential-reorder callback for the list.

Author: GW

Date: 12/2022

Returns: A pointer to the currently registered potential-reorder callback

◆ potentialReorderGood()

virtual bool hdi::core::ListView::potentialReorderGood ( ) const

virtual

Gets whether the potential reorder is acceptable; if not, the drag cursor will indicate the proposed drop position is not allowed.

Author: GW

Date: 12/2022

Returns: true if the specific reorder drop position is allowed, false otherwise

Note: The return value of this method is only guaranteed to be valid during the execution of the potential-reorder callback.

◆ potentialReorderPosition()

virtual std::vector< std::string > hdi::core::ListView::potentialReorderPosition ( ) const

virtual

Gets the position for the reorder, i.e. the entry just before the proposed reposition.

Author: GW

Date: 12/2022

Returns: The ID path of the entry just before the potential drop point for a reposition; if the returned vector contains only an empty string, this refers to the proposed drop position being the first at the root level.

Note: The return value of this method is only guaranteed to be valid during the execution of the potential-reorder callback.

◆ potentialReorderSource()

virtual std::vector< std::string > hdi::core::ListView::potentialReorderSource ( ) const

virtual

Gets the source item involved in the potential reorder, i.e. the entry being dragged.

Author: GW

Date: 12/2022

Returns: The ID path of the entry that might be reordered

Note: The return value of this method is only guaranteed to be valid during the execution of the potential-reorder callback.

◆ pushEntry()

virtual bool hdi::core::ListView::pushEntry ( const ListEntry & entry_ )

virtual

Pushes an entry onto the list (i.e. at the end).

Author: GW

Date: 09/2013

Parameters

entry_ New entry object to insert into the list of entries

Returns: true if the entry is pushed successfully, false otherwise

Note: If the entry is already present in the list (based on its ID), it will not be inserted.

◆ removeEntry()

virtual bool hdi::core::ListView::removeEntry	(	const std::string &	id_,
		ListEntry &	entry__ )

virtual

Removes a specific entry from the list of entries.

Author: GW

Date: 09/2013

Parameters

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

Returns: true if an entry was removed and acquired, false otherwise

◆ reorderable()

virtual bool hdi::core::ListView::reorderable ( ) const

virtual

Gets whether reordering support for the list is enabled.

Author: GW

Date: 12/2022

Returns: true if drag-and-drop reordering support is enabled, false otherwise

◆ reorderCallback()

virtual Callback *const hdi::core::ListView::reorderCallback ( ) const

virtual

Gets the current reorder callback for the widget.

Author: GW

Date: 12/2022

Returns: A pointer to the currently registered reorder callback

◆ reorderEntry()

virtual bool hdi::core::ListView::reorderEntry	(	const std::string &	targetID_,
		const std::string &	positionID_ )

virtual

Reorders a target entry (based on ID) to be newly located just after another existing entry in the list.

Author: GW

Date: 12/2022

Parameters

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

Returns: true if the entry is repositioned successfully, false otherwise

Note: If the entry for targetID_ or for positionID_ doesn't exist in the list, this method will bail.

◆ reorderPosition()

virtual std::vector< std::string > hdi::core::ListView::reorderPosition ( ) const

virtual

Gets the position for the reorder, i.e. the entry just before the reposition.

Author: GW

Date: 12/2022

Returns: The ID path of the entry just before the drop point for a reposition; if the returned vector contains only an empty string, this refers to the drop position being the first at the root level.

Note: The return value of this method is only guaranteed to be valid during the execution of the reorder callback.

◆ reorderSource()

virtual std::vector< std::string > hdi::core::ListView::reorderSource ( ) const

virtual

Gets the source item involved in the reorder, i.e. the entry being dropped.

Author: GW

Date: 12/2022

Returns: The ID path of the entry that was reordered

Note: The return value of this method is only guaranteed to be valid during the execution of the reorder callback.

◆ setCellChangedCallback()

virtual void hdi::core::ListView::setCellChangedCallback ( const Callback & callback_ )

virtual

Sets the callback for when a cell is modified via double-click inline editing.

Author: GW

Date: 07/2022

Parameters

callback_ New callback for a user modifying a cell via inline editing

Note: When your callback is executed, you can determine which entry was clicked by calling the changedEntry() method.

◆ setCurrentID()

virtual bool hdi::core::ListView::setCurrentID ( const std::string & id_ )

virtual

Sets the currently selected entry by ID.

Author: GW

Date: 09/2013

Parameters

id_	ID of new value to select in the list view, as UTF-8

Returns: true if the entry with the given ID was selected, or false if invalid

◆ setCurrentIndex()

virtual bool hdi::core::ListView::setCurrentIndex ( const int32_t index_ )

virtual

Sets the currently selected entry by index.

Author: GW

Date: 09/2013

Parameters

index_ New index to select

Returns: true if the selection occurred successfully, or false if e.g. out of range

◆ setCurrentValue()

virtual bool hdi::core::ListView::setCurrentValue ( const std::string & value_ )

virtual

Sets the currently selected entry by string value.

Author: GW

Date: 09/2013

Parameters

value_ New value to set for the list view (if it exists as an entry), as UTF-8

Returns: true if the value was set, false otherwise

◆ setDoubleClickCallback()

virtual void hdi::core::ListView::setDoubleClickCallback ( const Callback & callback_ )

virtual

Sets the double-click callback.

Author: GW

Date: 11/2024

Parameters

callback_ New callback for when the list view's current entry is double clicked

Note: This callback will not be fired when editable entries are double clicked.

◆ setEntries()

virtual void hdi::core::ListView::setEntries ( const EntryVector & entries_ )

virtual

Allows the entries in a list view to be changed out entirely.

Author: GW

Date: 09/2013

Parameters

entries_ New set of entries that the widget will contain

◆ setPotentialReorderCallback()

virtual void hdi::core::ListView::setPotentialReorderCallback ( const Callback & callback_ )

virtual

Sets the potential-reorder callback for the widget.

Author: GW

Date: 12/2022

Parameters

callback_ New callback (target and action) for each time the potential reorder target changes

Note: When your callback is executed, you can determine which entry is being proposed for reorder and its proposed new position by calling the potentialReorderSource() and potentialReorderPosition() methods, respectively.

◆ setPotentialReorderGood()

virtual void hdi::core::ListView::setPotentialReorderGood ( const bool good_ )

virtual

Sets whether the potential reorder is acceptable; if not, the drag cursor will indicate the proposed drop position is not allowed.

Author: GW

Date: 12/2022

Parameters

good_ Whether the potential reorder position is acceptable

Note: This method will have no effect if it is called any other time than from within a potential- reorder callback.; A potential reorder is always assumed to be good, so the true/false nature of a potential reorder will always be true unless you have called this method within your callback and passed false.; Calling this method and passing false will not stop a potential reorder from occurring altogether; rather, it merely indicates whether a specific reorder proposed drop position is acceptable. It is still up to you whether the entries, and any underlying associated data, is actually reordered once your reorder callback is executed.

◆ setReorderable()

virtual void hdi::core::ListView::setReorderable ( const bool enable_ )

virtual

Sets whether reordering support for the list is enabled.

Author: GW

Date: 12/2022

Parameters

enable_ true to enable drag-and-drop reordering support, false otherwise

◆ setReorderCallback()

virtual void hdi::core::ListView::setReorderCallback ( const Callback & callback_ )

virtual

Sets the reorder callback for the widget.

Author: GW

Date: 12/2022

Parameters

callback_ New callback (target and action) for when a reorder is finalized (via dropping)

Note: When your callback is executed, you can determine which entry is being reordered and its new position by calling the reorderSource() and reorderPosition() methods, respectively.

◆ setValueChangedCallback()

virtual void hdi::core::ListView::setValueChangedCallback ( const Callback & callback_ )

virtual

Sets the value changed callback.

Author: GW

Date: 09/2013

Parameters

callback_ New callback for when the list view's value has changed

Note: In this context, "value" refers to the selected index/ID changing.

◆ type()

virtual Type hdi::core::ListView::type ( ) const

virtual

Gets the type of the widget.

Author: GW

Date: 07/2021

Returns: The widget type

Reimplemented from hdi::core::Widget.

◆ update()

virtual void hdi::core::ListView::update ( )

virtual

Force the list view to update its entries.

Author: GW

Date: 12/2013

Reimplemented from hdi::core::Widget.

◆ valueChanged()

virtual void hdi::core::ListView::valueChanged ( )

virtual

Simulates the list view having its value changed.

Author: GW

Date: 09/2013

◆ valueChangedCallback()

virtual Callback *const hdi::core::ListView::valueChangedCallback ( ) const

virtual

Gets the value changed callback for the list view.

Author: GW

Date: 09/2013

Returns: A pointer to the currently registered value changed callback

Note: In this context, "value" refers to the selected index/ID changing.

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ListView() [1/5]

◆ ListView() [2/5]

◆ ListView() [3/5]

◆ ListView() [4/5]

◆ ListView() [5/5]

◆ ~ListView()

Member Function Documentation

◆ cellChangedCallback()

◆ changedEntry()

◆ clearEntries()

◆ clone()

◆ currentEntry()

◆ currentID()

◆ currentIndex()

◆ currentUserData()

◆ currentValue()

◆ deselectAll()

◆ doubleClickCallback()

◆ duplicate()

◆ entries()

◆ entryWithID()

◆ hasEntry()

◆ insertEntry()

◆ operator=()

◆ popEntry()

◆ potentialReorderCallback()

◆ potentialReorderGood()

◆ potentialReorderPosition()

◆ potentialReorderSource()

◆ pushEntry()

◆ removeEntry()

◆ reorderable()

◆ reorderCallback()

◆ reorderEntry()

◆ reorderPosition()

◆ reorderSource()

◆ setCellChangedCallback()

◆ setCurrentID()

◆ setCurrentIndex()

◆ setCurrentValue()

◆ setDoubleClickCallback()

◆ setEntries()

◆ setPotentialReorderCallback()

◆ setPotentialReorderGood()

◆ setReorderable()

◆ setReorderCallback()

◆ setValueChangedCallback()

◆ type()

◆ update()

◆ valueChanged()

◆ valueChangedCallback()