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 _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 tree_node;
  50   gpointer tree_node2;
  51   gpointer tree_node3;
  52 };
  53
  54 struct _GtkTreeModelIface
  55 {
  56   GTypeInterface g_iface;
  57
  58   /* Signals */
  59   /* Currently unimplemented as interfaces do not support signals yet, so
  60    * objects implementing this interface need this.  Later, it will be moved
  61    * back here.
  62    */
  63   void         (* changed)           (GtkTreeModel *tree_model,
  64                                       GtkTreePath  *path,
  65                                       GtkTreeIter  *iter);
  66   void         (* inserted)          (GtkTreeModel *tree_model,
  67                                       GtkTreePath  *path,
  68                                       GtkTreeIter  *iter);
  69   void         (* 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                                       gint         *new_order);
  77
  78   /* VTable - not signals */
  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_iter)        (GtkTreeModel *tree_model,
 110                                     GtkTreeIter  *iter);
 111   void         (* unref_iter)      (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
 137 /* GtkTreeIter operations */
 138 GtkTreeIter *gtk_tree_iter_copy             (GtkTreeIter       *iter);
 139 void         gtk_tree_iter_free             (GtkTreeIter       *iter);
 140
 141 /* GtkTreeModel stuff */
 142 GtkType           gtk_tree_model_get_type   (void) G_GNUC_CONST;
 143 GtkTreeModelFlags gtk_tree_model_get_flags  (GtkTreeModel      *tree_model);
 144
 145 /* Column information */
 146 gint         gtk_tree_model_get_n_columns   (GtkTreeModel      *tree_model);
 147 GType        gtk_tree_model_get_column_type (GtkTreeModel      *tree_model,
 148                                              gint               index);
 149
 150
 151 /* Iterator movement */
 152 gboolean     gtk_tree_model_get_iter        (GtkTreeModel      *tree_model,
 153                                              GtkTreeIter       *iter,
 154                                              GtkTreePath       *path);
 155 GtkTreePath *gtk_tree_model_get_path        (GtkTreeModel      *tree_model,
 156                                              GtkTreeIter       *iter);
 157 void         gtk_tree_model_get_value       (GtkTreeModel      *tree_model,
 158                                              GtkTreeIter       *iter,
 159                                              gint               column,
 160                                              GValue            *value);
 161 gboolean     gtk_tree_model_iter_next       (GtkTreeModel      *tree_model,
 162                                              GtkTreeIter       *iter);
 163 gboolean     gtk_tree_model_iter_children   (GtkTreeModel      *tree_model,
 164                                              GtkTreeIter       *iter,
 165                                              GtkTreeIter       *parent);
 166 gboolean     gtk_tree_model_iter_has_child  (GtkTreeModel      *tree_model,
 167                                              GtkTreeIter       *iter);
 168 gint         gtk_tree_model_iter_n_children (GtkTreeModel      *tree_model,
 169                                              GtkTreeIter       *iter);
 170 gboolean     gtk_tree_model_iter_nth_child  (GtkTreeModel      *tree_model,
 171                                              GtkTreeIter       *iter,
 172                                              GtkTreeIter       *parent,
 173                                              gint               n);
 174 gboolean     gtk_tree_model_iter_parent     (GtkTreeModel      *tree_model,
 175                                              GtkTreeIter       *iter,
 176                                              GtkTreeIter       *child);
 177 void         gtk_tree_model_ref_iter        (GtkTreeModel      *tree_model,
 178                                              GtkTreeIter       *iter);
 179 void         gtk_tree_model_unref_iter      (GtkTreeModel      *tree_model,
 180                                              GtkTreeIter       *iter);
 181
 182 #ifdef __cplusplus
 183 }
 184 #endif /* __cplusplus */
 185
 186
 187 #endif /* __GTK_TREE_MODEL_H__ */