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