2 Copyright (C) 2000-2003 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_gtk_selection_h__
21 #define __ardour_gtk_selection_h__
24 #include <boost/shared_ptr.hpp>
25 #include <boost/noncopyable.hpp>
27 #include <sigc++/signal.h>
29 #include "pbd/signals.h"
31 #include "time_selection.h"
32 #include "region_selection.h"
33 #include "track_selection.h"
34 #include "automation_selection.h"
35 #include "playlist_selection.h"
36 #include "processor_selection.h"
37 #include "point_selection.h"
38 #include "marker_selection.h"
39 #include "midi_selection.h"
62 /// Lists of selected things
64 /** The Selection class holds lists of selected items (tracks, regions, etc. etc.). */
66 class Selection : public sigc::trackable, public PBD::ScopedConnectionList
81 TrackSelection tracks;
82 RegionSelection regions;
84 AutomationSelection lines;
85 PlaylistSelection playlists;
86 PointSelection points;
87 MarkerSelection markers;
88 MidiRegionSelection midi_regions;
90 /** only used when this class is used as a cut buffer */
91 MidiNoteSelection midi_notes;
93 Selection (PublicEditor const * e);
95 // Selection& operator= (const Selection& other);
97 sigc::signal<void> RegionsChanged;
98 sigc::signal<void> TracksChanged;
99 sigc::signal<void> TimeChanged;
100 sigc::signal<void> LinesChanged;
101 sigc::signal<void> PlaylistsChanged;
102 sigc::signal<void> PointsChanged;
103 sigc::signal<void> MarkersChanged;
104 sigc::signal<void> MidiNotesChanged;
105 sigc::signal<void> MidiRegionsChanged;
107 void block_tracks_changed (bool);
111 /** check if all selections are empty
112 * @param internal_selection also check object internals (e.g midi notes, automation points), when false only check objects.
113 * @return true if nothing is selected.
115 bool empty (bool internal_selection = false);
117 void dump_region_layers();
119 bool selected (TimeAxisView*);
120 bool selected (RegionView*);
121 bool selected (ArdourMarker*);
122 bool selected (ControlPoint*);
124 void set (std::list<Selectable*> const &);
125 void add (std::list<Selectable*> const &);
126 void toggle (std::list<Selectable*> const &);
128 void set (TimeAxisView*);
129 void set (const TrackViewList&);
130 void set (const MidiNoteSelection&);
131 void set (RegionView*, bool also_clear_tracks = true);
132 void set (MidiRegionView*);
133 void set (std::vector<RegionView*>&);
134 long set (framepos_t, framepos_t);
135 void set_preserving_all_ranges (framepos_t, framepos_t);
136 void set (boost::shared_ptr<Evoral::ControlList>);
137 void set (boost::shared_ptr<ARDOUR::Playlist>);
138 void set (const std::list<boost::shared_ptr<ARDOUR::Playlist> >&);
139 void set (ControlPoint *);
140 void set (ArdourMarker*);
141 void set (const RegionSelection&);
143 void toggle (TimeAxisView*);
144 void toggle (const TrackViewList&);
145 void toggle (const MidiNoteSelection&);
146 void toggle (RegionView*);
147 void toggle (MidiRegionView*);
148 void toggle (MidiCutBuffer*);
149 void toggle (std::vector<RegionView*>&);
150 long toggle (framepos_t, framepos_t);
151 void toggle (ARDOUR::AutomationList*);
152 void toggle (boost::shared_ptr<ARDOUR::Playlist>);
153 void toggle (const std::list<boost::shared_ptr<ARDOUR::Playlist> >&);
154 void toggle (ControlPoint *);
155 void toggle (std::vector<ControlPoint*> const &);
156 void toggle (ArdourMarker*);
158 void add (TimeAxisView*);
159 void add (const TrackViewList&);
160 void add (const MidiNoteSelection&);
161 void add (RegionView*);
162 void add (MidiRegionView*);
163 void add (MidiCutBuffer*);
164 void add (std::vector<RegionView*>&);
165 long add (framepos_t, framepos_t);
166 void add (boost::shared_ptr<Evoral::ControlList>);
167 void add (boost::shared_ptr<ARDOUR::Playlist>);
168 void add (const std::list<boost::shared_ptr<ARDOUR::Playlist> >&);
169 void add (ControlPoint *);
170 void add (std::vector<ControlPoint*> const &);
171 void add (ArdourMarker*);
172 void add (const std::list<ArdourMarker*>&);
173 void add (const RegionSelection&);
174 void add (const PointSelection&);
175 void remove (TimeAxisView*);
176 void remove (const TrackViewList&);
177 void remove (const MidiNoteSelection&);
178 void remove (RegionView*);
179 void remove (MidiRegionView*);
180 void remove (MidiCutBuffer*);
181 void remove (uint32_t selection_id);
182 void remove (framepos_t, framepos_t);
183 void remove (boost::shared_ptr<ARDOUR::AutomationList>);
184 void remove (boost::shared_ptr<ARDOUR::Playlist>);
185 void remove (const std::list<boost::shared_ptr<ARDOUR::Playlist> >&);
186 void remove (const std::list<Selectable*>&);
187 void remove (ArdourMarker*);
188 void remove (ControlPoint *);
190 void remove_regions (TimeAxisView *);
192 void move_time (framecnt_t);
194 void replace (uint32_t time_index, framepos_t start, framepos_t end);
197 * A note about items in an editing Selection:
198 * At a high level, selections can include Tracks, Objects, or Time Ranges
199 * Range and Object selections are mutually exclusive.
200 * Selecting a Range will deselect all Objects, and vice versa.
201 * This is done to avoid confusion over what will happen in an operation such as Delete
202 * Tracks are somewhat orthogonal b/c editing operations don't apply to tracks.
203 * The Track selection isn't affected when ranges or objects are added.
206 void clear_all() { clear_time(); clear_tracks(); clear_objects(); }
208 void clear_time(bool with_signal = true); //clears any time selection ( i.e. Range )
209 void clear_tracks (bool with_signal = true); //clears the track header selections
210 void clear_objects(bool with_signal = true); //clears the items listed below
212 // these items get cleared wholesale in clear_objects
213 void clear_regions(bool with_signal = true);
214 void clear_lines (bool with_signal = true);
215 void clear_playlists (bool with_signal = true);
216 void clear_points (bool with_signal = true);
217 void clear_markers (bool with_signal = true);
218 void clear_midi_notes (bool with_signal = true);
219 void clear_midi_regions (bool with_signal = true);
221 void foreach_region (void (ARDOUR::Region::*method)(void));
222 void foreach_regionview (void (RegionView::*method)(void));
223 void foreach_midi_regionview (void (MidiRegionView::*method)(void));
224 template<class A> void foreach_region (void (ARDOUR::Region::*method)(A), A arg);
226 XMLNode& get_state () const;
227 int set_state (XMLNode const &, int);
229 std::list<std::pair<PBD::ID const, std::list<boost::shared_ptr<Evoral::Note<Evoral::Beats> > > > > pending_midi_note_selection;
232 PublicEditor const * editor;
233 uint32_t next_time_id;
234 bool _no_tracks_changed;
237 bool operator==(const Selection& a, const Selection& b);
239 #endif /* __ardour_gtk_selection_h__ */