tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications
« « « Anklang Documentation
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
tracktion::engine::SelectionManager Class Reference

Manages a list of items that are currently selected. More...

#include "tracktion_SelectionManager.h"

Inheritance diagram for tracktion::engine::SelectionManager:
juce::ChangeBroadcaster tracktion::engine::SelectableListener

Classes

struct  ChangedSelectionDetector
 
struct  ComponentWithSelectionManager
 
struct  Iterator
 
struct  ScopedSelectionState
 

Public Member Functions

 SelectionManager (Engine &)
 
int getNumObjectsSelected () const
 
Selectable * getSelectedObject (int index) const
 
bool isSelected (const Selectable *) const
 
bool isSelected (const Selectable &) const
 
const SelectableList & getSelectedObjects () const
 
SelectableClass * getFirstSelectableClass () const
 
void selectOnly (Selectable *)
 
void selectOnly (Selectable &)
 
void addToSelection (Selectable *)
 
void addToSelection (Selectable &)
 
void select (Selectable *, bool addToCurrentSelection)
 
void select (Selectable &, bool addToCurrentSelection)
 
void select (const SelectableList &)
 
void deselectAll ()
 
void deselect (Selectable *)
 
void selectOtherObjects (SelectableClass::Relationship, bool keepOldItemsSelected)
 Selects related objects, e.g.
 
template<typename SelectableClass >
bool containsType () const
 
template<typename SelectableClass >
int getNumObjectsSelectedOfType () const
 
template<typename SelectableClass >
juce::Array< SelectableClass * > getItemsOfType () const
 
template<typename SelectableClass >
SelectableClass * getFirstItemOfType () const
 
void deleteSelected ()
 
bool copySelected ()
 
bool cutSelected ()
 
bool pasteSelected ()
 Offers the selected things the chance to paste the contents of the clipboard onto themselves, returns false if they didn't handle it.
 
void keepSelectedObjectsOnScreen ()
 Scrolls whatever is necessary to keep the selected stuff visible.
 
void refreshPropertyPanel ()
 
void selectableObjectChanged (Selectable *) override
 
void selectableObjectAboutToBeDeleted (Selectable *) override
 
Edit * getEdit () const
 
- Public Member Functions inherited from juce::ChangeBroadcaster
void addChangeListener (ChangeListener *listener)
 
void removeChangeListener (ChangeListener *listener)
 
void removeAllChangeListeners ()
 
void sendChangeMessage ()
 
void sendSynchronousChangeMessage ()
 
void dispatchPendingMessages ()
 

Static Public Member Functions

static void refreshAllPropertyPanels ()
 
static void refreshAllPropertyPanelsShowing (Selectable &)
 
static void deselectAllFromAllWindows ()
 
static SelectionManager * findSelectionManager (const juce::Component *)
 
static SelectionManager * findSelectionManager (const juce::Component &)
 
static SelectionManager * findSelectionManagerContaining (const Selectable *)
 
static SelectionManager * findSelectionManagerContaining (const Selectable &)
 

Public Attributes

int selectionChangeCount
 
SafeSelectable< Edit > edit
 If this SelectionManager is being used to represent items inside a particular view of an edit, this id should be set so you can find it by iterating the SelectionManagers.
 
int editViewID
 
EditInsertPoint * insertPoint
 
Engine & engine
 

Friends

class Selectable
 

Detailed Description

Manages a list of items that are currently selected.

See also
Selectable

Definition at line 17 of file tracktion_SelectionManager.h.

Constructor & Destructor Documentation

◆ SelectionManager()

tracktion::engine::SelectionManager::SelectionManager ( Engine &  e)

Definition at line 375 of file tracktion_SelectionManager.cpp.

◆ ~SelectionManager()

tracktion::engine::SelectionManager::~SelectionManager ( )
override

Definition at line 380 of file tracktion_SelectionManager.cpp.

Member Function Documentation

◆ addToSelection() [1/2]

void tracktion::engine::SelectionManager::addToSelection ( Selectable &  s)

Definition at line 486 of file tracktion_SelectionManager.cpp.

◆ addToSelection() [2/2]

