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