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