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
  40
  41 typedef enum
  42 {
  43   GTK_TREE_MODEL_ITERS_PERSIST = 1 << 0
  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         (* changed)           (GtkTreeModel *tree_model,
  60                                       GtkTreePath  *path,
  61                                       GtkTreeIter  *iter);
  62   void         (* inserted)          (GtkTreeModel *tree_model,
  63                                       GtkTreePath  *path,
  64                                       GtkTreeIter  *iter);
  65   void         (* has_child_toggled) (GtkTreeModel *tree_model,
  66                                       GtkTreePath  *path,
  67                                       GtkTreeIter  *iter);
  68   void         (* deleted)           (GtkTreeModel *tree_model,
  69                                       GtkTreePath  *path);
  70   void         (* 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  (gchar             *path);
 116 gchar       *gtk_tree_path_to_string        (GtkTreePath       *path);
 117 GtkTreePath *gtk_tree_path_new_root         (void);
 118 void         gtk_tree_path_append_index     (GtkTreePath       *path,
 119                                              gint               index);
 120 void         gtk_tree_path_prepend_index    (GtkTreePath       *path,
 121                                              gint               index);
 122 gint         gtk_tree_path_get_depth        (GtkTreePath       *path);
 123 gint        *gtk_tree_path_get_indices      (GtkTreePath       *path);
 124 void         gtk_tree_path_free             (GtkTreePath       *path);
 125 GtkTreePath *gtk_tree_path_copy             (GtkTreePath       *path);
 126 gint         gtk_tree_path_compare          (const GtkTreePath *a,
 127                                              const GtkTreePath *b);
 128 void         gtk_tree_path_next             (GtkTreePath       *path);
 129 gboolean     gtk_tree_path_prev             (GtkTreePath       *path);
 130 gboolean     gtk_tree_path_up               (GtkTreePath       *path);
 131 void         gtk_tree_path_down             (GtkTreePath       *path);
 132
 133 gboolean     gtk_tree_path_is_ancestor      (GtkTreePath       *path,
 134                                              GtkTreePath       *descendant);
 135 gboolean     gtk_tree_path_is_descendant    (GtkTreePath       *path,
 136                                              GtkTreePath       *ancestor);
 137
 138 /* Row reference (an object that tracks model changes so it refers to the same
 139  * row always; a path refers to a position, not a fixed row).  You almost always
 140  * want to call gtk_tree_row_reference_new.
 141  */
 142
 143 GtkTreeRowReference *gtk_tree_row_reference_new       (GtkTreeModel        *model,
 144                                                        GtkTreePath         *path);
 145 GtkTreeRowReference *gtk_tree_row_reference_new_proxy (GObject             *proxy,
 146                                                        GtkTreeModel        *model,
 147                                                        GtkTreePath         *path);
 148 GtkTreePath         *gtk_tree_row_reference_get_path  (GtkTreeRowReference *reference);
 149 void                 gtk_tree_row_reference_free      (GtkTreeRowReference *reference);
 150
 151 /* These two functions are only needed if you created the row reference with a
 152  * proxy object */
 153 void                 gtk_tree_row_reference_inserted  (GObject     *proxy,
 154                                                        GtkTreePath *path);
 155 void                 gtk_tree_row_reference_deleted   (GObject     *proxy,
 156                                                        GtkTreePath *path);
 157 void                 gtk_tree_row_reference_reordered (GObject     *proxy,
 158                                                        GtkTreePath *path,
 159                                                        GtkTreeIter *iter,
 160                                                        gint        *new_order);
 161
 162 /* GtkTreeIter operations */
 163 GtkTreeIter *     gtk_tree_iter_copy             (GtkTreeIter  *iter);
 164 void              gtk_tree_iter_free             (GtkTreeIter  *iter);
 165
 166 GtkType           gtk_tree_model_get_type        (void) G_GNUC_CONST;
 167 GtkTreeModelFlags gtk_tree_model_get_flags       (GtkTreeModel *tree_model);
 168 gint              gtk_tree_model_get_n_columns   (GtkTreeModel *tree_model);
 169 GType             gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
 170                                                   gint          index);
 171
 172
 173 /* Iterator movement */
 174 gboolean          gtk_tree_model_get_iter        (GtkTreeModel *tree_model,
 175                                                   GtkTreeIter  *iter,
 176                                                   GtkTreePath  *path);
 177 gboolean          gtk_tree_model_get_first       (GtkTreeModel *tree_model,
 178                                                   GtkTreeIter  *iter);
 179 GtkTreePath *     gtk_tree_model_get_path        (GtkTreeModel *tree_model,
 180                                                   GtkTreeIter  *iter);
 181 void              gtk_tree_model_get_value       (GtkTreeModel *tree_model,
 182                                                   GtkTreeIter  *iter,
 183                                                   gint          column,
 184                                                   GValue       *value);
 185 gboolean          gtk_tree_model_iter_next       (GtkTreeModel *tree_model,
 186                                                   GtkTreeIter  *iter);
 187 gboolean          gtk_tree_model_iter_children   (GtkTreeModel *tree_model,
 188                                                   GtkTreeIter  *iter,
 189                                                   GtkTreeIter  *parent);
 190 gboolean          gtk_tree_model_iter_has_child  (GtkTreeModel *tree_model,
 191                                                   GtkTreeIter  *iter);
 192 gint              gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
 193                                                   GtkTreeIter  *iter);
 194 gboolean          gtk_tree_model_iter_nth_child  (GtkTreeModel *tree_model,
 195                                                   GtkTreeIter  *iter,
 196                                                   GtkTreeIter  *parent,
 197                                                   gint          n);
 198 gboolean          gtk_tree_model_iter_parent     (GtkTreeModel *tree_model,
 199                                                   GtkTreeIter  *iter,
 200                                                   GtkTreeIter  *child);
 201 void              gtk_tree_model_ref_node        (GtkTreeModel *tree_model,
 202                                                   GtkTreeIter  *iter);
 203 void              gtk_tree_model_unref_node      (GtkTreeModel *tree_model,
 204                                                   GtkTreeIter  *iter);
 205 void              gtk_tree_model_get             (GtkTreeModel *tree_model,
 206                                                   GtkTreeIter  *iter,
 207                                                   ...);
 208 void              gtk_tree_model_get_valist      (GtkTreeModel *tree_model,
 209                                                   GtkTreeIter  *iter,
 210                                                   va_list       var_args);
 211
 212
 213 /* Signals */
 214 void gtk_tree_model_changed           (GtkTreeModel *tree_model,
 215                                        GtkTreePath  *path,
 216                                        GtkTreeIter  *iter);
 217 void gtk_tree_model_inserted          (GtkTreeModel *tree_model,
 218                                        GtkTreePath  *path,
 219                                        GtkTreeIter  *iter);
 220 void gtk_tree_model_has_child_toggled (GtkTreeModel *tree_model,
 221                                        GtkTreePath  *path,
 222                                        GtkTreeIter  *iter);
 223 void gtk_tree_model_deleted           (GtkTreeModel *tree_model,
 224                                        GtkTreePath  *path);
 225 void gtk_tree_model_reordered         (GtkTreeModel *tree_model,
 226                                        GtkTreePath  *path,
 227                                        GtkTreeIter  *iter,
 228                                        gint         *new_order);
 229
 230
 231
 232 #ifdef __cplusplus
 233 }
 234 #endif /* __cplusplus */
 235
 236
 237 #endif /* __GTK_TREE_MODEL_H__ */