the daily dose of const'ness
[ardour.git] / gtk2_ardour / selection.h
index 1e2257fc15fc934df2bbde8af2aac410e471a33e..959690b95dc8e909d06bdf70da7d1bb606093a61 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2003 Paul Davis 
+    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
 
 #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 "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;
@@ -55,7 +63,7 @@ namespace Evoral {
 
 /** The Selection class holds lists of selected items (tracks, regions, etc. etc.). */
 
-class Selection : public sigc::trackable 
+class Selection : public sigc::trackable, public PBD::ScopedConnectionList
 {
   public:
        enum SelectionType {
@@ -77,101 +85,149 @@ class Selection : public sigc::trackable
        PlaylistSelection    playlists;
        PointSelection       points;
        MarkerSelection      markers;
+       MidiRegionSelection  midi_regions;
 
-       Selection (PublicEditor const * e) : editor (e), next_time_id (0) {
-               clear();
-       }
+       /** only used when this class is used as a cut buffer */
+       MidiNoteSelection    midi_notes;
 
-       Selection& operator= (const Selection& other);
+       Selection (PublicEditor const * e);
+
+       // Selection& operator= (const Selection& other);
 
        sigc::signal<void> RegionsChanged;
-       sigc::signal<void> TracksChanged;
        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 ();
-       bool empty();
+
+       /** 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 &);
+       void toggle (std::list<Selectable*> const &);
 
-       void set (std::list<Selectable*>&);
-       void add (std::list<Selectable*>&);
-       void toggle (std::list<Selectable*>&);
-       
        void set (TimeAxisView*);
-       void set (const std::list<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 (TimeAxisView*, nframes_t, nframes_t);
+       long set (framepos_t, framepos_t);
+       void set_preserving_all_ranges (framepos_t, framepos_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 (AutomationSelectable*);
-       void set (Marker*);
+       void set (ControlPoint *);
+       void set (ArdourMarker*);
        void set (const RegionSelection&);
 
        void toggle (TimeAxisView*);
-       void toggle (const std::list<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 (nframes_t, nframes_t);
+       long toggle (framepos_t, framepos_t);
        void toggle (ARDOUR::AutomationList*);
        void toggle (boost::shared_ptr<ARDOUR::Playlist>);
        void toggle (const std::list<boost::shared_ptr<ARDOUR::Playlist> >&);
-       void toggle (const std::vector<AutomationSelectable*>&);
-       void toggle (Marker*);
+       void toggle (ControlPoint *);
+       void toggle (std::vector<ControlPoint*> const &);
+       void toggle (ArdourMarker*);
 
        void add (TimeAxisView*);
-       void add (const std::list<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 (nframes_t, nframes_t);
+       long add (framepos_t, framepos_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 (Marker*);
-       void add (const std::list<Marker*>&);
+       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 std::list<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 (nframes_t, nframes_t);
+       void remove (framepos_t, framepos_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 list<Selectable*>&);
-       void remove (Marker*);
-
-       void replace (uint32_t time_index, nframes_t start, nframes_t end);
-       
-       void clear_regions();
-       void clear_tracks ();
-       void clear_time();
-       void clear_lines ();
-       void clear_playlists ();
-       void clear_points ();
-       void clear_markers ();
+       void remove (const std::list<Selectable*>&);
+       void remove (ArdourMarker*);
+       void remove (ControlPoint *);
+
+       void remove_regions (TimeAxisView *);
+
+        void move_time (framecnt_t);
+
+       void replace (uint32_t time_index, framepos_t start, framepos_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);
 
-       void select_edit_group_regions ();
+       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;
 
   private:
        PublicEditor const * editor;
        uint32_t next_time_id;
-
-       void add (std::vector<AutomationSelectable*>&);
 };
 
 bool operator==(const Selection& a, const Selection& b);