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