Pileus Git - ~andy/gtk/blob - gtk/gtktreestore.h

   1 /* gtktreestore.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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #ifndef __GTK_TREE_STORE_H__
  19 #define __GTK_TREE_STORE_H__
  20
  21 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  22 #error "Only <gtk/gtk.h> can be included directly."
  23 #endif
  24
  25 #include <gdk/gdk.h>
  26 #include <gtk/gtktreemodel.h>
  27 #include <gtk/gtktreesortable.h>
  28 #include <stdarg.h>
  29
  30
  31 G_BEGIN_DECLS
  32
  33
  34 #define GTK_TYPE_TREE_STORE                     (gtk_tree_store_get_type ())
  35 #define GTK_TREE_STORE(obj)                     (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_STORE, GtkTreeStore))
  36 #define GTK_TREE_STORE_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_STORE, GtkTreeStoreClass))
  37 #define GTK_IS_TREE_STORE(obj)                  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_STORE))
  38 #define GTK_IS_TREE_STORE_CLASS(klass)          (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_STORE))
  39 #define GTK_TREE_STORE_GET_CLASS(obj)           (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_STORE, GtkTreeStoreClass))
  40
  41 typedef struct _GtkTreeStore        GtkTreeStore;
  42 typedef struct _GtkTreeStoreClass   GtkTreeStoreClass;
  43 typedef struct _GtkTreeStorePrivate GtkTreeStorePrivate;
  44
  45 struct _GtkTreeStore
  46 {
  47   GObject parent;
  48
  49   GtkTreeStorePrivate *priv;
  50 };
  51
  52 struct _GtkTreeStoreClass
  53 {
  54   GObjectClass parent_class;
  55
  56   /* Padding for future expansion */
  57   void (*_gtk_reserved1) (void);
  58   void (*_gtk_reserved2) (void);
  59   void (*_gtk_reserved3) (void);
  60   void (*_gtk_reserved4) (void);
  61 };
  62
  63
  64 GType         gtk_tree_store_get_type         (void) G_GNUC_CONST;
  65 GtkTreeStore *gtk_tree_store_new              (gint          n_columns,
  66                                                ...);
  67 GtkTreeStore *gtk_tree_store_newv             (gint          n_columns,
  68                                                GType        *types);
  69 void          gtk_tree_store_set_column_types (GtkTreeStore *tree_store,
  70                                                gint          n_columns,
  71                                                GType        *types);
  72
  73 /* NOTE: use gtk_tree_model_get to get values from a GtkTreeStore */
  74
  75 void          gtk_tree_store_set_value        (GtkTreeStore *tree_store,
  76                                                GtkTreeIter  *iter,
  77                                                gint          column,
  78                                                GValue       *value);
  79 void          gtk_tree_store_set              (GtkTreeStore *tree_store,
  80                                                GtkTreeIter  *iter,
  81                                                ...);
  82 void          gtk_tree_store_set_valuesv      (GtkTreeStore *tree_store,
  83                                                GtkTreeIter  *iter,
  84                                                gint         *columns,
  85                                                GValue       *values,
  86                                                gint          n_values);
  87 void          gtk_tree_store_set_valist       (GtkTreeStore *tree_store,
  88                                                GtkTreeIter  *iter,
  89                                                va_list       var_args);
  90 gboolean      gtk_tree_store_remove           (GtkTreeStore *tree_store,
  91                                                GtkTreeIter  *iter);
  92 void          gtk_tree_store_insert           (GtkTreeStore *tree_store,
  93                                                GtkTreeIter  *iter,
  94                                                GtkTreeIter  *parent,
  95                                                gint          position);
  96 void          gtk_tree_store_insert_before    (GtkTreeStore *tree_store,
  97                                                GtkTreeIter  *iter,
  98                                                GtkTreeIter  *parent,
  99                                                GtkTreeIter  *sibling);
 100 void          gtk_tree_store_insert_after     (GtkTreeStore *tree_store,
 101                                                GtkTreeIter  *iter,
 102                                                GtkTreeIter  *parent,
 103                                                GtkTreeIter  *sibling);
 104 void          gtk_tree_store_insert_with_values (GtkTreeStore *tree_store,
 105                                                  GtkTreeIter  *iter,
 106                                                  GtkTreeIter  *parent,
 107                                                  gint          position,
 108                                                  ...);
 109 void          gtk_tree_store_insert_with_valuesv (GtkTreeStore *tree_store,
 110                                                   GtkTreeIter  *iter,
 111                                                   GtkTreeIter  *parent,
 112                                                   gint          position,
 113                                                   gint         *columns,
 114                                                   GValue       *values,
 115                                                   gint          n_values);
 116 void          gtk_tree_store_prepend          (GtkTreeStore *tree_store,
 117                                                GtkTreeIter  *iter,
 118                                                GtkTreeIter  *parent);
 119 void          gtk_tree_store_append           (GtkTreeStore *tree_store,
 120                                                GtkTreeIter  *iter,
 121                                                GtkTreeIter  *parent);
 122 gboolean      gtk_tree_store_is_ancestor      (GtkTreeStore *tree_store,
 123                                                GtkTreeIter  *iter,
 124                                                GtkTreeIter  *descendant);
 125 gint          gtk_tree_store_iter_depth       (GtkTreeStore *tree_store,
 126                                                GtkTreeIter  *iter);
 127 void          gtk_tree_store_clear            (GtkTreeStore *tree_store);
 128 gboolean      gtk_tree_store_iter_is_valid    (GtkTreeStore *tree_store,
 129                                                GtkTreeIter  *iter);
 130 void          gtk_tree_store_reorder          (GtkTreeStore *tree_store,
 131                                                GtkTreeIter  *parent,
 132                                                gint         *new_order);
 133 void          gtk_tree_store_swap             (GtkTreeStore *tree_store,
 134                                                GtkTreeIter  *a,
 135                                                GtkTreeIter  *b);
 136 void          gtk_tree_store_move_before      (GtkTreeStore *tree_store,
 137                                                GtkTreeIter  *iter,
 138                                                GtkTreeIter  *position);
 139 void          gtk_tree_store_move_after       (GtkTreeStore *tree_store,
 140                                                GtkTreeIter  *iter,
 141                                                GtkTreeIter  *position);
 142
 143
 144 G_END_DECLS
 145
 146
 147 #endif /* __GTK_TREE_STORE_H__ */