New files. A tree model using a GNode structure to store it's info.

2000-06-08  Chris Toshok  <toshok@helixcode.com>

	* e-tree-gnode.c, e-tree-gnode.h: New files.  A tree model using a
	GNode structure to store it's info.

	* e-tree-model.c, e-tree-model.h: New files.  A proxy model
	sitting between a table model and the real tree model (of which
	ETreeGNode is an example).

	* e-cell-tree.c, e-cell-tree.h: New files.  A cell renderer
	capable of wrapping up a subcell and drawing the tree controls for
	expanding/collapsing trees.

	* tree-expanded.xpm, tree-unexpanded.xpm: New files.  the standard
	+ and - icons.

	* e-tree-example-1.c: New file, giving a (pretty poor :) example
	of using ETreeGNode.

	* Makefile.am: at the tree stuff to the build, and build
	tree-example-1.

	* .cvsignore: ignore tree-example-1.

svn path=/trunk/; revision=3483

1 files changed, 385 insertions, 0 deletions

diff --git a/widgets/table/e-cell-tree.c b/widgets/table/e-cell-tree.c
new file mode 100644
index 0000000000..9f40bd0eae
--- /dev/null
+++ b/widgets/table/e-cell-tree.c
@@ -0,0 +1,385 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
+/* e-cell-tree.c - Tree cell renderer
+ * Copyright (C) 2000 Helix Code, Inc.
+ *
+ * Author: Chris Toshok <toshok@helixcode.com>
+ *
+ * A majority of code taken from:
+ *
+ * the ECellText renderer.
+ *
+ * Copyright (C) 1998 The Free Software Foundation
+ *
+ */
+
+#include <config.h>
+#include <gtk/gtkenums.h>
+#include <gtk/gtkentry.h>
+#include <gtk/gtkwindow.h>
+#include <gtk/gtkinvisible.h>
+#include <gtk/gtksignal.h>
+#include <gdk/gdkkeysyms.h>
+#include <libgnomeui/gnome-canvas.h>
+#include <stdio.h>
+#include "e-table-sorted-variable.h"
+#include "e-tree-model.h"
+#include "e-cell-tree.h"
+#include "e-util/e-util.h"
+#include "e-table-item.h"
+
+#include <gdk/gdkx.h> /* for BlackPixel */
+#include <ctype.h>
+#include <math.h>
+
+#include "tree-expanded.xpm"
+#include "tree-unexpanded.xpm"
+
+#define PARENT_TYPE e_cell_get_type ()
+
+typedef struct {
+	ECellView    cell_view;
+	ECellView   *subcell_view;
+	GdkGC       *gc;
+
+	GnomeCanvas *canvas;
+
+} ECellTreeView;
+
+static ECellClass *parent_class;
+
+static GdkPixbuf   *tree_expanded_pixbuf, *tree_unexpanded_pixbuf;
+
+static ETreePath*
+e_cell_tree_get_node (ETreeModel *tree_model, int row)
+{
+	return (ETreePath*)e_table_model_value_at (E_TABLE_MODEL(tree_model), -1, row);
+}
+
+static ETreeModel*
+e_cell_tree_get_tree_model (ETableModel *table_model, int row)
+{
+	return (ETreeModel*)e_table_model_value_at (table_model, -2, row);
+}
+
+/*
+ * ECell::new_view method
+ */
+static ECellView *
+ect_new_view (ECell *ecell, ETableModel *table_model, void *e_table_item_view)
+{
+	ECellTree *ect = E_CELL_TREE (ecell);
+	ECellTreeView *tree_view = g_new0 (ECellTreeView, 1);
+	GnomeCanvas *canvas = GNOME_CANVAS_ITEM (e_table_item_view)->canvas;
+	
+	tree_view->cell_view.ecell = ecell;
+	tree_view->cell_view.e_table_model = table_model;
+	tree_view->cell_view.e_table_item_view = e_table_item_view;
+	
+	/* create our subcell view */
+	tree_view->subcell_view = e_cell_new_view (ect->subcell, table_model, e_table_item_view /* XXX */);
+
+	tree_view->canvas = canvas;
+
+	return (ECellView *)tree_view;
+}
+
+/*
+ * ECell::kill_view method
+ */
+static void
+ect_kill_view (ECellView *ecv)
+{
+	ECellTreeView *tree_view = (ECellTreeView *) ecv;
+
+	/* kill our subcell view */
+	e_cell_kill_view (tree_view->subcell_view);
+
+	g_free (tree_view);
+}
+
+/*
+ * ECell::realize method
+ */
+static void
+ect_realize (ECellView *ecell_view)
+{
+	ECellTreeView *tree_view = (ECellTreeView *) ecell_view;
+
+	/* realize our subcell view */
+	e_cell_realize (tree_view->subcell_view);
+
+	tree_view->gc = gdk_gc_new (GTK_WIDGET (tree_view->canvas)->window);
+
+	gdk_gc_set_line_attributes (tree_view->gc, 1, 
+				    GDK_LINE_ON_OFF_DASH, None, None);
+	gdk_gc_set_dashes (tree_view->gc, 0, "\1\1", 2);
+
+	if (parent_class->realize)
+		(* parent_class->realize) (ecell_view);
+}
+
+/*
+ * ECell::unrealize method
+ */
+static void
+ect_unrealize (ECellView *ecv)
+{
+	ECellTreeView *tree_view = (ECellTreeView *) ecv;
+
+	/* unrealize our subcell view. */
+	e_cell_unrealize (tree_view->subcell_view);
+
+	gdk_gc_unref (tree_view->gc);
+	tree_view->gc = NULL;
+
+	if (parent_class->unrealize)
+		(* parent_class->unrealize) (ecv);
+}
+
+#define INDENT_AMOUNT 16
+/*
+ * ECell::draw method
+ */
+static void
+ect_draw (ECellView *ecell_view, GdkDrawable *drawable,
+	  int model_col, int view_col, int row, gboolean selected,
+	  int x1, int y1, int x2, int y2)
+{
+	ECellTreeView *tree_view = (ECellTreeView *)ecell_view;
+	ETreeModel *tree_model = e_cell_tree_get_tree_model(ecell_view->e_table_model, row);
+	ETreePath *node;
+	GdkRectangle rect, *clip_rect;
+	GtkWidget *canvas = GTK_WIDGET (tree_view->canvas);
+	GdkGC *fg_gc = canvas->style->fg_gc[GTK_STATE_ACTIVE];
+	GdkColor *background, *foreground;
+
+	int offset, subcell_offset;
+	gboolean expanded, expandable;
+
+	/* only draw the tree effects if we're the active sort */
+	if (/* XXX */ TRUE) {
+		/*
+		 * need to get the following things from the model
+		 * 1. depth of item.
+		 * 2. whether or not it has any children.
+		 * 3. whether the item is a toplevel item.
+		 * 3. ... anything else?
+		 */
+		node = e_cell_tree_get_node (tree_model, row);
+
+		offset = (e_tree_model_node_depth (tree_model, node) + 1) * INDENT_AMOUNT;
+		expandable = e_tree_model_node_is_expandable (tree_model, node);
+		expanded = e_tree_model_node_is_expanded (tree_model, node);
+		subcell_offset = offset;
+
+		/*
+		 * Be a nice citizen: clip to the region we are supposed to draw on
+		 */
+		rect.x = x1;
+		rect.y = y1;
+		rect.width = offset;
+		rect.height = y2 - y1;
+	
+		gdk_gc_set_clip_rectangle (tree_view->gc, &rect);
+		gdk_gc_set_clip_rectangle (fg_gc, &rect);
+		clip_rect = &rect;
+
+		if (selected){
+			background = &canvas->style->bg [GTK_STATE_SELECTED];
+			foreground = &canvas->style->text [GTK_STATE_SELECTED];
+		} else {
+			background = &canvas->style->base [GTK_STATE_NORMAL];
+			foreground = &canvas->style->text [GTK_STATE_NORMAL];
+		}
+		gdk_gc_set_foreground (tree_view->gc, background);
+		gdk_draw_rectangle (drawable, tree_view->gc, TRUE,
+				    rect.x, rect.y, rect.width, rect.height);
+		gdk_gc_set_foreground (tree_view->gc, foreground);
+
+		if (E_CELL_TREE(tree_view->cell_view.ecell)->draw_lines) {
+			/* draw our lines */
+			gdk_draw_line (drawable, tree_view->gc,
+				       rect.x + offset - INDENT_AMOUNT / 2,
+				       rect.y,
+				       rect.x + offset - INDENT_AMOUNT / 2,
+				       (e_tree_model_node_get_next (tree_model, node)
+					? rect.y + rect.height
+					: rect.y + rect.height / 2));
+
+			gdk_draw_line (drawable, tree_view->gc,
+				       rect.x + offset - INDENT_AMOUNT / 2 + 1,
+				       rect.y + rect.height / 2,
+				       rect.x + offset,
+				       rect.y + rect.height / 2);
+
+			/* now traverse back up to the root of the tree, checking at
+			   each level if the node has siblings, and drawing the
+			   correct vertical pipe for it's configuration. */
+			node = e_tree_model_node_get_parent (tree_model, node);
+			offset -= INDENT_AMOUNT;
+			while (node && ! e_tree_model_node_is_root (tree_model, node)) {
+				if (e_tree_model_node_get_next(tree_model, node)) {
+					gdk_draw_line (drawable, tree_view->gc,
+						       rect.x + offset - INDENT_AMOUNT / 2,
+						       rect.y,
+						       rect.x + offset - INDENT_AMOUNT / 2,
+						       rect.y + rect.height);
+				}
+				node = e_tree_model_node_get_parent (tree_model, node);
+				offset -= INDENT_AMOUNT;
+			}
+		}
+
+		/* now draw our icon if we're expandable */
+		if (expandable) {
+			GdkPixbuf *image = expanded ? tree_expanded_pixbuf : tree_unexpanded_pixbuf;
+			int width, height;
+
+			width = gdk_pixbuf_get_width(image);
+			height = gdk_pixbuf_get_height(image);
+
+			gdk_pixbuf_render_to_drawable_alpha (image,
+							     drawable,
+							     0, 0,
+							     x1 + subcell_offset - INDENT_AMOUNT / 2 - width / 2,
+							     y1 + (y2 - y1) / 2 - height / 2,
+							     width, height,
+							     GDK_PIXBUF_ALPHA_BILEVEL,
+							     128,
+							     GDK_RGB_DITHER_NORMAL,
+							     width, 0);
+		}
+	}
+
+	/* Now cause our subcell to draw its contents, shifted by
+	   subcell_offset pixels */
+	e_cell_draw (tree_view->subcell_view, drawable,
+		     model_col, view_col, row, selected,
+		     x1 + subcell_offset, y1, x2 + subcell_offset, y2);
+}
+
+/*
+ * ECell::event method
+ */
+static gint
+ect_event (ECellView *ecell_view, GdkEvent *event, int model_col, int view_col, int row)
+{
+	ECellTreeView *tree_view = (ECellTreeView *) ecell_view;
+
+	switch (event->type) {
+	case GDK_BUTTON_PRESS:
+	case GDK_BUTTON_RELEASE: {
+		/* if the event happened in our area of control (and
+                   we care about it), handle it. */
+		ETreeModel *tree_model = e_cell_tree_get_tree_model (ecell_view->e_table_model, row);
+		ETreePath *node = e_cell_tree_get_node (tree_model, row);
+		int offset = (e_tree_model_node_depth (tree_model, node) + 1) * INDENT_AMOUNT;
+
+		/* only activate the tree control if the click/release happens in the icon's area. */
+		if (event->button.x > (offset - INDENT_AMOUNT) && event->button.x < offset) {
+			if (e_tree_model_node_is_expandable (tree_model, node)) {
+				e_tree_model_node_set_expanded (tree_model,
+								node,
+								!e_tree_model_node_is_expanded(tree_model, node));
+			}
+			return TRUE;
+		}
+	}
+	default:
+		/* otherwise, pass it off to our subcell_view */
+		e_cell_event(tree_view->subcell_view, event, model_col, view_col, row);
+		return TRUE;
+	}
+}
+
+/*
+ * ECell::height method
+ */
+static int
+ect_height (ECellView *ecell_view, int model_col, int view_col, int row) 
+{
+	ECellTreeView *tree_view = (ECellTreeView *) ecell_view;
+
+	return e_cell_height (tree_view->subcell_view, model_col, view_col, row);
+}
+
+/*
+ * ECellView::enter_edit method
+ */
+static void *
+ect_enter_edit (ECellView *ecell_view, int model_col, int view_col, int row)
+{
+	return NULL;
+}
+
+/*
+ * ECellView::leave_edit method
+ */
+static void
+ect_leave_edit (ECellView *ecell_view, int model_col, int view_col, int row, void *edit_context)
+{
+}
+
+/*
+ * GtkObject::destroy method
+ */
+static void
+ect_destroy (GtkObject *object)
+{
+	ECellTree *ect = E_CELL_TREE (object);
+
+	/* destroy our subcell */
+	gtk_object_destroy (GTK_OBJECT (ect->subcell));
+
+	GTK_OBJECT_CLASS (parent_class)->destroy (object);
+}
+
+static void
+e_cell_tree_class_init (GtkObjectClass *object_class)
+{
+	ECellClass *ecc = (ECellClass *) object_class;
+
+	object_class->destroy = ect_destroy;
+
+	ecc->new_view   = ect_new_view;
+	ecc->kill_view  = ect_kill_view;
+	ecc->realize    = ect_realize;
+	ecc->unrealize  = ect_unrealize;
+	ecc->draw       = ect_draw;
+	ecc->event      = ect_event;
+	ecc->height     = ect_height;
+	ecc->enter_edit = ect_enter_edit;
+	ecc->leave_edit = ect_leave_edit;
+
+	parent_class = gtk_type_class (PARENT_TYPE);
+
+	/*
+	 * Create our pixbuf for expanding/unexpanding
+	 */
+	tree_expanded_pixbuf = gdk_pixbuf_new_from_xpm_data(tree_expanded_xpm);
+	tree_unexpanded_pixbuf = gdk_pixbuf_new_from_xpm_data(tree_unexpanded_xpm);
+}
+
+E_MAKE_TYPE(e_cell_tree, "ECellTree", ECellTree, e_cell_tree_class_init, NULL, PARENT_TYPE);
+
+void
+e_cell_tree_construct (ECellTree *ect,
+		       gboolean draw_lines,
+		       ECell *subcell)
+{		       
+	ect->subcell = subcell;
+	ect->draw_lines = draw_lines;
+}
+
+
+ECell *
+e_cell_tree_new (ETableModel *etm,
+		 gboolean draw_lines,
+		 ECell *subcell)
+{
+	ECellTree *ect = gtk_type_new (e_cell_tree_get_type ());
+
+	e_cell_tree_construct (ect, draw_lines, subcell);
+
+	return (ECell *) ect;
+}