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
  35 typedef struct _GtkTreeIter         GtkTreeIter;
  36 typedef struct _GtkTreePath         GtkTreePath;
  37 typedef struct _GtkTreeRowReference GtkTreeRowReference;
  38 typedef struct _GtkTreeModel        GtkTreeModel; /* Dummy typedef */
  39 typedef struct _GtkTreeModelIface   GtkTreeModelIface;
  40
  41
  42 typedef enum
  43 {
  44   GTK_TREE_MODEL_ITERS_PERSIST = 1 << 0
  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   /* Currently unimplemented as interfaces do not support signals yet, so
  61    * objects implementing this interface need this.  Later, it will be moved
  62    * back here.
  63    */
  64   void         (* changed)           (GtkTreeModel *tree_model,
  65                                       GtkTreePath  *path,
  66                                       GtkTreeIter  *iter);
  67   void         (* inserted)          (GtkTreeModel *tree_model,
  68                                       GtkTreePath  *path,
  69                                       GtkTreeIter  *iter);
  70   void         (* child_toggled)     (GtkTreeModel *tree_model,
  71                                       GtkTreePath  *path,
  72                                       GtkTreeIter  *iter);
  73   void         (* deleted)           (GtkTreeModel *tree_model,
  74                                       GtkTreePath  *path);
  75   void         (* reordered)         (GtkTreeModel *tree_model,
  76                                       GtkTreePath  *path,
  77                                       gint         *new_order);
  78
  79   /* VTable - not signals */
  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_iter)        (GtkTreeModel *tree_model,
 111                                     GtkTreeIter  *iter);
 112   void         (* unref_iter)      (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 /* Row reference (an object that tracks model changes so it refers to the
 138  * same row always; a path refers to a position, not a fixed row)
 139  */
 140
 141 GtkTreeRowReference *gtk_tree_row_reference_new      (GtkTreeModel        *model,
 142                                                       GtkTreePath         *path);
 143 /* returns NULL if the row was deleted or the model was destroyed. */
 144 GtkTreePath         *gtk_tree_row_reference_get_path (GtkTreeRowReference *reference);
 145 void                 gtk_tree_row_reference_free     (GtkTreeRowReference *reference);
 146
 147
 148 /* GtkTreeIter operations */
 149 GtkTreeIter *gtk_tree_iter_copy             (GtkTreeIter       *iter);
 150 void         gtk_tree_iter_free             (GtkTreeIter       *iter);
 151
 152 /* GtkTreeModel stuff */
 153 GtkType           gtk_tree_model_get_type   (void) G_GNUC_CONST;
 154 GtkTreeModelFlags gtk_tree_model_get_flags  (GtkTreeModel      *tree_model);
 155
 156 /* Column information */
 157 gint         gtk_tree_model_get_n_columns   (GtkTreeModel      *tree_model);
 158 GType        gtk_tree_model_get_column_type (GtkTreeModel      *tree_model,
 159                                              gint               index);
 160
 161
 162 /* Iterator movement */
 163 gboolean     gtk_tree_model_get_iter        (GtkTreeModel      *tree_model,
 164                                              GtkTreeIter       *iter,
 165                                              GtkTreePath       *path);
 166 gboolean     gtk_tree_model_get_first       (GtkTreeModel      *tree_model,
 167                                              GtkTreeIter       *iter);
 168 GtkTreePath *gtk_tree_model_get_path        (GtkTreeModel      *tree_model,
 169                                              GtkTreeIter       *iter);
 170 void         gtk_tree_model_get_value       (GtkTreeModel      *tree_model,
 171                                              GtkTreeIter       *iter,
 172                                              gint               column,
 173                                              GValue            *value);
 174 gboolean     gtk_tree_model_iter_next       (GtkTreeModel      *tree_model,
 175                                              GtkTreeIter       *iter);
 176 gboolean     gtk_tree_model_iter_children   (GtkTreeModel      *tree_model,
 177                                              GtkTreeIter       *iter,
 178                                              GtkTreeIter       *parent);
 179 gboolean     gtk_tree_model_iter_has_child  (GtkTreeModel      *tree_model,
 180                                              GtkTreeIter       *iter);
 181 gint         gtk_tree_model_iter_n_children (GtkTreeModel      *tree_model,
 182                                              GtkTreeIter       *iter);
 183 gboolean     gtk_tree_model_iter_nth_child  (GtkTreeModel      *tree_model,
 184                                              GtkTreeIter       *iter,
 185                                              GtkTreeIter       *parent,
 186                                              gint               n);
 187 gboolean     gtk_tree_model_iter_parent     (GtkTreeModel      *tree_model,
 188                                              GtkTreeIter       *iter,
 189                                              GtkTreeIter       *child);
 190 void         gtk_tree_model_ref_iter        (GtkTreeModel      *tree_model,
 191                                              GtkTreeIter       *iter);
 192 void         gtk_tree_model_unref_iter      (GtkTreeModel      *tree_model,
 193                                              GtkTreeIter       *iter);
 194
 195 #ifdef __cplusplus
 196 }
 197 #endif /* __cplusplus */
 198
 199
 200 #endif /* __GTK_TREE_MODEL_H__ */