JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | List of all members
LassoSource< SelectableItemType > Class Template Referenceabstract

A class used by the LassoComponent to manage the things that it selects. More...

Public Member Functions

virtual ~LassoSource ()
 Destructor.
 
virtual void findLassoItemsInArea (Array< SelectableItemType > &itemsFound, const Rectangle< int > &area)=0
 Returns the set of items that lie within a given lassoable region.
 
virtual SelectedItemSet
< SelectableItemType > & 
getLassoSelection ()=0
 Returns the SelectedItemSet that the lasso should update.
 

Detailed Description

template<class SelectableItemType>
class LassoSource< SelectableItemType >

A class used by the LassoComponent to manage the things that it selects.

This allows the LassoComponent to find out which items are within the lasso, and to change the list of selected items.

See Also
LassoComponent, SelectedItemSet

Constructor & Destructor Documentation

template<class SelectableItemType>
virtual LassoSource< SelectableItemType >::~LassoSource ( )
virtual

Destructor.

Member Function Documentation

template<class SelectableItemType>
virtual void LassoSource< SelectableItemType >::findLassoItemsInArea ( Array< SelectableItemType > &  itemsFound,
const Rectangle< int > &  area 
)
pure virtual

Returns the set of items that lie within a given lassoable region.

Your implementation of this method must find all the relevent items that lie within the given rectangle. and add them to the itemsFound array.

The coordinates are relative to the top-left of the lasso component's parent component. (i.e. they are the same as the size and position of the lasso component itself).

template<class SelectableItemType>
virtual SelectedItemSet<SelectableItemType>& LassoSource< SelectableItemType >::getLassoSelection ( )
pure virtual

Returns the SelectedItemSet that the lasso should update.

This set will be continuously updated by the LassoComponent as it gets dragged around, so make sure that you've got a ChangeListener attached to the set so that your UI objects will know when the selection changes and be able to update themselves appropriately.

Referenced by LassoComponent< SelectableItemType >::beginLasso().


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