add new Box container for Canvas.

API subject to change and improvement

1 files changed, 105 insertions, 0 deletions

diff --git a/libs/canvas/canvas/box.h b/libs/canvas/canvas/box.h
new file mode 100644
index 0000000000..b3b2b85303
--- /dev/null
+++ b/libs/canvas/canvas/box.h
@@ -0,0 +1,105 @@
+/*
+    Copyright (C) 2011-2014 Paul Davis
+    Original Author: Carl Hetherington <cth@carlh.net>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#ifndef __CANVAS_BOX_H__
+#define __CANVAS_BOX_H__
+
+#include "canvas/item.h"
+
+namespace ArdourCanvas
+{
+
+class Rectangle;
+
+/** a Container is an item which has no content of its own
+ * but renders its children in some geometrical arrangement.
+ *
+ * Imagined examples of containers:
+ *
+ *   Container: renders each child at the child's self-determined position
+ *   Box: renders each child along an axis (vertical or horizontal)
+ *   Table/Grid: renders each child within a two-dimensional grid
+ *
+ *   Other?
+ */
+class LIBCANVAS_API Box : public Item
+{
+public:
+	enum Orientation {
+		Vertical,
+		Horizontal
+	};
+
+	Box (Canvas *, Orientation);
+	Box (Item *, Orientation);
+	Box (Item *, Duple const & position, Orientation);
+
+	void set_spacing (double s);
+	void set_padding (double top, double right = -1.0, double bottom = -1.0, double left = -1.0);
+	void set_margin (double top, double right = -1.0, double bottom = -1.0, double left = -1.0);
+
+	/* aliases so that CSS box model terms work */
+	void set_border_width (double w) { set_outline_width (w); }
+	void set_border_color (Color c)  { set_outline_color (c); }
+
+	void add (Item*);
+	void pack_start (Item*, double extra_padding = 0);
+	void pack_end (Item*, double extra_padding = 0);
+
+	void set_collapse_on_hide (bool);
+	void set_homogenous (bool);
+
+	void compute_bounding_box () const;
+	void render (Rect const & area, Cairo::RefPtr<Cairo::Context> context) const;
+
+  protected:
+	Orientation orientation;
+	double spacing;
+	double top_padding, right_padding, bottom_padding, left_padding;
+	double top_margin, right_margin, bottom_margin, left_margin;
+
+	void child_changed ();
+  private:
+	Rectangle *self;
+	bool collapse_on_hide;
+	bool homogenous;
+
+	void reset_self ();
+	void reposition_children ();
+};
+
+class LIBCANVAS_API VBox : public Box
+{
+  public:
+	VBox (Canvas *);
+	VBox (Item *);
+	VBox (Item *, Duple const & position);
+};
+
+class LIBCANVAS_API HBox : public Box
+{
+  public:
+	HBox (Canvas *);
+	HBox (Item *);
+	HBox (Item *, Duple const & position);
+};
+
+}
+
+#endif