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 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  21 #error "Only <gtk/gtk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __GTK_TREE_MODEL_H__
  25 #define __GTK_TREE_MODEL_H__
  26
  27 #include <glib-object.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define GTK_TYPE_TREE_MODEL            (gtk_tree_model_get_type ())
  32 #define GTK_TREE_MODEL(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModel))
  33 #define GTK_IS_TREE_MODEL(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_MODEL))
  34 #define GTK_TREE_MODEL_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModelIface))
  35
  36 #define GTK_TYPE_TREE_ITER             (gtk_tree_iter_get_type ())
  37 #define GTK_TYPE_TREE_PATH             (gtk_tree_path_get_type ())
  38 #define GTK_TYPE_TREE_ROW_REFERENCE    (gtk_tree_row_reference_get_type ())
  39
  40 typedef struct _GtkTreeIter         GtkTreeIter;
  41 typedef struct _GtkTreePath         GtkTreePath;
  42 typedef struct _GtkTreeRowReference GtkTreeRowReference;
  43 typedef struct _GtkTreeModel        GtkTreeModel; /* Dummy typedef */
  44 typedef struct _GtkTreeModelIface   GtkTreeModelIface;
  45
  46 /**
  47  * GtkTreeModelForeachFunc:
  48  * @model: the #GtkTreeModel being iterated
  49  * @path: the current #GtkTreePath
  50  * @iter: the current #GtkTreeIter
  51  * @data: The user data passed to gtk_tree_model_foreach()
  52  *
  53  * Type of the callback passed to gtk_tree_model_foreach() to
  54  * iterate over the rows in a tree model.
  55  *
  56  * Return value: %TRUE to stop iterating, %FALSE to continue
  57  *
  58  */
  59 typedef gboolean (* GtkTreeModelForeachFunc) (GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter, gpointer data);
  60
  61 /**
  62  * GtkTreeModelFlags:
  63  * @GTK_TREE_MODEL_ITERS_PERSIST: iterators survive all signals
  64  *     emitted by the tree
  65  * @GTK_TREE_MODEL_LIST_ONLY: the model is a list only, and never
  66  *     has children
  67  *
  68  * These flags indicate various properties of a #GtkTreeModel.
  69  *
  70  * They are returned by gtk_tree_model_get_flags(), and must be
  71  * static for the lifetime of the object. A more complete description
  72  * of #GTK_TREE_MODEL_ITERS_PERSIST can be found in the overview of
  73  * this section.
  74  */
  75 typedef enum
  76 {
  77   GTK_TREE_MODEL_ITERS_PERSIST = 1 << 0,
  78   GTK_TREE_MODEL_LIST_ONLY = 1 << 1
  79 } GtkTreeModelFlags;
  80
  81 /**
  82  * GtkTreeIter:
  83  * @stamp: a unique stamp to catch invalid iterators
  84  * @user_data: model-specific data
  85  * @user_data2: model-specific data
  86  * @user_data3: model-specific data
  87  *
  88  * The <structname>GtkTreeIter</structname> is the primary structure
  89  * for accessing a #GtkTreeModel. Models are expected to put a unique
  90  * integer in the <structfield>stamp</structfield> member, and put
  91  * model-specific data in the three <structfield>user_data</structfield>
  92  * members.
  93  */
  94 struct _GtkTreeIter
  95 {
  96   gint stamp;
  97   gpointer user_data;
  98   gpointer user_data2;
  99   gpointer user_data3;
 100 };
 101
 102 struct _GtkTreeModelIface
 103 {
 104   GTypeInterface g_iface;
 105
 106   /* Signals */
 107   void         (* row_changed)           (GtkTreeModel *tree_model,
 108                                           GtkTreePath  *path,
 109                                           GtkTreeIter  *iter);
 110   void         (* row_inserted)          (GtkTreeModel *tree_model,
 111                                           GtkTreePath  *path,
 112                                           GtkTreeIter  *iter);
 113   void         (* row_has_child_toggled) (GtkTreeModel *tree_model,
 114                                           GtkTreePath  *path,
 115                                           GtkTreeIter  *iter);
 116   void         (* row_deleted)           (GtkTreeModel *tree_model,
 117                                           GtkTreePath  *path);
 118   void         (* rows_reordered)        (GtkTreeModel *tree_model,
 119                                           GtkTreePath  *path,
 120                                           GtkTreeIter  *iter,
 121                                           gint         *new_order);
 122
 123   /* Virtual Table */
 124   GtkTreeModelFlags (* get_flags)  (GtkTreeModel *tree_model);
 125
 126   gint         (* get_n_columns)   (GtkTreeModel *tree_model);
 127   GType        (* get_column_type) (GtkTreeModel *tree_model,
 128                                     gint          index_);
 129   gboolean     (* get_iter)        (GtkTreeModel *tree_model,
 130                                     GtkTreeIter  *iter,
 131                                     GtkTreePath  *path);
 132   GtkTreePath *(* get_path)        (GtkTreeModel *tree_model,
 133                                     GtkTreeIter  *iter);
 134   void         (* get_value)       (GtkTreeModel *tree_model,
 135                                     GtkTreeIter  *iter,
 136                                     gint          column,
 137                                     GValue       *value);
 138   gboolean     (* iter_next)       (GtkTreeModel *tree_model,
 139                                     GtkTreeIter  *iter);
 140   gboolean     (* iter_previous)   (GtkTreeModel *tree_model,
 141                                     GtkTreeIter  *iter);
 142   gboolean     (* iter_children)   (GtkTreeModel *tree_model,
 143                                     GtkTreeIter  *iter,
 144                                     GtkTreeIter  *parent);
 145   gboolean     (* iter_has_child)  (GtkTreeModel *tree_model,
 146                                     GtkTreeIter  *iter);
 147   gint         (* iter_n_children) (GtkTreeModel *tree_model,
 148                                     GtkTreeIter  *iter);
 149   gboolean     (* iter_nth_child)  (GtkTreeModel *tree_model,
 150                                     GtkTreeIter  *iter,
 151                                     GtkTreeIter  *parent,
 152                                     gint          n);
 153   gboolean     (* iter_parent)     (GtkTreeModel *tree_model,
 154                                     GtkTreeIter  *iter,
 155                                     GtkTreeIter  *child);
 156   void         (* ref_node)        (GtkTreeModel *tree_model,
 157                                     GtkTreeIter  *iter);
 158   void         (* unref_node)      (GtkTreeModel *tree_model,
 159                                     GtkTreeIter  *iter);
 160 };
 161
 162
 163 /* GtkTreePath operations */
 164 GtkTreePath *gtk_tree_path_new              (void);
 165 GtkTreePath *gtk_tree_path_new_from_string  (const gchar       *path);
 166 GtkTreePath *gtk_tree_path_new_from_indices (gint               first_index,
 167                                              ...);
 168 gchar       *gtk_tree_path_to_string        (GtkTreePath       *path);
 169 GtkTreePath *gtk_tree_path_new_first        (void);
 170 void         gtk_tree_path_append_index     (GtkTreePath       *path,
 171                                              gint               index_);
 172 void         gtk_tree_path_prepend_index    (GtkTreePath       *path,
 173                                              gint               index_);
 174 gint         gtk_tree_path_get_depth        (GtkTreePath       *path);
 175 gint        *gtk_tree_path_get_indices      (GtkTreePath       *path);
 176
 177 gint        *gtk_tree_path_get_indices_with_depth (GtkTreePath *path,
 178                                                    gint        *depth);
 179
 180 void         gtk_tree_path_free             (GtkTreePath       *path);
 181 GtkTreePath *gtk_tree_path_copy             (const GtkTreePath *path);
 182 GType        gtk_tree_path_get_type         (void) G_GNUC_CONST;
 183 gint         gtk_tree_path_compare          (const GtkTreePath *a,
 184                                              const GtkTreePath *b);
 185 void         gtk_tree_path_next             (GtkTreePath       *path);
 186 gboolean     gtk_tree_path_prev             (GtkTreePath       *path);
 187 gboolean     gtk_tree_path_up               (GtkTreePath       *path);
 188 void         gtk_tree_path_down             (GtkTreePath       *path);
 189
 190 gboolean     gtk_tree_path_is_ancestor      (GtkTreePath       *path,
 191                                              GtkTreePath       *descendant);
 192 gboolean     gtk_tree_path_is_descendant    (GtkTreePath       *path,
 193                                              GtkTreePath       *ancestor);
 194
 195 /* Row reference (an object that tracks model changes so it refers to the same
 196  * row always; a path refers to a position, not a fixed row).  You almost always
 197  * want to call gtk_tree_row_reference_new.
 198  */
 199
 200 GType                gtk_tree_row_reference_get_type (void) G_GNUC_CONST;
 201 GtkTreeRowReference *gtk_tree_row_reference_new       (GtkTreeModel        *model,
 202                                                        GtkTreePath         *path);
 203 GtkTreeRowReference *gtk_tree_row_reference_new_proxy (GObject             *proxy,
 204                                                        GtkTreeModel        *model,
 205                                                        GtkTreePath         *path);
 206 GtkTreePath         *gtk_tree_row_reference_get_path  (GtkTreeRowReference *reference);
 207 GtkTreeModel        *gtk_tree_row_reference_get_model (GtkTreeRowReference *reference);
 208 gboolean             gtk_tree_row_reference_valid     (GtkTreeRowReference *reference);
 209 GtkTreeRowReference *gtk_tree_row_reference_copy      (GtkTreeRowReference *reference);
 210 void                 gtk_tree_row_reference_free      (GtkTreeRowReference *reference);
 211 /* These two functions are only needed if you created the row reference with a
 212  * proxy object */
 213 void                 gtk_tree_row_reference_inserted  (GObject     *proxy,
 214                                                        GtkTreePath *path);
 215 void                 gtk_tree_row_reference_deleted   (GObject     *proxy,
 216                                                        GtkTreePath *path);
 217 void                 gtk_tree_row_reference_reordered (GObject     *proxy,
 218                                                        GtkTreePath *path,
 219                                                        GtkTreeIter *iter,
 220                                                        gint        *new_order);
 221
 222 /* GtkTreeIter operations */
 223 GtkTreeIter *     gtk_tree_iter_copy             (GtkTreeIter  *iter);
 224 void              gtk_tree_iter_free             (GtkTreeIter  *iter);
 225 GType             gtk_tree_iter_get_type         (void) G_GNUC_CONST;
 226
 227 GType             gtk_tree_model_get_type        (void) G_GNUC_CONST;
 228 GtkTreeModelFlags gtk_tree_model_get_flags       (GtkTreeModel *tree_model);
 229 gint              gtk_tree_model_get_n_columns   (GtkTreeModel *tree_model);
 230 GType             gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
 231                                                   gint          index_);
 232
 233
 234 /* Iterator movement */
 235 gboolean          gtk_tree_model_get_iter        (GtkTreeModel *tree_model,
 236                                                   GtkTreeIter  *iter,
 237                                                   GtkTreePath  *path);
 238 gboolean          gtk_tree_model_get_iter_from_string (GtkTreeModel *tree_model,
 239                                                        GtkTreeIter  *iter,
 240                                                        const gchar  *path_string);
 241 gchar *           gtk_tree_model_get_string_from_iter (GtkTreeModel *tree_model,
 242                                                        GtkTreeIter  *iter);
 243 gboolean          gtk_tree_model_get_iter_first  (GtkTreeModel *tree_model,
 244                                                   GtkTreeIter  *iter);
 245 GtkTreePath *     gtk_tree_model_get_path        (GtkTreeModel *tree_model,
 246                                                   GtkTreeIter  *iter);
 247 void              gtk_tree_model_get_value       (GtkTreeModel *tree_model,
 248                                                   GtkTreeIter  *iter,
 249                                                   gint          column,
 250                                                   GValue       *value);
 251 gboolean          gtk_tree_model_iter_previous   (GtkTreeModel *tree_model,
 252                                                   GtkTreeIter  *iter);
 253 gboolean          gtk_tree_model_iter_next       (GtkTreeModel *tree_model,
 254                                                   GtkTreeIter  *iter);
 255 gboolean          gtk_tree_model_iter_children   (GtkTreeModel *tree_model,
 256                                                   GtkTreeIter  *iter,
 257                                                   GtkTreeIter  *parent);
 258 gboolean          gtk_tree_model_iter_has_child  (GtkTreeModel *tree_model,
 259                                                   GtkTreeIter  *iter);
 260 gint              gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
 261                                                   GtkTreeIter  *iter);
 262 gboolean          gtk_tree_model_iter_nth_child  (GtkTreeModel *tree_model,
 263                                                   GtkTreeIter  *iter,
 264                                                   GtkTreeIter  *parent,
 265                                                   gint          n);
 266 gboolean          gtk_tree_model_iter_parent     (GtkTreeModel *tree_model,
 267                                                   GtkTreeIter  *iter,
 268                                                   GtkTreeIter  *child);
 269 void              gtk_tree_model_ref_node        (GtkTreeModel *tree_model,
 270                                                   GtkTreeIter  *iter);
 271 void              gtk_tree_model_unref_node      (GtkTreeModel *tree_model,
 272                                                   GtkTreeIter  *iter);
 273 void              gtk_tree_model_get             (GtkTreeModel *tree_model,
 274                                                   GtkTreeIter  *iter,
 275                                                   ...);
 276 void              gtk_tree_model_get_valist      (GtkTreeModel *tree_model,
 277                                                   GtkTreeIter  *iter,
 278                                                   va_list       var_args);
 279
 280
 281 void              gtk_tree_model_foreach         (GtkTreeModel            *model,
 282                                                   GtkTreeModelForeachFunc  func,
 283                                                   gpointer                 user_data);
 284
 285 /* Signals */
 286 void gtk_tree_model_row_changed           (GtkTreeModel *tree_model,
 287                                            GtkTreePath  *path,
 288                                            GtkTreeIter  *iter);
 289 void gtk_tree_model_row_inserted          (GtkTreeModel *tree_model,
 290                                            GtkTreePath  *path,
 291                                            GtkTreeIter  *iter);
 292 void gtk_tree_model_row_has_child_toggled (GtkTreeModel *tree_model,
 293                                            GtkTreePath  *path,
 294                                            GtkTreeIter  *iter);
 295 void gtk_tree_model_row_deleted           (GtkTreeModel *tree_model,
 296                                            GtkTreePath  *path);
 297 void gtk_tree_model_rows_reordered        (GtkTreeModel *tree_model,
 298                                            GtkTreePath  *path,
 299                                            GtkTreeIter  *iter,
 300                                            gint         *new_order);
 301
 302 G_END_DECLS
 303
 304 #endif /* __GTK_TREE_MODEL_H__ */