libs/canvas/canvas/group.h

   1 /*
   2     Copyright (C) 2011-2013 Paul Davis
   3     Author: Carl Hetherington <cth@carlh.net>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #ifndef __CANVAS_GROUP_H__
  21 #define __CANVAS_GROUP_H__
  22
  23 #include <list>
  24 #include <vector>
  25
  26 #include "canvas/visibility.h"
  27 #include "canvas/item.h"
  28 #include "canvas/types.h"
  29 #include "canvas/lookup_table.h"
  30
  31 namespace ArdourCanvas {
  32
  33 class LIBCANVAS_API Group : public Item
  34 {
  35 public:
  36         explicit Group (Group *);
  37         explicit Group (Group *, Duple);
  38         ~Group ();
  39
  40         void render (Rect const &, Cairo::RefPtr<Cairo::Context>) const;
  41         virtual void compute_bounding_box () const;
  42
  43         void add (Item *);
  44         void remove (Item *);
  45          void clear (bool with_delete = false);
  46         std::list<Item*> const & items () const {
  47                 return _items;
  48         }
  49
  50         void raise_child_to_top (Item *);
  51         void raise_child (Item *, int);
  52         void lower_child_to_bottom (Item *);
  53         void child_changed ();
  54
  55         void add_items_at_point (Duple, std::vector<Item const *> &) const;
  56
  57         void dump (std::ostream&) const;
  58
  59         static int default_items_per_cell;
  60
  61 protected:
  62
  63         explicit Group (Canvas *);
  64
  65 private:
  66         friend class ::OptimizingLookupTableTest;
  67
  68         Group (Group const &);
  69         void ensure_lut () const;
  70         void invalidate_lut () const;
  71         void clear_items (bool with_delete);
  72
  73         /* our items, from lowest to highest in the stack */
  74         std::list<Item*> _items;
  75
  76         mutable LookupTable* _lut;
  77 };
  78
  79 }
  80
  81 #endif