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