X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=gtk%2Fgtktreemodel.h;h=fed9850b3e04a8ac052327116c83bc6db61a2e40;hb=ca2368dba958d6fecf2fce417307bb9cbbe6eb6b;hp=36aca525da316c37113ba50a80a38bce8e3f703b;hpb=3b42e087a933300365b3eedfbf6f26602e35339b;p=~andy%2Fgtk
diff --git a/gtk/gtktreemodel.h b/gtk/gtktreemodel.h
index 36aca525d..fed9850b3 100644
--- a/gtk/gtktreemodel.h
+++ b/gtk/gtktreemodel.h
@@ -12,132 +12,294 @@
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see .
*/
#ifndef __GTK_TREE_MODEL_H__
#define __GTK_TREE_MODEL_H__
-#include
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only can be included directly."
+#endif
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+#include
+
+G_BEGIN_DECLS
#define GTK_TYPE_TREE_MODEL (gtk_tree_model_get_type ())
#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) ((GtkTreeModelIface *)g_type_interface_peek (((GTypeInstance *)GTK_TREE_MODEL (obj))->g_class, 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 gpointer GtkTreeNode;
-typedef struct _GtkTreePath GtkTreePath;
-typedef struct _GtkTreeModel GtkTreeModel; /* Dummy typedef */
-typedef struct _GtkTreeModelIface GtkTreeModelIface;
+/**
+ * GtkTreeModelForeachFunc:
+ * @model: the #GtkTreeModel being iterated
+ * @path: the current #GtkTreePath
+ * @iter: the current #GtkTreeIter
+ * @data: The user data passed to gtk_tree_model_foreach()
+ *
+ * Type of the callback passed to gtk_tree_model_foreach() to
+ * iterate over the rows in a tree model.
+ *
+ * Return value: %TRUE to stop iterating, %FALSE to continue
+ *
+ */
+typedef gboolean (* GtkTreeModelForeachFunc) (GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter, gpointer data);
+
+/**
+ * GtkTreeModelFlags:
+ * @GTK_TREE_MODEL_ITERS_PERSIST: iterators survive all signals
+ * emitted by the tree
+ * @GTK_TREE_MODEL_LIST_ONLY: the model is a list only, and never
+ * has children
+ *
+ * These flags indicate various properties of a #GtkTreeModel.
+ *
+ * They are returned by gtk_tree_model_get_flags(), and must be
+ * static for the lifetime of the object. A more complete description
+ * of #GTK_TREE_MODEL_ITERS_PERSIST can be found in the overview of
+ * this section.
+ */
+typedef enum
+{
+ GTK_TREE_MODEL_ITERS_PERSIST = 1 << 0,
+ GTK_TREE_MODEL_LIST_ONLY = 1 << 1
+} GtkTreeModelFlags;
+
+/**
+ * GtkTreeIter:
+ * @stamp: a unique stamp to catch invalid iterators
+ * @user_data: model-specific data
+ * @user_data2: model-specific data
+ * @user_data3: model-specific data
+ *
+ * The GtkTreeIter is the primary structure
+ * for accessing a #GtkTreeModel. Models are expected to put a unique
+ * integer in the stamp member, and put
+ * model-specific data in the three user_data
+ * members.
+ */
+struct _GtkTreeIter
+{
+ gint stamp;
+ gpointer user_data;
+ gpointer user_data2;
+ gpointer user_data3;
+};
struct _GtkTreeModelIface
{
GTypeInterface g_iface;
/* Signals */
- /* Currently unimplemented as interfaces do not support signals yet, so
- * objects implementing this interface need this. Later, it will be moved
- * back here.
- */
- 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 */
+ 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_previous) (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) G_GNUC_CONST;
-
-/* 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 (const GtkTreePath *a,
- const 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);
+gint *gtk_tree_path_get_indices_with_depth (GtkTreePath *path,
+ gint *depth);
-#endif /* __GTK_TREE_MODEL_H__ */
+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);
+
+/**
+ * GtkTreeRowReference:
+ *
+ * A GtkTreeRowReference tracks model changes so that it always refers to the
+ * same row (a #GtkTreePath refers to a position, not a fixed row). Create a
+ * new GtkTreeRowReference with 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_previous (GtkTreeModel *tree_model,
+ GtkTreeIter *iter);
+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);
+
+/* 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__ */