void tracktion::engine::SelectionManager::addToSelection ( Selectable *  s)

Definition at line 485 of file tracktion_SelectionManager.cpp.

◆ containsType()

template<typename SelectableClass >
bool tracktion::engine::SelectionManager::containsType ( ) const

Definition at line 49 of file tracktion_SelectionManager.h.

◆ copySelected()

bool tracktion::engine::SelectionManager::copySelected ( )

Definition at line 613 of file tracktion_SelectionManager.cpp.

◆ cutSelected()

bool tracktion::engine::SelectionManager::cutSelected ( )

Definition at line 649 of file tracktion_SelectionManager.cpp.

◆ deleteSelected()

void tracktion::engine::SelectionManager::deleteSelected ( )

Definition at line 640 of file tracktion_SelectionManager.cpp.

◆ deselect()

void tracktion::engine::SelectionManager::deselect ( Selectable *  s)

Definition at line 544 of file tracktion_SelectionManager.cpp.

◆ deselectAll()

void tracktion::engine::SelectionManager::deselectAll ( )

Definition at line 444 of file tracktion_SelectionManager.cpp.

◆ deselectAllFromAllWindows()

void tracktion::engine::SelectionManager::deselectAllFromAllWindows ( )
static

Definition at line 592 of file tracktion_SelectionManager.cpp.

◆ findSelectionManager() [1/2]

SelectionManager * tracktion::engine::SelectionManager::findSelectionManager ( const juce::Component &  c)
static

Definition at line 717 of file tracktion_SelectionManager.cpp.

◆ findSelectionManager() [2/2]

SelectionManager * tracktion::engine::SelectionManager::findSelectionManager ( const juce::Component *  c)
static

Definition at line 709 of file tracktion_SelectionManager.cpp.

◆ findSelectionManagerContaining() [1/2]

SelectionManager * tracktion::engine::SelectionManager::findSelectionManagerContaining ( const Selectable &  s)
static

Definition at line 607 of file tracktion_SelectionManager.cpp.

◆ findSelectionManagerContaining() [2/2]

SelectionManager * tracktion::engine::SelectionManager::findSelectionManagerContaining ( const Selectable *  s)
static

Definition at line 598 of file tracktion_SelectionManager.cpp.

◆ getEdit()

Edit * tracktion::engine::SelectionManager::getEdit ( ) const

Definition at line 704 of file tracktion_SelectionManager.cpp.

◆ getFirstItemOfType()

template<typename SelectableClass >
SelectableClass * tracktion::engine::SelectionManager::getFirstItemOfType ( ) const

Definition at line 79 of file tracktion_SelectionManager.h.

◆ getFirstSelectableClass()

SelectableClass * tracktion::engine::SelectionManager::getFirstSelectableClass ( ) const

Definition at line 392 of file tracktion_SelectionManager.cpp.

◆ getItemsOfType()

template<typename SelectableClass >
juce::Array< SelectableClass * > tracktion::engine::SelectionManager::getItemsOfType ( ) const

Definition at line 67 of file tracktion_SelectionManager.h.

◆ getNumObjectsSelected()

int tracktion::engine::SelectionManager::getNumObjectsSelected ( ) const

Definition at line 418 of file tracktion_SelectionManager.cpp.

◆ getNumObjectsSelectedOfType()

template<typename SelectableClass >
int tracktion::engine::SelectionManager::getNumObjectsSelectedOfType ( ) const

Definition at line 55 of file tracktion_SelectionManager.h.

◆ getSelectedObject()

Selectable * tracktion::engine::SelectionManager::getSelectedObject ( int  index) const

Definition at line 423 of file tracktion_SelectionManager.cpp.

◆ getSelectedObjects()

const SelectableList & tracktion::engine::SelectionManager::getSelectedObjects ( ) const

Definition at line 429 of file tracktion_SelectionManager.cpp.

◆ isSelected() [1/2]

bool tracktion::engine::SelectionManager::isSelected ( const Selectable &  object) const

Definition at line 439 of file tracktion_SelectionManager.cpp.

◆ isSelected() [2/2]

bool tracktion::engine::SelectionManager::isSelected ( const Selectable *  object) const

