ec30090929
2000-10-15 Chris Toshok <toshok@helixcode.com> * e-tree-model.c: get rid of ENode type, as everything in it is now in ETreePath, and add parent/sibling/child pointers to ETreePath. everywhere where GNode/ENode were used, we just use ETreePath now. (e_tree_path_depth): new function. (e_tree_path_insert): new function. (e_tree_path_unlink): new function. (e_tree_model_node_traverse): new function. (etree_get_first_child): new virtual function impl. (etree_get_last_child): same. (e_tree_model_class_init): fill in function pointers for get_first_child/get_last_child. (e_tree_model_node_get_first_child): new function. (e_tree_model_node_get_last_child): new function. (e_tree_model_node_depth): g_node_depth -> e_tree_path_depth. (e_tree_model_node_insert): modify to use ETreePath and new e_tree_path functions. Prepends and appends are now both constant time. (child_remove): modify for e_tree_model_node_traverse. (e_tree_model_node_remove): same, and use e_tree_path functions. (e_tree_model_node_insert_before): add a loop here to figure out the position, since it's the only place we care about the child position. (e_tree_model_node_sort): rework to accomodate new e_tree_path functions, and put the e_tree_model_node_set_expanded calls in a separate loop after all the children have been added. * e-tree-model.h: add prototypes and virtual functions for more tree traversal operations (get_first_child, get_last_child), as well as a new function to traverse depth first the descendents of a node (e_tree_model_node_traverse), much like g_node_traverse (G_IN_ORDER). Also, ETreePath is an opaque type now, and is not a GNode. svn path=/trunk/; revision=5932
135 lines
6.9 KiB
C
135 lines
6.9 KiB
C
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
|
|
#ifndef _E_TREE_MODEL_H_
|
|
#define _E_TREE_MODEL_H_
|
|
|
|
#include <gdk-pixbuf/gdk-pixbuf.h>
|
|
#include <gal/e-table/e-table-model.h>
|
|
|
|
#define E_TREE_MODEL_TYPE (e_tree_model_get_type ())
|
|
#define E_TREE_MODEL(o) (GTK_CHECK_CAST ((o), E_TREE_MODEL_TYPE, ETreeModel))
|
|
#define E_TREE_MODEL_CLASS(k) (GTK_CHECK_CLASS_CAST((k), E_TREE_MODEL_TYPE, ETreeModelClass))
|
|
#define E_IS_TREE_MODEL(o) (GTK_CHECK_TYPE ((o), E_TREE_MODEL_TYPE))
|
|
#define E_IS_TREE_MODEL_CLASS(k) (GTK_CHECK_CLASS_TYPE ((k), E_TREE_MODEL_TYPE))
|
|
|
|
typedef struct ETreePath ETreePath;
|
|
typedef struct ETreeModel ETreeModel;
|
|
typedef struct ETreeModelClass ETreeModelClass;
|
|
typedef gint (*ETreePathCompareFunc)(ETreeModel *model, ETreePath *path1, ETreePath *path2);
|
|
typedef gboolean (*ETreePathFunc)(ETreeModel *model, ETreePath *path, gpointer data);
|
|
|
|
struct ETreeModel {
|
|
ETableModel base;
|
|
ETreePath *root;
|
|
gboolean root_visible;
|
|
GArray *row_array; /* used in the mapping between ETable and our tree */
|
|
guint32 num_expanded_to_save;
|
|
guint32 num_collapsed_to_save;
|
|
GHashTable *expanded_state; /* used for loading/saving expanded state */
|
|
GString *sort_group; /* for caching the last sort group info */
|
|
};
|
|
|
|
struct ETreeModelClass {
|
|
ETableModelClass parent_class;
|
|
|
|
/*
|
|
* Virtual methods
|
|
*/
|
|
ETreePath *(*get_root) (ETreeModel *etm);
|
|
|
|
ETreePath *(*get_parent) (ETreeModel *etm, ETreePath* node);
|
|
ETreePath *(*get_first_child) (ETreeModel *etm, ETreePath* node);
|
|
ETreePath *(*get_last_child) (ETreeModel *etm, ETreePath* node);
|
|
ETreePath *(*get_next) (ETreeModel *etm, ETreePath* node);
|
|
ETreePath *(*get_prev) (ETreeModel *etm, ETreePath* node);
|
|
guint (*get_children) (ETreeModel *etm, ETreePath* node, ETreePath ***paths);
|
|
|
|
gboolean (*is_expanded) (ETreeModel *etm, ETreePath* node);
|
|
gboolean (*is_visible) (ETreeModel *etm, ETreePath* node);
|
|
void (*set_expanded) (ETreeModel *etm, ETreePath* node, gboolean expanded);
|
|
void (*set_expanded_recurse) (ETreeModel *etm, ETreePath *node, gboolean expanded);
|
|
void (*set_expanded_level) (ETreeModel *etm, ETreePath *node, gboolean expanded, int level);
|
|
|
|
GdkPixbuf *(*icon_at) (ETreeModel *etm, ETreePath* node);
|
|
ETreePath* (*node_at_row) (ETreeModel *etm, int row);
|
|
|
|
/*
|
|
* ETable analogs
|
|
*/
|
|
void *(*value_at) (ETreeModel *etm, ETreePath* node, int col);
|
|
void (*set_value_at) (ETreeModel *etm, ETreePath* node, int col, const void *val);
|
|
gboolean (*is_editable) (ETreeModel *etm, ETreePath* node, int col);
|
|
|
|
|
|
/*
|
|
* Signals
|
|
*/
|
|
void (*node_changed) (ETreeModel *etm, ETreePath *node);
|
|
void (*node_inserted) (ETreeModel *etm, ETreePath *parent, ETreePath *inserted_node);
|
|
void (*node_removed) (ETreeModel *etm, ETreePath *parent, ETreePath *removed_node);
|
|
void (*node_collapsed) (ETreeModel *etm, ETreePath *node);
|
|
void (*node_expanded) (ETreeModel *etm, ETreePath *node, gboolean *allow_expand);
|
|
|
|
};
|
|
|
|
GtkType e_tree_model_get_type (void);
|
|
void e_tree_model_construct (ETreeModel *etree);
|
|
ETreeModel *e_tree_model_new (void);
|
|
|
|
/* tree traversal operations */
|
|
ETreePath *e_tree_model_get_root (ETreeModel *etree);
|
|
ETreePath *e_tree_model_node_get_parent (ETreeModel *etree, ETreePath *path);
|
|
ETreePath *e_tree_model_node_get_first_child (ETreeModel *etree, ETreePath *path);
|
|
ETreePath *e_tree_model_node_get_last_child (ETreeModel *etree, ETreePath *path);
|
|
ETreePath *e_tree_model_node_get_next (ETreeModel *etree, ETreePath *path);
|
|
ETreePath *e_tree_model_node_get_prev (ETreeModel *etree, ETreePath *path);
|
|
|
|
/* node operations */
|
|
ETreePath *e_tree_model_node_insert (ETreeModel *etree, ETreePath *parent, int position, gpointer node_data);
|
|
ETreePath *e_tree_model_node_insert_before (ETreeModel *etree, ETreePath *parent, ETreePath *sibling, gpointer node_data);
|
|
gpointer e_tree_model_node_remove (ETreeModel *etree, ETreePath *path);
|
|
|
|
/* node accessors */
|
|
gboolean e_tree_model_node_is_root (ETreeModel *etree, ETreePath *path);
|
|
gboolean e_tree_model_node_is_expandable (ETreeModel *etree, ETreePath *path);
|
|
gboolean e_tree_model_node_is_expanded (ETreeModel *etree, ETreePath *path);
|
|
gboolean e_tree_model_node_is_visible (ETreeModel *etree, ETreePath *path);
|
|
void e_tree_model_node_set_expanded (ETreeModel *etree, ETreePath *path, gboolean expanded);
|
|
void e_tree_model_node_set_expanded_recurse (ETreeModel *etree, ETreePath *path, gboolean expanded);
|
|
guint e_tree_model_node_get_children (ETreeModel *etree, ETreePath *path, ETreePath ***paths);
|
|
guint e_tree_model_node_depth (ETreeModel *etree, ETreePath *path);
|
|
guint e_tree_model_node_num_visible_descendents (ETreeModel *etm, ETreePath *node);
|
|
gpointer e_tree_model_node_get_data (ETreeModel *etm, ETreePath *node);
|
|
void e_tree_model_node_set_data (ETreeModel *etm, ETreePath *node, gpointer node_data);
|
|
|
|
/* display oriented routines */
|
|
ETreePath *e_tree_model_node_at_row (ETreeModel *etree, int row);
|
|
GdkPixbuf *e_tree_model_icon_of_node (ETreeModel *etree, ETreePath *path);
|
|
int e_tree_model_row_of_node (ETreeModel *etree, ETreePath *path);
|
|
void e_tree_model_root_node_set_visible (ETreeModel *etree, gboolean visible);
|
|
gboolean e_tree_model_root_node_is_visible (ETreeModel *etree);
|
|
|
|
/* sort routine, analogous to gtk_ctree_node_sort */
|
|
void e_tree_model_node_set_compare_function (ETreeModel *tree_model, ETreePath *node, ETreePathCompareFunc compare);
|
|
void e_tree_model_node_sort (ETreeModel *tree_model, ETreePath *node);
|
|
|
|
/*
|
|
** Routines for emitting signals on the ETreeModel
|
|
*/
|
|
void e_tree_model_node_changed (ETreeModel *tree_model, ETreePath *node);
|
|
void e_tree_model_node_inserted (ETreeModel *tree_model, ETreePath *parent_node, ETreePath *inserted_node);
|
|
void e_tree_model_node_removed (ETreeModel *tree_model, ETreePath *parent_node, ETreePath *removed_node);
|
|
void e_tree_model_node_collapsed (ETreeModel *tree_model, ETreePath *node);
|
|
void e_tree_model_node_expanded (ETreeModel *tree_model, ETreePath *node, gboolean *allow_expand);
|
|
|
|
/* expanded state saving stuff */
|
|
gboolean e_tree_model_save_expanded_state (ETreeModel *etm, const char *filename);
|
|
gboolean e_tree_model_load_expanded_state (ETreeModel *etm, const char *filename);
|
|
void e_tree_model_node_set_save_id (ETreeModel *etm, ETreePath *node, const char *id);
|
|
ETreePath* e_tree_model_node_insert_id (ETreeModel *tree_model, ETreePath *parent_path,
|
|
int position, gpointer node_data, const char *save_id);
|
|
|
|
/* depth first traversal of path's descendents, calling func on each one */
|
|
void e_tree_model_node_traverse (ETreeModel *model, ETreePath *path, ETreePathFunc func, gpointer data);
|
|
|
|
#endif /* _E_TREE_MODEL_H */
|