tbx  0.7.6
Classes | Public Member Functions | Protected Member Functions | List of all members
tbx::view::MultiSelection Class Reference

Class to implement multiple selections. More...

#include <selection.h>

Inheritance diagram for tbx::view::MultiSelection:
tbx::view::Selection

Classes

class  MultiIteratorImpl
 Class derived to implement iterator. More...
 

Public Member Functions

virtual Type type () const
 Returns the type of this selection class.
 
virtual bool selected (unsigned int index) const
 Returns true if an item is selected. More...
 
virtual unsigned int first () const
 Returns first selected item. More...
 
virtual unsigned int last () const
 Returns last selected item.
 
virtual bool empty () const
 Returns true if selection is empty.
 
virtual unsigned int count () const
 Return the number of selected items. More...
 
virtual bool any () const
 Returns true if one or more items are selected.
 
virtual bool one () const
 Returns true if only one item is selected.
 
virtual bool many () const
 Returns true if there are more than one item selected.
 
virtual void inserted (unsigned int index, unsigned int count)
 Data has been inserted so adjust selection.
 
virtual void removed (unsigned int index, unsigned int count)
 Data has been removed so adjust selection.
 
virtual void clear ()
 Clear the selection.
 
virtual void set (unsigned int index)
 Modifiy the selection so it only consist of the given index. More...
 
virtual void select (unsigned int index)
 Add the index to the selection.
 
virtual void deselect (unsigned int index)
 Remove selection from given index.
 
virtual void toggle (unsigned int index)
 Toggle the selected index.
 
virtual void set (unsigned int from, unsigned int to)
 Change the selection to be the specified range.
 
virtual void select (unsigned int from, unsigned int to)
 Select a range of values.
 
virtual void deselect (unsigned int from, unsigned int to)
 Deselect a range of values.
 
virtual void toggle (unsigned int from, unsigned int to)
 Toggle selected items in the range.
 
- Public Member Functions inherited from tbx::view::Selection
void add_listener (SelectionListener *listener)
 Add listeners. More...
 
void remove_listener (SelectionListener *listener)
 Remove listener for selection changes.
 
Iterator begin () const
 Get iterator to first selected item. More...
 
Iterator end () const
 Get iterator to end of selection. More...
 

Protected Member Functions

virtual IteratorImplget_iterator_impl () const
 Get initial iterator implementation.
 
- Protected Member Functions inherited from tbx::view::Selection
 Selection ()
 Protected constructor, must always use a subclass.
 
void fire_event (const SelectionChangedEvent &event)
 Helper for subclasses to fire Selection Changed Events.
 
void fire_event (unsigned int index, bool selected, bool final)
 Helper for subclasses to fire Selection Changed Events.
 
void fire_event (unsigned int from, unsigned int to, bool selected, bool final)
 Helper for subclasses to fire Selection Changed Events.
 

Additional Inherited Members

- Public Types inherited from tbx::view::Selection
enum  Type { NONE, SINGLE, MULTIPLE }
 Type of selection.
 
- Static Public Attributes inherited from tbx::view::Selection
static const unsigned int NO_SELECTION = -1
 Constant for indices when there is no selection.
 

Detailed Description

Class to implement multiple selections.

Member Function Documentation

◆ count()

unsigned int tbx::view::MultiSelection::count ( ) const
virtual

Return the number of selected items.

Count number of selected items.

Implements tbx::view::Selection.

◆ first()

virtual unsigned int tbx::view::MultiSelection::first ( ) const
inlinevirtual

Returns first selected item.

Only one item is ever selected so first() always equals last().

Implements tbx::view::Selection.

◆ selected()

bool tbx::view::MultiSelection::selected ( unsigned int  index) const
virtual

Returns true if an item is selected.

Check if the given index is selected.

Parameters
indexof item to test
indexto check
Returns
true if index is selected

Implements tbx::view::Selection.

◆ set()

void tbx::view::MultiSelection::set ( unsigned int  index)
virtual

Modifiy the selection so it only consist of the given index.

Parameters
indexnew selection

Implements tbx::view::Selection.


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