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