libs/canvas/canvas/container.h

   1 /*
   2     Copyright (C) 2011-2014 Paul Davis
   3     Original 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_CONTAINER_H__
  21 #define __CANVAS_CONTAINER_H__
  22
  23 #include "canvas/item.h"
  24
  25 namespace ArdourCanvas
  26 {
  27
  28 /** a Container is an item which has no content of its own
  29  * but renders its children in some geometrical arrangement.
  30  *
  31  * Imagined examples of containers:
  32  *
  33  *   Container: renders each child at the child's self-determined position
  34  *   Box: renders each child along an axis (vertical or horizontal)
  35  *   Table/Grid: renders each child within a two-dimensional grid
  36  *
  37  *   Other?
  38  */
  39 class LIBCANVAS_API Container : public Item
  40 {
  41 public:
  42         Container (Canvas *);
  43         Container (Item *);
  44         Container (Item *, Duple const & position);
  45
  46         /** The compute_bounding_box() method is likely to be identical
  47          * in all containers (the union of the children's bounding boxes).
  48          * It can be overriden as necessary.
  49          */
  50         void compute_bounding_box () const;
  51
  52         /** The render() method is likely to be identical in all containers
  53          *  (just call Item::render_children()). It can be overridden as necessary.
  54          */
  55         void render (Rect const & area, Cairo::RefPtr<Cairo::Context> context) const;
  56 };
  57
  58 }
  59
  60 #endif