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   GTK_TREE_MODEL_LIST_ONLY = 1 << 1,
  45 } GtkTreeModelFlags;
  46
  47 struct _GtkTreeIter
  48 {
  49   gint stamp;
  50   gpointer user_data;
  51   gpointer user_data2;
  52   gpointer user_data3;
  53 };
  54
  55 struct _GtkTreeModelIface
  56 {
  57   GTypeInterface g_iface;
  58
  59   /* Signals */
  60   void         (* range_changed)     (GtkTreeModel *tree_model,
  61                                       GtkTreePath  *start_path,
  62                                       GtkTreeIter  *start_iter,
  63                                       GtkTreePath  *end_path,
  64                                       GtkTreeIter  *end_iter);
  65   void         (* inserted)          (GtkTreeModel *tree_model,
  66                                       GtkTreePath  *path,
  67                                       GtkTreeIter  *iter);
  68   void         (* has_child_toggled) (GtkTreeModel *tree_model,
  69                                       GtkTreePath  *path,
  70                                       GtkTreeIter  *iter);
  71   void         (* deleted)           (GtkTreeModel *tree_model,
  72                                       GtkTreePath  *path);
  73   void         (* reordered)         (GtkTreeModel *tree_model,
  74                                       GtkTreePath  *path,
  75                                       GtkTreeIter  *iter,
  76                                       gint         *new_order);
  77
  78   /* Virtual Table */
  79   GtkTreeModelFlags (* get_flags)  (GtkTreeModel *tree_model);
  80
  81   gint         (* get_n_columns)   (GtkTreeModel *tree_model);
  82   GType        (* get_column_type) (GtkTreeModel *tree_model,
  83                                     gint          index);
  84   gboolean     (* get_iter)        (GtkTreeModel *tree_model,
  85                                     GtkTreeIter  *iter,
  86                                     GtkTreePath  *path);
  87   GtkTreePath *(* get_path)        (GtkTreeModel *tree_model,
  88                                     GtkTreeIter  *iter);
  89   void         (* get_value)       (GtkTreeModel *tree_model,
  90                                     GtkTreeIter  *iter,
  91                                     gint          column,
  92                                     GValue       *value);
  93   gboolean     (* iter_next)       (GtkTreeModel *tree_model,
  94                                     GtkTreeIter  *iter);
  95   gboolean     (* iter_children)   (GtkTreeModel *tree_model,
  96                                     GtkTreeIter  *iter,
  97                                     GtkTreeIter  *parent);
  98   gboolean     (* iter_has_child)  (GtkTreeModel *tree_model,
  99                                     GtkTreeIter  *iter);
 100   gint         (* iter_n_children) (GtkTreeModel *tree_model,
 101                                     GtkTreeIter  *iter);
 102   gboolean     (* iter_nth_child)  (GtkTreeModel *tree_model,
 103                                     GtkTreeIter  *iter,
 104                                     GtkTreeIter  *parent,
 105                                     gint          n);
 106   gboolean     (* iter_parent)     (GtkTreeModel *tree_model,
 107                                     GtkTreeIter  *iter,
 108                                     GtkTreeIter  *child);
 109   void         (* ref_node)        (GtkTreeModel *tree_model,
 110                                     GtkTreeIter  *iter);
 111   void         (* unref_node)      (GtkTreeModel *tree_model,
 112                                     GtkTreeIter  *iter);
 113 };
 114
 115
 116 /* GtkTreePath operations */
 117 GtkTreePath *gtk_tree_path_new              (void);
 118 GtkTreePath *gtk_tree_path_new_from_string  (gchar             *path);
 119 gchar       *gtk_tree_path_to_string        (GtkTreePath       *path);
 120 GtkTreePath *gtk_tree_path_new_root         (void);
 121 void         gtk_tree_path_append_index     (GtkTreePath       *path,
 122                                              gint               index);
 123 void         gtk_tree_path_prepend_index    (GtkTreePath       *path,
 124                                              gint               index);
 125 gint         gtk_tree_path_get_depth        (GtkTreePath       *path);
 126 gint        *gtk_tree_path_get_indices      (GtkTreePath       *path);
 127 void         gtk_tree_path_free             (GtkTreePath       *path);
 128 GtkTreePath *gtk_tree_path_copy             (GtkTreePath       *path);
 129 gint         gtk_tree_path_compare          (const GtkTreePath *a,
 130                                              const GtkTreePath *b);
 131 void         gtk_tree_path_next             (GtkTreePath       *path);
 132 gboolean     gtk_tree_path_prev             (GtkTreePath       *path);
 133 gboolean     gtk_tree_path_up               (GtkTreePath       *path);
 134 void         gtk_tree_path_down             (GtkTreePath       *path);
 135
 136 gboolean     gtk_tree_path_is_ancestor      (GtkTreePath       *path,
 137                                              GtkTreePath       *descendant);
 138 gboolean     gtk_tree_path_is_descendant    (GtkTreePath       *path,
 139                                              GtkTreePath       *ancestor);
 140
 141 /* Row reference (an object that tracks model changes so it refers to the same
 142  * row always; a path refers to a position, not a fixed row).  You almost always
 143  * want to call gtk_tree_row_reference_new.
 144  */
 145
 146 GtkTreeRowReference *gtk_tree_row_reference_new       (GtkTreeModel        *model,
 147                                                        GtkTreePath         *path);
 148 GtkTreeRowReference *gtk_tree_row_reference_new_proxy (GObject             *proxy,
 149                                                        GtkTreeModel        *model,
 150                                                        GtkTreePath         *path);
 151 GtkTreePath         *gtk_tree_row_reference_get_path  (GtkTreeRowReference *reference);
 152 void                 gtk_tree_row_reference_free      (GtkTreeRowReference *reference);
 153
 154 /* These two functions are only needed if you created the row reference with a
 155  * proxy object */
 156 void                 gtk_tree_row_reference_inserted  (GObject     *proxy,
 157                                                        GtkTreePath *path);
 158 void                 gtk_tree_row_reference_deleted   (GObject     *proxy,
 159                                                        GtkTreePath *path);
 160 void                 gtk_tree_row_reference_reordered (GObject     *proxy,
 161                                                        GtkTreePath *path,
 162                                                        GtkTreeIter *iter,
 163                                                        gint        *new_order);
 164
 165 /* GtkTreeIter operations */
 166 GtkTreeIter *     gtk_tree_iter_copy             (GtkTreeIter  *iter);
 167 void              gtk_tree_iter_free             (GtkTreeIter  *iter);
 168
 169 GtkType           gtk_tree_model_get_type        (void) G_GNUC_CONST;
 170 GtkTreeModelFlags gtk_tree_model_get_flags       (GtkTreeModel *tree_model);
 171 gint              gtk_tree_model_get_n_columns   (GtkTreeModel *tree_model);
 172 GType             gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
 173                                                   gint          index);
 174
 175
 176 /* Iterator movement */
 177 gboolean          gtk_tree_model_get_iter        (GtkTreeModel *tree_model,
 178                                                   GtkTreeIter  *iter,
 179                                                   GtkTreePath  *path);
 180 gboolean          gtk_tree_model_get_iter_root   (GtkTreeModel *tree_model,
 181                                                   GtkTreeIter  *iter);
 182 gboolean          gtk_tree_model_get_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 /* Signals */
 219 void gtk_tree_model_range_changed     (GtkTreeModel *tree_model,
 220                                        GtkTreePath  *start_path,
 221                                        GtkTreeIter  *start_iter,
 222                                        GtkTreePath  *end_path,
 223                                        GtkTreeIter  *end_iter);
 224 void gtk_tree_model_inserted          (GtkTreeModel *tree_model,
 225                                        GtkTreePath  *path,
 226                                        GtkTreeIter  *iter);
 227 void gtk_tree_model_has_child_toggled (GtkTreeModel *tree_model,
 228                                        GtkTreePath  *path,
 229                                        GtkTreeIter  *iter);
 230 void gtk_tree_model_deleted           (GtkTreeModel *tree_model,
 231                                        GtkTreePath  *path);
 232 void gtk_tree_model_reordered         (GtkTreeModel *tree_model,
 233                                        GtkTreePath  *path,
 234                                        GtkTreeIter  *iter,
 235                                        gint         *new_order);
 236
 237
 238
 239 #ifdef __cplusplus
 240 }
 241 #endif /* __cplusplus */
 242
 243
 244 #endif /* __GTK_TREE_MODEL_H__ */