Pileus Git - ~andy/gtk/blob - gtk/gtktreemodel.h

   1 /* gtktreemodel.h
   2  * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifndef __GTK_TREE_MODEL_H__
  21 #define __GTK_TREE_MODEL_H__
  22
  23 #include <gtk/gtkobject.h>
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif /* __cplusplus */
  28
  29 #define GTK_TYPE_TREE_MODEL            (gtk_tree_model_get_type ())
  30 #define GTK_TREE_MODEL(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModel))
  31 #define GTK_IS_TREE_MODEL(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_MODEL))
  32 #define GTK_TREE_MODEL_GET_IFACE(obj)  ((GtkTreeModelIface *)g_type_interface_peek (((GTypeInstance *)GTK_TREE_MODEL (obj))->g_class, GTK_TYPE_TREE_MODEL))
  33
  34
  35 typedef struct _GtkTreeIter       GtkTreeIter;
  36 typedef struct _GtkTreePath       GtkTreePath;
  37 typedef struct _GtkTreeModel      GtkTreeModel; /* Dummy typedef */
  38 typedef struct _GtkTreeModelIface GtkTreeModelIface;
  39
  40
  41 typedef enum
  42 {
  43   GTK_TREE_MODEL_ITERS_PERSIST = 1 << 0
  44 } GtkTreeModelFlags;
  45
  46 struct _GtkTreeIter
  47 {
  48   gint stamp;
  49   gpointer tree_node;
  50   gpointer tree_node2;
  51   gpointer tree_node3;
  52 };
  53
  54 struct _GtkTreeModelIface
  55 {
  56   GTypeInterface g_iface;
  57
  58   /* Signals */
  59   /* Currently unimplemented as interfaces do not support signals yet, so
  60    * objects implementing this interface need this.  Later, it will be moved
  61    * back here.
  62    */
  63   void         (* changed)           (GtkTreeModel *tree_model,
  64                                       GtkTreePath  *path,
  65                                       GtkTreeIter  *iter);
  66   void         (* inserted)          (GtkTreeModel *tree_model,
  67                                       GtkTreePath  *path,
  68                                       GtkTreeIter  *iter);
  69   void         (* child_toggled)     (GtkTreeModel *tree_model,
  70                                       GtkTreePath  *path,
  71                                       GtkTreeIter  *iter);
  72   void         (* deleted)           (GtkTreeModel *tree_model,
  73                                       GtkTreePath  *path);
  74   void         (* reordered)         (GtkTreeModel *tree_model,
  75                                       GtkTreePath  *path,
  76                                       gint         *new_order);
  77
  78   /* VTable - not signals */
  79   guint        (* get_flags)       (GtkTreeModel *tree_model);
  80   gint         (* get_n_columns)   (GtkTreeModel *tree_model);
  81   GType        (* get_column_type) (GtkTreeModel *tree_model,
  82                                     gint          index);
  83   gboolean     (* get_iter)        (GtkTreeModel *tree_model,
  84                                     GtkTreeIter  *iter,
  85                                     GtkTreePath  *path);
  86   GtkTreePath *(* get_path)        (GtkTreeModel *tree_model,
  87                                     GtkTreeIter  *iter);
  88   void         (* get_value)       (GtkTreeModel *tree_model,
  89                                     GtkTreeIter  *iter,
  90                                     gint          column,
  91                                     GValue       *value);
  92   gboolean     (* iter_next)       (GtkTreeModel *tree_model,
  93                                     GtkTreeIter  *iter);
  94   gboolean     (* iter_children)   (GtkTreeModel *tree_model,
  95                                     GtkTreeIter  *iter,
  96                                     GtkTreeIter  *parent);
  97   gboolean     (* iter_has_child)  (GtkTreeModel *tree_model,
  98                                     GtkTreeIter  *iter);
  99   gint         (* iter_n_children) (GtkTreeModel *tree_model,
 100                                     GtkTreeIter  *iter);
 101   gboolean     (* iter_nth_child)  (GtkTreeModel *tree_model,
 102                                     GtkTreeIter  *iter,
 103                                     GtkTreeIter  *parent,
 104                                     gint          n);
 105   gboolean     (* iter_parent)     (GtkTreeModel *tree_model,
 106                                     GtkTreeIter  *iter,
 107                                     GtkTreeIter  *child);
 108   void         (* ref_iter)        (GtkTreeModel *tree_model,
 109                                     GtkTreeIter  *iter);
 110   void         (* unref_iter)      (GtkTreeModel *tree_model,
 111                                     GtkTreeIter  *iter);
 112 };
 113
 114
 115 /* GtkTreePath operations */
 116 GtkTreePath *gtk_tree_path_new              (void);
 117 GtkTreePath *gtk_tree_path_new_from_string  (gchar             *path);
 118 gchar       *gtk_tree_path_to_string        (GtkTreePath       *path);
 119 GtkTreePath *gtk_tree_path_new_root         (void);
 120 void         gtk_tree_path_append_index     (GtkTreePath       *path,
 121                                              gint               index);
 122 void         gtk_tree_path_prepend_index    (GtkTreePath       *path,
 123                                              gint               index);
 124 gint         gtk_tree_path_get_depth        (GtkTreePath       *path);
 125 gint        *gtk_tree_path_get_indices      (GtkTreePath       *path);
 126 void         gtk_tree_path_free             (GtkTreePath       *path);
 127 GtkTreePath *gtk_tree_path_copy             (GtkTreePath       *path);
 128 gint         gtk_tree_path_compare          (const GtkTreePath *a,
 129                                              const GtkTreePath *b);
 130 void         gtk_tree_path_next             (GtkTreePath       *path);
 131 gint         gtk_tree_path_prev             (GtkTreePath       *path);
 132 gint         gtk_tree_path_up               (GtkTreePath       *path);
 133 void         gtk_tree_path_down             (GtkTreePath       *path);
 134
 135
 136 /* GtkTreeIter operations */
 137 GtkTreeIter *gtk_tree_iter_copy             (GtkTreeIter       *iter);
 138 void         gtk_tree_iter_free             (GtkTreeIter       *iter);
 139
 140 /* GtkTreeModel stuff */
 141 GtkType      gtk_tree_model_get_type        (void) G_GNUC_CONST;
 142 guint        gtk_tree_model_get_flags       (GtkTreeModel      *tree_model);
 143
 144 /* Column information */
 145 gint         gtk_tree_model_get_n_columns   (GtkTreeModel      *tree_model);
 146 GType        gtk_tree_model_get_column_type (GtkTreeModel      *tree_model,
 147                                              gint               index);
 148
 149
 150 /* Iterator movement */
 151 gboolean     gtk_tree_model_get_iter        (GtkTreeModel      *tree_model,
 152                                              GtkTreeIter       *iter,
 153                                              GtkTreePath       *path);
 154 GtkTreePath *gtk_tree_model_get_path        (GtkTreeModel      *tree_model,
 155                                              GtkTreeIter       *iter);
 156 void         gtk_tree_model_get_value       (GtkTreeModel      *tree_model,
 157                                              GtkTreeIter       *iter,
 158                                              gint               column,
 159                                              GValue            *value);
 160 gboolean     gtk_tree_model_iter_next       (GtkTreeModel      *tree_model,
 161                                              GtkTreeIter       *iter);
 162 gboolean     gtk_tree_model_iter_children   (GtkTreeModel      *tree_model,
 163                                              GtkTreeIter       *iter,
 164                                              GtkTreeIter       *parent);
 165 gboolean     gtk_tree_model_iter_has_child  (GtkTreeModel      *tree_model,
 166                                              GtkTreeIter       *iter);
 167 gint         gtk_tree_model_iter_n_children (GtkTreeModel      *tree_model,
 168                                              GtkTreeIter       *iter);
 169 gboolean     gtk_tree_model_iter_nth_child  (GtkTreeModel      *tree_model,
 170                                              GtkTreeIter       *iter,
 171                                              GtkTreeIter       *parent,
 172                                              gint               n);
 173 gboolean     gtk_tree_model_iter_parent     (GtkTreeModel      *tree_model,
 174                                              GtkTreeIter       *iter,
 175                                              GtkTreeIter       *child);
 176 void         gtk_tree_model_ref_iter        (GtkTreeModel      *tree_model,
 177                                              GtkTreeIter       *iter);
 178 void         gtk_tree_model_unref_iter      (GtkTreeModel      *tree_model,
 179                                              GtkTreeIter       *iter);
 180
 181 #ifdef __cplusplus
 182 }
 183 #endif /* __cplusplus */
 184
 185
 186 #endif /* __GTK_TREE_MODEL_H__ */