ardour/gtk2_ardour/selection.h
Robin Gareus 4050ca5633
Update GPL boilerplate and (C)
Copyright-holder and year information is extracted from git log.

git history begins in 2005. So (C) from 1998..2005 is lost. Also some
(C) assignment of commits where the committer didn't use --author.
2019-08-03 15:53:15 +02:00

247 lines
7.9 KiB
C++

/*
* Copyright (C) 2005 Taybin Rutkin <taybin@taybin.com>
* Copyright (C) 2006-2014 David Robillard <d@drobilla.net>
* Copyright (C) 2006-2017 Paul Davis <paul@linuxaudiosystems.com>
* Copyright (C) 2007-2012 Carl Hetherington <carl@carlh.net>
* Copyright (C) 2014-2018 Ben Loftis <ben@harrisonconsoles.com>
* Copyright (C) 2015-2016 Nick Mainsbridge <mainsbridge@gmail.com>
* Copyright (C) 2015-2017 Robin Gareus <robin@gareus.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef __ardour_gtk_selection_h__
#define __ardour_gtk_selection_h__
#include <vector>
#include <boost/shared_ptr.hpp>
#include <boost/noncopyable.hpp>
#include <sigc++/signal.h>
#include "pbd/signals.h"
#include "time_selection.h"
#include "region_selection.h"
#include "track_selection.h"
#include "automation_selection.h"
#include "playlist_selection.h"
#include "processor_selection.h"
#include "point_selection.h"
#include "marker_selection.h"
#include "midi_selection.h"
class TimeAxisView;
class RegionView;
class Selectable;
class PublicEditor;
class MidiRegionView;
class AutomationLine;
class ControlPoint;
namespace ARDOUR {
class Region;
class AudioRegion;
class Playlist;
class Processor;
class AutomationList;
}
namespace Evoral {
class ControlList;
}
/// Lists of selected things
/** The Selection class holds lists of selected items (tracks, regions, etc. etc.). */
class Selection : public sigc::trackable, public PBD::ScopedConnectionList
{
public:
enum SelectionType {
Object = 0x1,
Range = 0x2
};
enum Operation {
Set,
Add,
Toggle,
Extend
};
TrackSelection tracks;
RegionSelection regions;
TimeSelection time;
AutomationSelection lines;
PlaylistSelection playlists;
PointSelection points;
MarkerSelection markers;
MidiRegionSelection midi_regions;
/** only used when this class is used as a cut buffer */
MidiNoteSelection midi_notes;
Selection (PublicEditor const * e, bool manage_libardour_selection);
// Selection& operator= (const Selection& other);
sigc::signal<void> TracksChanged;
sigc::signal<void> RegionsChanged;
sigc::signal<void> TimeChanged;
sigc::signal<void> LinesChanged;
sigc::signal<void> PlaylistsChanged;
sigc::signal<void> PointsChanged;
sigc::signal<void> MarkersChanged;
sigc::signal<void> MidiNotesChanged;
sigc::signal<void> MidiRegionsChanged;
void clear ();
/** check if all selections are empty
* @param internal_selection also check object internals (e.g midi notes, automation points), when false only check objects.
* @return true if nothing is selected.
*/
bool empty (bool internal_selection = false);
void dump_region_layers();
bool selected (TimeAxisView*) const;
bool selected (RegionView*) const;
bool selected (ArdourMarker*) const;
bool selected (ControlPoint*) const;
void set (std::list<Selectable*> const &);
void add (std::list<Selectable*> const &);
void toggle (std::list<Selectable*> const &);
void set (TimeAxisView*);
void set (const TrackViewList&);
void set (const MidiNoteSelection&);
void set (RegionView*, bool also_clear_tracks = true);
void set (MidiRegionView*);
void set (std::vector<RegionView*>&);
long set (samplepos_t, samplepos_t);
void set_preserving_all_ranges (samplepos_t, samplepos_t);
void set (boost::shared_ptr<Evoral::ControlList>);
void set (boost::shared_ptr<ARDOUR::Playlist>);
void set (const std::list<boost::shared_ptr<ARDOUR::Playlist> >&);
void set (ControlPoint *);
void set (ArdourMarker*);
void set (const RegionSelection&);
void toggle (TimeAxisView*);
void toggle (const TrackViewList&);
void toggle (const MidiNoteSelection&);
void toggle (RegionView*);
void toggle (MidiRegionView*);
void toggle (MidiCutBuffer*);
void toggle (std::vector<RegionView*>&);
long toggle (samplepos_t, samplepos_t);
void toggle (ARDOUR::AutomationList*);
void toggle (boost::shared_ptr<ARDOUR::Playlist>);
void toggle (const std::list<boost::shared_ptr<ARDOUR::Playlist> >&);
void toggle (ControlPoint *);
void toggle (std::vector<ControlPoint*> const &);
void toggle (ArdourMarker*);
void add (TimeAxisView*);
void add (const TrackViewList&);
void add (const MidiNoteSelection&);
void add (RegionView*);
void add (MidiRegionView*);
void add (MidiCutBuffer*);
void add (std::vector<RegionView*>&);
long add (samplepos_t, samplepos_t);
void add (boost::shared_ptr<Evoral::ControlList>);
void add (boost::shared_ptr<ARDOUR::Playlist>);
void add (const std::list<boost::shared_ptr<ARDOUR::Playlist> >&);
void add (ControlPoint *);
void add (std::vector<ControlPoint*> const &);
void add (ArdourMarker*);
void add (const std::list<ArdourMarker*>&);
void add (const RegionSelection&);
void add (const PointSelection&);
void remove (TimeAxisView*);
void remove (const TrackViewList&);
void remove (const MidiNoteSelection&);
void remove (RegionView*);
void remove (MidiRegionView*);
void remove (MidiCutBuffer*);
void remove (uint32_t selection_id);
void remove (samplepos_t, samplepos_t);
void remove (boost::shared_ptr<ARDOUR::AutomationList>);
void remove (boost::shared_ptr<ARDOUR::Playlist>);
void remove (const std::list<boost::shared_ptr<ARDOUR::Playlist> >&);
void remove (const std::list<Selectable*>&);
void remove (ArdourMarker*);
void remove (ControlPoint *);
void remove_regions (TimeAxisView *);
void move_time (samplecnt_t);
void replace (uint32_t time_index, samplepos_t start, samplepos_t end);
/*
* A note about items in an editing Selection:
* At a high level, selections can include Tracks, Objects, or Time Ranges
* Range and Object selections are mutually exclusive.
* Selecting a Range will deselect all Objects, and vice versa.
* This is done to avoid confusion over what will happen in an operation such as Delete
* Tracks are somewhat orthogonal b/c editing operations don't apply to tracks.
* The Track selection isn't affected when ranges or objects are added.
*/
void clear_all() { clear_time(); clear_tracks(); clear_objects(); }
void clear_time(bool with_signal = true); //clears any time selection ( i.e. Range )
void clear_tracks (bool with_signal = true); //clears the track header selections
void clear_objects(bool with_signal = true); //clears the items listed below
// these items get cleared wholesale in clear_objects
void clear_regions(bool with_signal = true);
void clear_lines (bool with_signal = true);
void clear_playlists (bool with_signal = true);
void clear_points (bool with_signal = true);
void clear_markers (bool with_signal = true);
void clear_midi_notes (bool with_signal = true);
void clear_midi_regions (bool with_signal = true);
void foreach_region (void (ARDOUR::Region::*method)(void));
void foreach_regionview (void (RegionView::*method)(void));
void foreach_midi_regionview (void (MidiRegionView::*method)(void));
template<class A> void foreach_region (void (ARDOUR::Region::*method)(A), A arg);
XMLNode& get_state () const;
int set_state (XMLNode const &, int);
std::list<std::pair<PBD::ID const, std::list<Evoral::event_id_t> > > pending_midi_note_selection;
void core_selection_changed (PBD::PropertyChange const & pc);
private:
PublicEditor const * editor;
uint32_t next_time_id;
bool manage_libardour_selection;
TrackViewList add_grouped_tracks (TrackViewList const & t);
};
bool operator==(const Selection& a, const Selection& b);
#endif /* __ardour_gtk_selection_h__ */