Vkeybd: use ArdourWidgets for all GUI elements
[ardour.git] / gtk2_ardour / selection.h
index e81e1bdea8624460f0c345c884c5ae2db67b144c..71230086b5bdb5b3e596cd3b2cf2064b3c404d62 100644 (file)
@@ -1,21 +1,26 @@
 /*
-    Copyright (C) 2000-2003 Paul Davis
-
-    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., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-*/
+ * 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__
@@ -65,7 +70,7 @@ namespace Evoral {
 
 class Selection : public sigc::trackable, public PBD::ScopedConnectionList
 {
-  public:
+public:
        enum SelectionType {
                Object = 0x1,
                Range = 0x2
@@ -86,14 +91,16 @@ class Selection : public sigc::trackable, public PBD::ScopedConnectionList
        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);
+       Selection (PublicEditor const * e, bool manage_libardour_selection);
 
        // Selection& operator= (const Selection& other);
 
-       sigc::signal<void> RegionsChanged;
        sigc::signal<void> TracksChanged;
+       sigc::signal<void> RegionsChanged;
        sigc::signal<void> TimeChanged;
        sigc::signal<void> LinesChanged;
        sigc::signal<void> PlaylistsChanged;
@@ -103,13 +110,19 @@ class Selection : public sigc::trackable, public PBD::ScopedConnectionList
        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*);
-       bool selected (RegionView*);
-       bool selected (Marker*);
+       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 &);
@@ -121,12 +134,13 @@ class Selection : public sigc::trackable, public PBD::ScopedConnectionList
        void set (RegionView*, bool also_clear_tracks = true);
        void set (MidiRegionView*);
        void set (std::vector<RegionView*>&);
-       long set (nframes_t, nframes_t);
+       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 (Marker*);
+       void set (ArdourMarker*);
        void set (const RegionSelection&);
 
        void toggle (TimeAxisView*);
@@ -136,13 +150,13 @@ class Selection : public sigc::trackable, public PBD::ScopedConnectionList
        void toggle (MidiRegionView*);
        void toggle (MidiCutBuffer*);
        void toggle (std::vector<RegionView*>&);
-       long toggle (nframes_t, nframes_t);
+       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 (Marker*);
+       void toggle (ArdourMarker*);
 
        void add (TimeAxisView*);
        void add (const TrackViewList&);
@@ -151,15 +165,16 @@ class Selection : public sigc::trackable, public PBD::ScopedConnectionList
        void add (MidiRegionView*);
        void add (MidiCutBuffer*);
        void add (std::vector<RegionView*>&);
-       long add (nframes_t, nframes_t);
+       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 (Marker*);
-       void add (const std::list<Marker*>&);
+       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&);
@@ -167,35 +182,63 @@ class Selection : public sigc::trackable, public PBD::ScopedConnectionList
        void remove (MidiRegionView*);
        void remove (MidiCutBuffer*);
        void remove (uint32_t selection_id);
-       void remove (nframes_t, nframes_t);
+       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 (Marker*);
+       void remove (ArdourMarker*);
+       void remove (ControlPoint *);
 
-       void replace (uint32_t time_index, nframes_t start, nframes_t end);
+       void remove_regions (TimeAxisView *);
 
-       void clear_regions();
-       void clear_tracks ();
-       void clear_time();
-       void clear_lines ();
-       void clear_playlists ();
-       void clear_points ();
-       void clear_markers ();
-       void clear_midi_notes ();
-       void clear_midi_regions ();
+       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);
 
-  private:
-       void set_point_selection_from_line (AutomationLine const &);
+       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);