gtk2_ardour/region_selection.h

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17 */
  18
  19 #ifndef __ardour_gtk_region_selection_h__
  20 #define __ardour_gtk_region_selection_h__
  21
  22 #include <set>
  23 #include <list>
  24
  25 #include <boost/signals2.hpp>
  26
  27 #include "ardour/types.h"
  28
  29 class RegionView;
  30 class TimeAxisView;
  31
  32 /** Class to represent list of selected regions.
  33  */
  34 class RegionSelection : public std::list<RegionView*>
  35 {
  36   public:
  37         RegionSelection();
  38         RegionSelection (const RegionSelection&);
  39
  40         RegionSelection& operator= (const RegionSelection&);
  41
  42         bool add (RegionView*);
  43         bool remove (RegionView*);
  44         void sort_by_position_and_track ();
  45
  46         bool contains (RegionView*) const;
  47         bool involves (const TimeAxisView&) const;
  48
  49         void clear_all();
  50
  51         nframes_t start () const {
  52                 return _current_start;
  53         }
  54
  55         /* "end" collides with list<>::end */
  56
  57         nframes_t end_frame () const {
  58                 return _current_end;
  59         }
  60
  61         const std::list<RegionView *>& by_layer() const { return _bylayer; }
  62         void  by_position (std::list<RegionView*>&) const;
  63         void  by_track (std::list<RegionView*>&) const;
  64
  65   private:
  66         void remove_it (RegionView*);
  67
  68         void add_to_layer (RegionView *);
  69
  70         nframes_t _current_start; ///< start position for the selection
  71         nframes_t _current_end; ///< end position for the selection
  72
  73         std::list<RegionView *> _bylayer; ///< list of regions sorted by layer
  74         boost::signals2::scoped_connection death_connection;
  75 };
  76
  77 #endif /* __ardour_gtk_region_selection_h__ */