Manages a list of selectable items. More...

Inherits ChangeBroadcaster.

Public Types
typedef SelectableItemType	ItemType

Public Member Functions
typedef	PARAMETER_TYPE (SelectableItemType) ParameterType

	SelectedItemSet ()
	Creates an empty set.

	SelectedItemSet (const Array< SelectableItemType > &items)
	Creates a set based on an array of items.

	SelectedItemSet (const SelectedItemSet &other)
	Creates a copy of another set.

SelectedItemSet &	operator= (const SelectedItemSet &other)
	Creates a copy of another set.

void	selectOnly (ParameterType item)
	Clears any other currently selected items, and selects this item.

void	addToSelection (ParameterType item)
	Selects an item.

void	addToSelectionBasedOnModifiers (ParameterType item, const ModifierKeys &modifiers)
	Selects or deselects an item.

bool	addToSelectionOnMouseDown (ParameterType item, const ModifierKeys &modifiers)
	Selects or deselects items that can also be dragged, based on a mouse-down event.

void	addToSelectionOnMouseUp (ParameterType item, const ModifierKeys &modifiers, const bool wasItemDragged, const bool resultOfMouseDownSelectMethod)
	Selects or deselects items that can also be dragged, based on a mouse-up event.

void	deselect (ParameterType item)
	Deselects an item.

void	deselectAll ()
	Deselects all items.

int	getNumSelected () const noexcept
	Returns the number of currently selected items.

SelectableItemType	getSelectedItem (const int index) const noexcept
	Returns one of the currently selected items.

bool	isSelected (ParameterType item) const noexcept
	True if this item is currently selected.

const Array< SelectableItemType > &	getItemArray () const noexcept

SelectableItemType *	begin () const noexcept

SelectableItemType *	end () const noexcept

virtual void	itemSelected (SelectableItemType item)
	Can be overridden to do special handling when an item is selected.

virtual void	itemDeselected (SelectableItemType item)
	Can be overridden to do special handling when an item is deselected.

void	changed (const bool synchronous=false)
	Used internally, but can be called to force a change message to be sent to the ChangeListeners.

Public Member Functions inherited from ChangeBroadcaster
	ChangeBroadcaster () noexcept
	Creates an ChangeBroadcaster.

virtual	~ChangeBroadcaster ()
	Destructor.

void	addChangeListener (ChangeListener *listener)
	Registers a listener to receive change callbacks from this broadcaster.

void	removeChangeListener (ChangeListener *listener)
	Unregisters a listener from the list.

void	removeAllChangeListeners ()
	Removes all listeners from the list.

void	sendChangeMessage ()
	Causes an asynchronous change message to be sent to all the registered listeners.

void	sendSynchronousChangeMessage ()
	Sends a synchronous change message to all the registered listeners.

void	dispatchPendingMessages ()
	If a change message has been sent but not yet dispatched, this will call sendSynchronousChangeMessage() to make the callback immediately.

Detailed Description

template<class SelectableItemType>
class SelectedItemSet< SelectableItemType >

Manages a list of selectable items.

Use one of these to keep a track of things that the user has highlighted, like icons or things in a list.

The class is templated so that you can use it to hold either a set of pointers to objects, or a set of ID numbers or handles, for cases where each item may not always have a corresponding object.

To be informed when items are selected/deselected, register a ChangeListener with this object.

See Also: SelectableObject

Member Typedef Documentation

template<class SelectableItemType >

typedef SelectableItemType SelectedItemSet< SelectableItemType >::ItemType

Constructor & Destructor Documentation

template<class SelectableItemType >

SelectedItemSet< SelectableItemType >::SelectedItemSet ( )

Creates an empty set.

template<class SelectableItemType >

SelectedItemSet< SelectableItemType >::SelectedItemSet ( const Array< SelectableItemType > & items )

explicit

Creates a set based on an array of items.

template<class SelectableItemType >

SelectedItemSet< SelectableItemType >::SelectedItemSet ( const SelectedItemSet< SelectableItemType > & other )

Creates a copy of another set.

Member Function Documentation

template<class SelectableItemType >

typedef SelectedItemSet< SelectableItemType >::PARAMETER_TYPE ( SelectableItemType )

template<class SelectableItemType >

SelectedItemSet& SelectedItemSet< SelectableItemType >::operator= ( const SelectedItemSet< SelectableItemType > & other )

