* Boston, MA 02111-1307, USA.
*/
+#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
#ifndef __GTK_TREE_MODEL_H__
#define __GTK_TREE_MODEL_H__
+#include <glib-object.h>
+
+/* Not needed, retained for compatibility -Yosh */
#include <gtk/gtkobject.h>
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+G_BEGIN_DECLS
#define GTK_TYPE_TREE_MODEL (gtk_tree_model_get_type ())
-#define GTK_TREE_MODEL(obj) (GTK_CHECK_CAST ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModel))
-#define GTK_TREE_MODEL_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_MODEL, GtkTreeModelClass))
-#define GTK_IS_TREE_MODEL(obj) (GTK_CHECK_TYPE ((obj), GTK_TYPE_TREE_MODEL))
-#define GTK_IS_TREE_MODEL_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), GTK_TYPE_TREE_MODEL))
-#define GTK_TREE_MODEL_GET_CLASS(obj) (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModelClass))
-
-typedef gpointer GtkTreeNode;
-typedef struct _GtkTreePath GtkTreePath;
-typedef struct _GtkTreeModel GtkTreeModel;
-typedef struct _GtkTreeModelClass GtkTreeModelClass;
-
-struct _GtkTreeModel
+#define GTK_TREE_MODEL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModel))
+#define GTK_IS_TREE_MODEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_MODEL))
+#define GTK_TREE_MODEL_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModelIface))
+
+#define GTK_TYPE_TREE_ITER (gtk_tree_iter_get_type ())
+#define GTK_TYPE_TREE_PATH (gtk_tree_path_get_type ())
+#define GTK_TYPE_TREE_ROW_REFERENCE (gtk_tree_row_reference_get_type ())
+
+typedef struct _GtkTreeIter GtkTreeIter;
+typedef struct _GtkTreePath GtkTreePath;
+typedef struct _GtkTreeRowReference GtkTreeRowReference;
+typedef struct _GtkTreeModel GtkTreeModel; /* Dummy typedef */
+typedef struct _GtkTreeModelIface GtkTreeModelIface;
+typedef gboolean (* GtkTreeModelForeachFunc) (GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter, gpointer data);
+
+
+typedef enum
{
- GtkObject parent;
+ GTK_TREE_MODEL_ITERS_PERSIST = 1 << 0,
+ GTK_TREE_MODEL_LIST_ONLY = 1 << 1
+} GtkTreeModelFlags;
+
+struct _GtkTreeIter
+{
+ gint stamp;
+ gpointer user_data;
+ gpointer user_data2;
+ gpointer user_data3;
};
-struct _GtkTreeModelClass
+struct _GtkTreeModelIface
{
- GtkObjectClass parent_class;
-
- /* signals */
- void (* node_changed) (GtkTreeModel *tree_model,
- GtkTreePath *path,
- GtkTreeNode node);
- void (* node_inserted) (GtkTreeModel *tree_model,
- GtkTreePath *path,
- GtkTreeNode node);
- void (* node_child_toggled) (GtkTreeModel *tree_model,
- GtkTreePath *path,
- GtkTreeNode node);
- void (* node_deleted) (GtkTreeModel *tree_model,
- GtkTreePath *path);
-
- /* VTable - not signals */
+ GTypeInterface g_iface;
+
+ /* Signals */
+ void (* row_changed) (GtkTreeModel *tree_model,
+ GtkTreePath *path,
+ GtkTreeIter *iter);
+ void (* row_inserted) (GtkTreeModel *tree_model,
+ GtkTreePath *path,
+ GtkTreeIter *iter);
+ void (* row_has_child_toggled) (GtkTreeModel *tree_model,
+ GtkTreePath *path,
+ GtkTreeIter *iter);
+ void (* row_deleted) (GtkTreeModel *tree_model,
+ GtkTreePath *path);
+ void (* rows_reordered) (GtkTreeModel *tree_model,
+ GtkTreePath *path,
+ GtkTreeIter *iter,
+ gint *new_order);
+
+ /* Virtual Table */
+ GtkTreeModelFlags (* get_flags) (GtkTreeModel *tree_model);
+
gint (* get_n_columns) (GtkTreeModel *tree_model);
- GtkTreeNode (* get_node) (GtkTreeModel *tree_model,
+ GType (* get_column_type) (GtkTreeModel *tree_model,
+ gint index_);
+ gboolean (* get_iter) (GtkTreeModel *tree_model,
+ GtkTreeIter *iter,
GtkTreePath *path);
GtkTreePath *(* get_path) (GtkTreeModel *tree_model,
- GtkTreeNode node);
- void (* node_get_value) (GtkTreeModel *tree_model,
- GtkTreeNode node,
+ GtkTreeIter *iter);
+ void (* get_value) (GtkTreeModel *tree_model,
+ GtkTreeIter *iter,
gint column,
GValue *value);
- gboolean (* node_next) (GtkTreeModel *tree_model,
- GtkTreeNode *node);
- GtkTreeNode (* node_children) (GtkTreeModel *tree_model,
- GtkTreeNode node);
- gboolean (* node_has_child) (GtkTreeModel *tree_model,
- GtkTreeNode node);
- gint (* node_n_children) (GtkTreeModel *tree_model,
- GtkTreeNode node);
- GtkTreeNode (* node_nth_child) (GtkTreeModel *tree_model,
- GtkTreeNode node,
+ gboolean (* iter_next) (GtkTreeModel *tree_model,
+ GtkTreeIter *iter);
+ gboolean (* iter_children) (GtkTreeModel *tree_model,
+ GtkTreeIter *iter,
+ GtkTreeIter *parent);
+ gboolean (* iter_has_child) (GtkTreeModel *tree_model,
+ GtkTreeIter *iter);
+ gint (* iter_n_children) (GtkTreeModel *tree_model,
+ GtkTreeIter *iter);
+ gboolean (* iter_nth_child) (GtkTreeModel *tree_model,
+ GtkTreeIter *iter,
+ GtkTreeIter *parent,
gint n);
- GtkTreeNode (* node_parent) (GtkTreeModel *tree_model,
- GtkTreeNode node);
+ gboolean (* iter_parent) (GtkTreeModel *tree_model,
+ GtkTreeIter *iter,
+ GtkTreeIter *child);
+ void (* ref_node) (GtkTreeModel *tree_model,
+ GtkTreeIter *iter);
+ void (* unref_node) (GtkTreeModel *tree_model,
+ GtkTreeIter *iter);
};
-/* Basic tree_model operations */
-GtkType gtk_tree_model_get_type (void);
-
-/* GtkTreePath Operations */
-GtkTreePath *gtk_tree_path_new (void);
-GtkTreePath *gtk_tree_path_new_from_string (gchar *path);
-gchar *gtk_tree_path_to_string (GtkTreePath *path);
-GtkTreePath *gtk_tree_path_new_root (void);
-void gtk_tree_path_append_index (GtkTreePath *path,
- gint index);
-void gtk_tree_path_prepend_index (GtkTreePath *path,
- gint index);
-gint gtk_tree_path_get_depth (GtkTreePath *path);
-gint *gtk_tree_path_get_indices (GtkTreePath *path);
-void gtk_tree_path_free (GtkTreePath *path);
-GtkTreePath *gtk_tree_path_copy (GtkTreePath *path);
-gint gtk_tree_path_compare (GtkTreePath *a,
- GtkTreePath *b);
-void gtk_tree_path_next (GtkTreePath *path);
-gint gtk_tree_path_prev (GtkTreePath *path);
-gint gtk_tree_path_up (GtkTreePath *path);
-void gtk_tree_path_down (GtkTreePath *path);
-
-/* Header operations */
-gint gtk_tree_model_get_n_columns (GtkTreeModel *tree_model);
-
-/* Node operations */
-GtkTreeNode gtk_tree_model_get_node (GtkTreeModel *tree_model,
- GtkTreePath *path);
-GtkTreePath *gtk_tree_model_get_path (GtkTreeModel *tree_model,
- GtkTreeNode node);
-void gtk_tree_model_node_get_value (GtkTreeModel *tree_model,
- GtkTreeNode node,
- gint column,
- GValue *value);
-gboolean gtk_tree_model_node_next (GtkTreeModel *tree_model,
- GtkTreeNode *node);
-GtkTreeNode gtk_tree_model_node_children (GtkTreeModel *tree_model,
- GtkTreeNode node);
-gboolean gtk_tree_model_node_has_child (GtkTreeModel *tree_model,
- GtkTreeNode node);
-gint gtk_tree_model_node_n_children (GtkTreeModel *tree_model,
- GtkTreeNode node);
-GtkTreeNode gtk_tree_model_node_nth_child (GtkTreeModel *tree_model,
- GtkTreeNode node,
- gint n);
-GtkTreeNode gtk_tree_model_node_parent (GtkTreeModel *tree_model,
- GtkTreeNode node);
-
-
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+/* GtkTreePath operations */
+GtkTreePath *gtk_tree_path_new (void);
+GtkTreePath *gtk_tree_path_new_from_string (const gchar *path);
+GtkTreePath *gtk_tree_path_new_from_indices (gint first_index,
+ ...);
+gchar *gtk_tree_path_to_string (GtkTreePath *path);
+GtkTreePath *gtk_tree_path_new_first (void);
+void gtk_tree_path_append_index (GtkTreePath *path,
+ gint index_);
+void gtk_tree_path_prepend_index (GtkTreePath *path,
+ gint index_);
+gint gtk_tree_path_get_depth (GtkTreePath *path);
+gint *gtk_tree_path_get_indices (GtkTreePath *path);
+void gtk_tree_path_free (GtkTreePath *path);
+GtkTreePath *gtk_tree_path_copy (const GtkTreePath *path);
+GType gtk_tree_path_get_type (void) G_GNUC_CONST;
+gint gtk_tree_path_compare (const GtkTreePath *a,
+ const GtkTreePath *b);
+void gtk_tree_path_next (GtkTreePath *path);
+gboolean gtk_tree_path_prev (GtkTreePath *path);
+gboolean gtk_tree_path_up (GtkTreePath *path);
+void gtk_tree_path_down (GtkTreePath *path);
+
+gboolean gtk_tree_path_is_ancestor (GtkTreePath *path,
+ GtkTreePath *descendant);
+gboolean gtk_tree_path_is_descendant (GtkTreePath *path,
+ GtkTreePath *ancestor);
+
+#ifndef GTK_DISABLE_DEPRECATED
+#define gtk_tree_path_new_root() gtk_tree_path_new_first()
+#endif /* !GTK_DISABLE_DEPRECATED */
+
+/* Row reference (an object that tracks model changes so it refers to the same
+ * row always; a path refers to a position, not a fixed row). You almost always
+ * want to call gtk_tree_row_reference_new.
+ */
+
+GType gtk_tree_row_reference_get_type (void) G_GNUC_CONST;
+GtkTreeRowReference *gtk_tree_row_reference_new (GtkTreeModel *model,
+ GtkTreePath *path);
+GtkTreeRowReference *gtk_tree_row_reference_new_proxy (GObject *proxy,
+ GtkTreeModel *model,
+ GtkTreePath *path);
+GtkTreePath *gtk_tree_row_reference_get_path (GtkTreeRowReference *reference);
+GtkTreeModel *gtk_tree_row_reference_get_model (GtkTreeRowReference *reference);
+gboolean gtk_tree_row_reference_valid (GtkTreeRowReference *reference);
+GtkTreeRowReference *gtk_tree_row_reference_copy (GtkTreeRowReference *reference);
+void gtk_tree_row_reference_free (GtkTreeRowReference *reference);
+/* These two functions are only needed if you created the row reference with a
+ * proxy object */
+void gtk_tree_row_reference_inserted (GObject *proxy,
+ GtkTreePath *path);
+void gtk_tree_row_reference_deleted (GObject *proxy,
+ GtkTreePath *path);
+void gtk_tree_row_reference_reordered (GObject *proxy,
+ GtkTreePath *path,
+ GtkTreeIter *iter,
+ gint *new_order);
+
+/* GtkTreeIter operations */
+GtkTreeIter * gtk_tree_iter_copy (GtkTreeIter *iter);
+void gtk_tree_iter_free (GtkTreeIter *iter);
+GType gtk_tree_iter_get_type (void) G_GNUC_CONST;
+
+GType gtk_tree_model_get_type (void) G_GNUC_CONST;
+GtkTreeModelFlags gtk_tree_model_get_flags (GtkTreeModel *tree_model);
+gint gtk_tree_model_get_n_columns (GtkTreeModel *tree_model);
+GType gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
+ gint index_);
+
+
+/* Iterator movement */
+gboolean gtk_tree_model_get_iter (GtkTreeModel *tree_model,
+ GtkTreeIter *iter,
+ GtkTreePath *path);
+gboolean gtk_tree_model_get_iter_from_string (GtkTreeModel *tree_model,
+ GtkTreeIter *iter,
+ const gchar *path_string);
+gchar * gtk_tree_model_get_string_from_iter (GtkTreeModel *tree_model,
+ GtkTreeIter *iter);
+gboolean gtk_tree_model_get_iter_first (GtkTreeModel *tree_model,
+ GtkTreeIter *iter);
+GtkTreePath * gtk_tree_model_get_path (GtkTreeModel *tree_model,
+ GtkTreeIter *iter);
+void gtk_tree_model_get_value (GtkTreeModel *tree_model,
+ GtkTreeIter *iter,
+ gint column,
+ GValue *value);
+gboolean gtk_tree_model_iter_next (GtkTreeModel *tree_model,
+ GtkTreeIter *iter);
+gboolean gtk_tree_model_iter_children (GtkTreeModel *tree_model,
+ GtkTreeIter *iter,
+ GtkTreeIter *parent);
+gboolean gtk_tree_model_iter_has_child (GtkTreeModel *tree_model,
+ GtkTreeIter *iter);
+gint gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
+ GtkTreeIter *iter);
+gboolean gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model,
+ GtkTreeIter *iter,
+ GtkTreeIter *parent,
+ gint n);
+gboolean gtk_tree_model_iter_parent (GtkTreeModel *tree_model,
+ GtkTreeIter *iter,
+ GtkTreeIter *child);
+void gtk_tree_model_ref_node (GtkTreeModel *tree_model,
+ GtkTreeIter *iter);
+void gtk_tree_model_unref_node (GtkTreeModel *tree_model,
+ GtkTreeIter *iter);
+void gtk_tree_model_get (GtkTreeModel *tree_model,
+ GtkTreeIter *iter,
+ ...);
+void gtk_tree_model_get_valist (GtkTreeModel *tree_model,
+ GtkTreeIter *iter,
+ va_list var_args);
+
+
+void gtk_tree_model_foreach (GtkTreeModel *model,
+ GtkTreeModelForeachFunc func,
+ gpointer user_data);
+
+
+#ifndef GTK_DISABLE_DEPRECATED
+#define gtk_tree_model_get_iter_root(tree_model, iter) gtk_tree_model_get_iter_first(tree_model, iter)
+#endif /* !GTK_DISABLE_DEPRECATED */
+
+/* Signals */
+void gtk_tree_model_row_changed (GtkTreeModel *tree_model,
+ GtkTreePath *path,
+ GtkTreeIter *iter);
+void gtk_tree_model_row_inserted (GtkTreeModel *tree_model,
+ GtkTreePath *path,
+ GtkTreeIter *iter);
+void gtk_tree_model_row_has_child_toggled (GtkTreeModel *tree_model,
+ GtkTreePath *path,
+ GtkTreeIter *iter);
+void gtk_tree_model_row_deleted (GtkTreeModel *tree_model,
+ GtkTreePath *path);
+void gtk_tree_model_rows_reordered (GtkTreeModel *tree_model,
+ GtkTreePath *path,
+ GtkTreeIter *iter,
+ gint *new_order);
+G_END_DECLS
#endif /* __GTK_TREE_MODEL_H__ */
projects / ~andy / gtk / blobdiff