Definition at line 434 of file tracktion_SelectionManager.cpp.

◆ keepSelectedObjectsOnScreen()

void tracktion::engine::SelectionManager::keepSelectedObjectsOnScreen ( )

Scrolls whatever is necessary to keep the selected stuff visible.

Definition at line 696 of file tracktion_SelectionManager.cpp.

◆ pasteSelected()

bool tracktion::engine::SelectionManager::pasteSelected ( )

Offers the selected things the chance to paste the contents of the clipboard onto themselves, returns false if they didn't handle it.

Definition at line 666 of file tracktion_SelectionManager.cpp.

◆ refreshAllPropertyPanels()

void tracktion::engine::SelectionManager::refreshAllPropertyPanels ( )
static

Definition at line 579 of file tracktion_SelectionManager.cpp.

◆ refreshAllPropertyPanelsShowing()

void tracktion::engine::SelectionManager::refreshAllPropertyPanelsShowing ( Selectable &  s)
static

Definition at line 585 of file tracktion_SelectionManager.cpp.

◆ refreshPropertyPanel()

void tracktion::engine::SelectionManager::refreshPropertyPanel ( )

Definition at line 574 of file tracktion_SelectionManager.cpp.

◆ select() [1/3]

void tracktion::engine::SelectionManager::select ( const SelectableList &  listSrc)

Definition at line 528 of file tracktion_SelectionManager.cpp.

◆ select() [2/3]

void tracktion::engine::SelectionManager::select ( Selectable &  s,
bool  addToCurrentSelection 
)

Definition at line 494 of file tracktion_SelectionManager.cpp.

◆ select() [3/3]

void tracktion::engine::SelectionManager::select ( Selectable *  s,
bool  addToCurrentSelection 
)

Definition at line 488 of file tracktion_SelectionManager.cpp.

◆ selectableObjectAboutToBeDeleted()

void tracktion::engine::SelectionManager::selectableObjectAboutToBeDeleted ( Selectable *  s)
overridevirtual

Implements tracktion::engine::SelectableListener.

Definition at line 562 of file tracktion_SelectionManager.cpp.

◆ selectableObjectChanged()

void tracktion::engine::SelectionManager::selectableObjectChanged ( Selectable *  )
overridevirtual

Implements tracktion::engine::SelectableListener.

Definition at line 558 of file tracktion_SelectionManager.cpp.

◆ selectOnly() [1/2]

void tracktion::engine::SelectionManager::selectOnly ( Selectable &  s)

Definition at line 484 of file tracktion_SelectionManager.cpp.

◆ selectOnly() [2/2]

void tracktion::engine::SelectionManager::selectOnly ( Selectable *  s)

Definition at line 483 of file tracktion_SelectionManager.cpp.

◆ selectOtherObjects()

void tracktion::engine::SelectionManager::selectOtherObjects ( SelectableClass::Relationship  relationship,
bool  keepOldItemsSelected 
)

Selects related objects, e.g.

the thing to the right of the current thing, etc.

Definition at line 677 of file tracktion_SelectionManager.cpp.

Friends And Related Symbol Documentation

◆ Selectable

friend class Selectable
friend

Definition at line 181 of file tracktion_SelectionManager.h.

Member Data Documentation

◆ edit

SafeSelectable<Edit> tracktion::engine::SelectionManager::edit

If this SelectionManager is being used to represent items inside a particular view of an edit, this id should be set so you can find it by iterating the SelectionManagers.

Definition at line 172 of file tracktion_SelectionManager.h.

◆ editViewID

int tracktion::engine::SelectionManager::editViewID

Definition at line 173 of file tracktion_SelectionManager.h.

◆ engine

Engine& tracktion::engine::SelectionManager::engine

Definition at line 176 of file tracktion_SelectionManager.h.

◆ insertPoint

EditInsertPoint* tracktion::engine::SelectionManager::insertPoint

Definition at line 174 of file tracktion_SelectionManager.h.

◆ selectionChangeCount

int tracktion::engine::SelectionManager::selectionChangeCount

Definition at line 117 of file tracktion_SelectionManager.h.

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