Creates a copy of another set.

References SelectedItemSet< SelectableItemType >::changed().

template<class SelectableItemType >

void SelectedItemSet< SelectableItemType >::selectOnly ( ParameterType item )

Clears any other currently selected items, and selects this item.

If this item is already the only thing selected, no change notification will be sent out.

See Also: addToSelection, addToSelectionBasedOnModifiers

References Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::add(), SelectedItemSet< SelectableItemType >::changed(), SelectedItemSet< SelectableItemType >::deselect(), SelectedItemSet< SelectableItemType >::deselectAll(), Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getUnchecked(), SelectedItemSet< SelectableItemType >::isSelected(), SelectedItemSet< SelectableItemType >::itemSelected(), jmin(), and Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size().

Referenced by SelectedItemSet< SelectableItemType >::addToSelectionBasedOnModifiers().

template<class SelectableItemType >

void SelectedItemSet< SelectableItemType >::addToSelection ( ParameterType item )

Selects an item.

If the item is already selected, no change notification will be sent out.

See Also: selectOnly, addToSelectionBasedOnModifiers

References Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::add(), SelectedItemSet< SelectableItemType >::changed(), SelectedItemSet< SelectableItemType >::isSelected(), and SelectedItemSet< SelectableItemType >::itemSelected().

Referenced by SelectedItemSet< SelectableItemType >::addToSelectionBasedOnModifiers().

template<class SelectableItemType >

void SelectedItemSet< SelectableItemType >::addToSelectionBasedOnModifiers	(	ParameterType	item,
		const ModifierKeys &	modifiers
	)

Selects or deselects an item.

This will use the modifier keys to decide whether to deselect other items first.

So if the shift key is held down, the item will be added without deselecting anything (same as calling addToSelection() )

If no modifiers are down, the current selection will be cleared first (same as calling selectOnly() )

If the ctrl (or command on the Mac) key is held down, the item will be toggled - so it'll be added to the set unless it's already there, in which case it'll be deselected.

If the items that you're selecting can also be dragged, you may need to use the addToSelectionOnMouseDown() and addToSelectionOnMouseUp() calls to handle the subtleties of this kind of usage.

See Also: selectOnly, addToSelection, addToSelectionOnMouseDown, addToSelectionOnMouseUp

References SelectedItemSet< SelectableItemType >::addToSelection(), SelectedItemSet< SelectableItemType >::deselect(), ModifierKeys::isCommandDown(), SelectedItemSet< SelectableItemType >::isSelected(), ModifierKeys::isShiftDown(), and SelectedItemSet< SelectableItemType >::selectOnly().

Referenced by SelectedItemSet< SelectableItemType >::addToSelectionOnMouseDown(), and SelectedItemSet< SelectableItemType >::addToSelectionOnMouseUp().

template<class SelectableItemType >

bool SelectedItemSet< SelectableItemType >::addToSelectionOnMouseDown	(	ParameterType	item,
		const ModifierKeys &	modifiers
	)

Selects or deselects items that can also be dragged, based on a mouse-down event.

If you call addToSelectionOnMouseDown() at the start of your mouseDown event, and then call addToSelectionOnMouseUp() at the end of your mouseUp event, this makes it easy to handle multiple-selection of sets of objects that can also be dragged.

For example, if you have several items already selected, and you click on one of them (without dragging), then you'd expect this to deselect the other, and just select the item you clicked on. But if you had clicked on this item and dragged it, you'd have expected them all to stay selected.

When you call this method, you'll need to store the boolean result, because the addToSelectionOnMouseUp() method will need to be know this value.

See Also: addToSelectionOnMouseUp, addToSelectionBasedOnModifiers

References SelectedItemSet< SelectableItemType >::addToSelectionBasedOnModifiers(), ModifierKeys::isPopupMenu(), and SelectedItemSet< SelectableItemType >::isSelected().

template<class SelectableItemType >

void SelectedItemSet< SelectableItemType >::addToSelectionOnMouseUp	(	ParameterType	item,
		const ModifierKeys &	modifiers,
		const bool	wasItemDragged,
		const bool	resultOfMouseDownSelectMethod
	)

Selects or deselects items that can also be dragged, based on a mouse-up event.

Call this during a mouseUp callback, when you have previously called the addToSelectionOnMouseDown() method during your mouseDown event.

