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