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 struct _GtkTreeIter
  41 {
  42   gint stamp;
  43   gpointer tree_node;
  44 };
  45
  46 struct _GtkTreeModelIface
  47 {
  48   GTypeInterface g_iface;
  49
  50   /* Signals */
  51   /* Currently unimplemented as interfaces do not support signals yet, so
  52    * objects implementing this interface need this.  Later, it will be moved
  53    * back here.
  54    */
  55   void         (* changed)           (GtkTreeModel *tree_model,
  56                                       GtkTreePath  *path,
  57                                       GtkTreeIter  *iter);
  58   void         (* inserted)          (GtkTreeModel *tree_model,
  59                                       GtkTreePath  *path,
  60                                       GtkTreeIter  *iter);
  61   void         (* child_toggled)     (GtkTreeModel *tree_model,
  62                                       GtkTreePath  *path,
  63                                       GtkTreeIter  *iter);
  64   void         (* deleted)           (GtkTreeModel *tree_model,
  65                                       GtkTreePath  *path);
  66
  67   /* VTable - not signals */
  68   gint         (* get_n_columns)   (GtkTreeModel *tree_model);
  69   GType        (* get_column_type) (GtkTreeModel *tree_model,
  70                                     gint          index);
  71   gboolean     (* get_iter)        (GtkTreeModel *tree_model,
  72                                     GtkTreeIter  *iter,
  73                                     GtkTreePath  *path);
  74   gboolean     (* iter_invalid)    (GtkTreeModel *tree_model,
  75                                     GtkTreeIter  *iter);
  76   GtkTreePath *(* get_path)        (GtkTreeModel *tree_model,
  77                                     GtkTreeIter  *iter);
  78   void         (* iter_get_value)  (GtkTreeModel *tree_model,
  79                                     GtkTreeIter  *iter,
  80                                     gint          column,
  81                                     GValue       *value);
  82   gboolean     (* iter_next)       (GtkTreeModel *tree_model,
  83                                     GtkTreeIter  *iter);
  84   gboolean     (* iter_children)   (GtkTreeModel *tree_model,
  85                                     GtkTreeIter  *iter,
  86                                     GtkTreeIter  *child);
  87   gboolean     (* iter_has_child)  (GtkTreeModel *tree_model,
  88                                     GtkTreeIter  *iter);
  89   gint         (* iter_n_children) (GtkTreeModel *tree_model,
  90                                     GtkTreeIter  *iter);
  91   gboolean     (* iter_nth_child)  (GtkTreeModel *tree_model,
  92                                     GtkTreeIter  *iter,
  93                                     GtkTreeIter  *parent,
  94                                     gint          n);
  95   gboolean     (* iter_parent)     (GtkTreeModel *tree_model,
  96                                     GtkTreeIter  *iter,
  97                                     GtkTreeIter  *parent);
  98 };
  99
 100
 101 /* Path operations */
 102 GtkTreePath *gtk_tree_path_new              (void);
 103 GtkTreePath *gtk_tree_path_new_from_string  (gchar             *path);
 104 gchar       *gtk_tree_path_to_string        (GtkTreePath       *path);
 105 GtkTreePath *gtk_tree_path_new_root         (void);
 106 void         gtk_tree_path_append_index     (GtkTreePath       *path,
 107                                              gint               index);
 108 void         gtk_tree_path_prepend_index    (GtkTreePath       *path,
 109                                              gint               index);
 110 gint         gtk_tree_path_get_depth        (GtkTreePath       *path);
 111 gint        *gtk_tree_path_get_indices      (GtkTreePath       *path);
 112 void         gtk_tree_path_free             (GtkTreePath       *path);
 113 GtkTreePath *gtk_tree_path_copy             (GtkTreePath       *path);
 114 gint         gtk_tree_path_compare          (const GtkTreePath *a,
 115                                              const GtkTreePath *b);
 116 void         gtk_tree_path_next             (GtkTreePath       *path);
 117 gint         gtk_tree_path_prev             (GtkTreePath       *path);
 118 gint         gtk_tree_path_up               (GtkTreePath       *path);
 119 void         gtk_tree_path_down             (GtkTreePath       *path);
 120
 121
 122 /* GtkTreeModel stuff */
 123 GtkType      gtk_tree_model_get_type        (void) G_GNUC_CONST;
 124
 125
 126 /* Column information */
 127 gint         gtk_tree_model_get_n_columns   (GtkTreeModel      *tree_model);
 128 GType        gtk_tree_model_get_column_type (GtkTreeModel      *tree_model,
 129                                              gint               index);
 130
 131
 132 /* Iterator movement */
 133 gboolean     gtk_tree_model_get_iter        (GtkTreeModel      *tree_model,
 134                                              GtkTreeIter       *iter,
 135                                              GtkTreePath       *path);
 136 gboolean     gtk_tree_model_iter_invalid    (GtkTreeModel      *tree_model,
 137                                              GtkTreeIter       *iter);
 138 GtkTreePath *gtk_tree_model_get_path        (GtkTreeModel      *tree_model,
 139                                              GtkTreeIter       *iter);
 140 void         gtk_tree_model_iter_get_value  (GtkTreeModel      *tree_model,
 141                                              GtkTreeIter       *iter,
 142                                              gint               column,
 143                                              GValue            *value);
 144 gboolean     gtk_tree_model_iter_next       (GtkTreeModel      *tree_model,
 145                                              GtkTreeIter       *iter);
 146 gboolean     gtk_tree_model_iter_children   (GtkTreeModel      *tree_model,
 147                                              GtkTreeIter       *iter,
 148                                              GtkTreeIter       *parent);
 149 gboolean     gtk_tree_model_iter_has_child  (GtkTreeModel      *tree_model,
 150                                              GtkTreeIter       *iter);
 151 gint         gtk_tree_model_iter_n_children (GtkTreeModel      *tree_model,
 152                                              GtkTreeIter       *iter);
 153 gboolean     gtk_tree_model_iter_nth_child  (GtkTreeModel      *tree_model,
 154                                              GtkTreeIter       *iter,
 155                                              GtkTreeIter       *parent,
 156                                              gint               n);
 157 gboolean     gtk_tree_model_iter_parent     (GtkTreeModel      *tree_model,
 158                                              GtkTreeIter       *iter,
 159                                              GtkTreeIter       *child);
 160
 161
 162 #ifdef __cplusplus
 163 }
 164 #endif /* __cplusplus */
 165
 166
 167 #endif /* __GTK_TREE_MODEL_H__ */