See addToSelectionOnMouseDown() for more info

Parameters

item	the item to select (or deselect)
modifiers	the modifiers from the mouse-up event
wasItemDragged	true if your item was dragged during the mouse click
resultOfMouseDownSelectMethod	this is the boolean return value that came back from the addToSelectionOnMouseDown() call that you should have made during the matching mouseDown event

References SelectedItemSet< SelectableItemType >::addToSelectionBasedOnModifiers().

template<class SelectableItemType >

void SelectedItemSet< SelectableItemType >::deselect ( ParameterType item )

Deselects an item.

References SelectedItemSet< SelectableItemType >::changed(), Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::indexOf(), SelectedItemSet< SelectableItemType >::itemDeselected(), and Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::remove().

Referenced by SelectedItemSet< SelectableItemType >::addToSelectionBasedOnModifiers(), and SelectedItemSet< SelectableItemType >::selectOnly().

template<class SelectableItemType >

void SelectedItemSet< SelectableItemType >::deselectAll ( )

Deselects all items.

References SelectedItemSet< SelectableItemType >::changed(), SelectedItemSet< SelectableItemType >::itemDeselected(), jmin(), Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::remove(), and Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size().

Referenced by SelectedItemSet< SelectableItemType >::selectOnly().

template<class SelectableItemType >

int SelectedItemSet< SelectableItemType >::getNumSelected ( ) const

noexcept

Returns the number of currently selected items.

See Also: getSelectedItem

References Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size().

template<class SelectableItemType >

SelectableItemType SelectedItemSet< SelectableItemType >::getSelectedItem ( const int index ) const

noexcept

Returns one of the currently selected items.

Returns 0 if the index is out-of-range.

See Also: getNumSelected

template<class SelectableItemType >

bool SelectedItemSet< SelectableItemType >::isSelected ( ParameterType item ) const

noexcept

True if this item is currently selected.

References Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::contains().

Referenced by SelectedItemSet< SelectableItemType >::addToSelection(), SelectedItemSet< SelectableItemType >::addToSelectionBasedOnModifiers(), SelectedItemSet< SelectableItemType >::addToSelectionOnMouseDown(), and SelectedItemSet< SelectableItemType >::selectOnly().

template<class SelectableItemType >

const Array<SelectableItemType>& SelectedItemSet< SelectableItemType >::getItemArray ( ) const

noexcept

template<class SelectableItemType >

SelectableItemType* SelectedItemSet< SelectableItemType >::begin ( ) const

noexcept

References Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::begin().

template<class SelectableItemType >

SelectableItemType* SelectedItemSet< SelectableItemType >::end ( ) const

noexcept

References Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::end().

template<class SelectableItemType >

virtual void SelectedItemSet< SelectableItemType >::itemSelected ( SelectableItemType item )

virtual

Can be overridden to do special handling when an item is selected.

For example, if the item is an object, you might want to call it and tell it that it's being selected.

Referenced by SelectedItemSet< SelectableItemType >::addToSelection(), and SelectedItemSet< SelectableItemType >::selectOnly().

template<class SelectableItemType >

virtual void SelectedItemSet< SelectableItemType >::itemDeselected ( SelectableItemType item )

virtual

Can be overridden to do special handling when an item is deselected.

For example, if the item is an object, you might want to call it and tell it that it's being deselected.

Referenced by SelectedItemSet< SelectableItemType >::deselect(), and SelectedItemSet< SelectableItemType >::deselectAll().

template<class SelectableItemType >

void SelectedItemSet< SelectableItemType >::changed ( const bool synchronous = false )

Used internally, but can be called to force a change message to be sent to the ChangeListeners.

References ChangeBroadcaster::sendChangeMessage(), and ChangeBroadcaster::sendSynchronousChangeMessage().

Referenced by SelectedItemSet< SelectableItemType >::addToSelection(), SelectedItemSet< SelectableItemType >::deselect(), SelectedItemSet< SelectableItemType >::deselectAll(), SelectedItemSet< SelectableItemType >::operator=(), and SelectedItemSet< SelectableItemType >::selectOnly().

The documentation for this class was generated from the following file:

juce_SelectedItemSet.h

Public Types

Public Member Functions

Detailed Description

template<class SelectableItemType> class SelectedItemSet< SelectableItemType >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<class SelectableItemType>
class SelectedItemSet< SelectableItemType >