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 G_BEGIN_DECLS
  26
  27 #define GTK_TYPE_TREE_MODEL            (gtk_tree_model_get_type ())
  28 #define GTK_TREE_MODEL(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModel))
  29 #define GTK_IS_TREE_MODEL(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_MODEL))
  30 #define GTK_TREE_MODEL_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModelIface))
  31
  32 #define GTK_TYPE_TREE_ITER             (gtk_tree_iter_get_type ())
  33 #define GTK_TYPE_TREE_PATH             (gtk_tree_path_get_type ())
  34
  35 typedef struct _GtkTreeIter         GtkTreeIter;
  36 typedef struct _GtkTreePath         GtkTreePath;
  37 typedef struct _GtkTreeRowReference GtkTreeRowReference;
  38 typedef struct _GtkTreeModel        GtkTreeModel; /* Dummy typedef */
  39 typedef struct _GtkTreeModelIface   GtkTreeModelIface;
  40 typedef gboolean (* GtkTreeModelForeachFunc) (GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter, gpointer data);
  41
  42
  43 typedef enum
  44 {
  45   GTK_TREE_MODEL_ITERS_PERSIST = 1 << 0,
  46   GTK_TREE_MODEL_LIST_ONLY = 1 << 1
  47 } GtkTreeModelFlags;
  48
  49 struct _GtkTreeIter
  50 {
  51   gint stamp;
  52   gpointer user_data;
  53   gpointer user_data2;
  54   gpointer user_data3;
  55 };
  56
  57 struct _GtkTreeModelIface
  58 {
  59   GTypeInterface g_iface;
  60
  61   /* Signals */
  62   void         (* row_changed)           (GtkTreeModel *tree_model,
  63                                           GtkTreePath  *path,
  64                                           GtkTreeIter  *iter);
  65   void         (* row_inserted)          (GtkTreeModel *tree_model,
  66                                           GtkTreePath  *path,
  67                                           GtkTreeIter  *iter);
  68   void         (* row_has_child_toggled) (GtkTreeModel *tree_model,
  69                                           GtkTreePath  *path,
  70                                           GtkTreeIter  *iter);
  71   void         (* row_deleted)           (GtkTreeModel *tree_model,
  72                                           GtkTreePath  *path);
  73   void         (* rows_reordered)        (GtkTreeModel *tree_model,
  74                                           GtkTreePath  *path,
  75                                           GtkTreeIter  *iter,
  76                                           gint         *new_order);
  77
  78   /* Virtual Table */
  79   GtkTreeModelFlags (* get_flags)  (GtkTreeModel *tree_model);
  80
  81   gint         (* get_n_columns)   (GtkTreeModel *tree_model);
  82   GType        (* get_column_type) (GtkTreeModel *tree_model,
  83                                     gint          index);
  84   gboolean     (* get_iter)        (GtkTreeModel *tree_model,
  85                                     GtkTreeIter  *iter,
  86                                     GtkTreePath  *path);
  87   GtkTreePath *(* get_path)        (GtkTreeModel *tree_model,
  88                                     GtkTreeIter  *iter);
  89   void         (* get_value)       (GtkTreeModel *tree_model,
  90                                     GtkTreeIter  *iter,
  91                                     gint          column,
  92                                     GValue       *value);
  93   gboolean     (* iter_next)       (GtkTreeModel *tree_model,
  94                                     GtkTreeIter  *iter);
  95   gboolean     (* iter_children)   (GtkTreeModel *tree_model,
  96                                     GtkTreeIter  *iter,
  97                                     GtkTreeIter  *parent);
  98   gboolean     (* iter_has_child)  (GtkTreeModel *tree_model,
  99                                     GtkTreeIter  *iter);
 100   gint         (* iter_n_children) (GtkTreeModel *tree_model,
 101                                     GtkTreeIter  *iter);
 102   gboolean     (* iter_nth_child)  (GtkTreeModel *tree_model,
 103                                     GtkTreeIter  *iter,
 104                                     GtkTreeIter  *parent,
 105                                     gint          n);
 106   gboolean     (* iter_parent)     (GtkTreeModel *tree_model,
 107                                     GtkTreeIter  *iter,
 108                                     GtkTreeIter  *child);
 109   void         (* ref_node)        (GtkTreeModel *tree_model,
 110                                     GtkTreeIter  *iter);
 111   void         (* unref_node)      (GtkTreeModel *tree_model,
 112                                     GtkTreeIter  *iter);
 113 };
 114
 115
 116 /* GtkTreePath operations */
 117 GtkTreePath *gtk_tree_path_new              (void);
 118 GtkTreePath *gtk_tree_path_new_from_string  (const gchar       *path);
 119 gchar       *gtk_tree_path_to_string        (GtkTreePath       *path);
 120 #define gtk_tree_path_new_root() gtk_tree_path_new_first()
 121 GtkTreePath *gtk_tree_path_new_first        (void);
 122 void         gtk_tree_path_append_index     (GtkTreePath       *path,
 123                                              gint               index);
 124 void         gtk_tree_path_prepend_index    (GtkTreePath       *path,
 125                                              gint               index);
 126 gint         gtk_tree_path_get_depth        (GtkTreePath       *path);
 127 gint        *gtk_tree_path_get_indices      (GtkTreePath       *path);
 128 void         gtk_tree_path_free             (GtkTreePath       *path);
 129 GtkTreePath *gtk_tree_path_copy             (GtkTreePath       *path);
 130 GType        gtk_tree_path_get_type         (void);
 131 gint         gtk_tree_path_compare          (const GtkTreePath *a,
 132                                              const GtkTreePath *b);
 133 void         gtk_tree_path_next             (GtkTreePath       *path);
 134 gboolean     gtk_tree_path_prev             (GtkTreePath       *path);
 135 gboolean     gtk_tree_path_up               (GtkTreePath       *path);
 136 void         gtk_tree_path_down             (GtkTreePath       *path);
 137
 138 gboolean     gtk_tree_path_is_ancestor      (GtkTreePath       *path,
 139                                              GtkTreePath       *descendant);
 140 gboolean     gtk_tree_path_is_descendant    (GtkTreePath       *path,
 141                                              GtkTreePath       *ancestor);
 142
 143 /* Row reference (an object that tracks model changes so it refers to the same
 144  * row always; a path refers to a position, not a fixed row).  You almost always
 145  * want to call gtk_tree_row_reference_new.
 146  */
 147
 148 GtkTreeRowReference *gtk_tree_row_reference_new       (GtkTreeModel        *model,
 149                                                        GtkTreePath         *path);
 150 GtkTreeRowReference *gtk_tree_row_reference_new_proxy (GObject             *proxy,
 151                                                        GtkTreeModel        *model,
 152                                                        GtkTreePath         *path);
 153 GtkTreePath         *gtk_tree_row_reference_get_path  (GtkTreeRowReference *reference);
 154 gboolean             gtk_tree_row_reference_valid     (GtkTreeRowReference *reference);
 155 void                 gtk_tree_row_reference_free      (GtkTreeRowReference *reference);
 156 /* These two functions are only needed if you created the row reference with a
 157  * proxy object */
 158 void                 gtk_tree_row_reference_inserted  (GObject     *proxy,
 159                                                        GtkTreePath *path);
 160 void                 gtk_tree_row_reference_deleted   (GObject     *proxy,
 161                                                        GtkTreePath *path);
 162 void                 gtk_tree_row_reference_reordered (GObject     *proxy,
 163                                                        GtkTreePath *path,
 164                                                        GtkTreeIter *iter,
 165                                                        gint        *new_order);
 166
 167 /* GtkTreeIter operations */
 168 GtkTreeIter *     gtk_tree_iter_copy             (GtkTreeIter  *iter);
 169 void              gtk_tree_iter_free             (GtkTreeIter  *iter);
 170 GType             gtk_tree_iter_get_type         (void);
 171
 172 GtkType           gtk_tree_model_get_type        (void) G_GNUC_CONST;
 173 GtkTreeModelFlags gtk_tree_model_get_flags       (GtkTreeModel *tree_model);
 174 gint              gtk_tree_model_get_n_columns   (GtkTreeModel *tree_model);
 175 GType             gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
 176                                                   gint          index);
 177
 178
 179 /* Iterator movement */
 180 gboolean          gtk_tree_model_get_iter        (GtkTreeModel *tree_model,
 181                                                   GtkTreeIter  *iter,
 182                                                   GtkTreePath  *path);
 183 gboolean          gtk_tree_model_get_iter_from_string (GtkTreeModel *tree_model,
 184                                                        GtkTreeIter  *iter,
 185                                                        const gchar  *path_string);
 186 #define gtk_tree_model_get_iter_root(tree_model, iter) gtk_tree_model_get_iter_first(tree_model, iter)
 187 gboolean          gtk_tree_model_get_iter_first  (GtkTreeModel *tree_model,
 188                                                   GtkTreeIter  *iter);
 189 GtkTreePath *     gtk_tree_model_get_path        (GtkTreeModel *tree_model,
 190                                                   GtkTreeIter  *iter);
 191 void              gtk_tree_model_get_value       (GtkTreeModel *tree_model,
 192                                                   GtkTreeIter  *iter,
 193                                                   gint          column,
 194                                                   GValue       *value);
 195 gboolean          gtk_tree_model_iter_next       (GtkTreeModel *tree_model,
 196                                                   GtkTreeIter  *iter);
 197 gboolean          gtk_tree_model_iter_children   (GtkTreeModel *tree_model,
 198                                                   GtkTreeIter  *iter,
 199                                                   GtkTreeIter  *parent);
 200 gboolean          gtk_tree_model_iter_has_child  (GtkTreeModel *tree_model,
 201                                                   GtkTreeIter  *iter);
 202 gint              gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
 203                                                   GtkTreeIter  *iter);
 204 gboolean          gtk_tree_model_iter_nth_child  (GtkTreeModel *tree_model,
 205                                                   GtkTreeIter  *iter,
 206                                                   GtkTreeIter  *parent,
 207                                                   gint          n);
 208 gboolean          gtk_tree_model_iter_parent     (GtkTreeModel *tree_model,
 209                                                   GtkTreeIter  *iter,
 210                                                   GtkTreeIter  *child);
 211 void              gtk_tree_model_ref_node        (GtkTreeModel *tree_model,
 212                                                   GtkTreeIter  *iter);
 213 void              gtk_tree_model_unref_node      (GtkTreeModel *tree_model,
 214                                                   GtkTreeIter  *iter);
 215 void              gtk_tree_model_get             (GtkTreeModel *tree_model,
 216                                                   GtkTreeIter  *iter,
 217                                                   ...);
 218 void              gtk_tree_model_get_valist      (GtkTreeModel *tree_model,
 219                                                   GtkTreeIter  *iter,
 220                                                   va_list       var_args);
 221
 222
 223 void              gtk_tree_model_foreach         (GtkTreeModel            *model,
 224                                                   GtkTreeModelForeachFunc  func,
 225                                                   gpointer                 user_data);
 226
 227
 228 /* Signals */
 229 void gtk_tree_model_row_changed           (GtkTreeModel *tree_model,
 230                                            GtkTreePath  *path,
 231                                            GtkTreeIter  *iter);
 232 void gtk_tree_model_row_inserted          (GtkTreeModel *tree_model,
 233                                            GtkTreePath  *path,
 234                                            GtkTreeIter  *iter);
 235 void gtk_tree_model_row_has_child_toggled (GtkTreeModel *tree_model,
 236                                            GtkTreePath  *path,
 237                                            GtkTreeIter  *iter);
 238 void gtk_tree_model_row_deleted           (GtkTreeModel *tree_model,
 239                                            GtkTreePath  *path);
 240 void gtk_tree_model_rows_reordered        (GtkTreeModel *tree_model,
 241                                            GtkTreePath  *path,
 242                                            GtkTreeIter  *iter,
 243                                            gint         *new_order);
 244
 245
 246
 247
 248 G_END_DECLS
 249
 250 #endif /* __GTK_TREE_MODEL_H__ */