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 #ifndef __GTK_TREE_STORE_H__
  21 #define __GTK_TREE_STORE_H__
  22
  23 #include <gtk/gtktreemodel.h>
  24 #include <gtk/gtktreesortable.h>
  25 #include <stdarg.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif /* __cplusplus */
  30
  31 #define GTK_TYPE_TREE_STORE                     (gtk_tree_store_get_type ())
  32 #define GTK_TREE_STORE(obj)                     (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_STORE, GtkTreeStore))
  33 #define GTK_TREE_STORE_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_STORE, GtkTreeStoreClass))
  34 #define GTK_IS_TREE_STORE(obj)                  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_STORE))
  35 #define GTK_IS_TREE_STORE_CLASS(klass)          (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_STORE))
  36 #define GTK_TREE_STORE_GET_CLASS(obj)           (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_STORE, GtkTreeStoreClass))
  37
  38 typedef struct _GtkTreeStore       GtkTreeStore;
  39 typedef struct _GtkTreeStoreClass  GtkTreeStoreClass;
  40
  41 struct _GtkTreeStore
  42 {
  43   GObject parent;
  44
  45   gint stamp;
  46   gpointer root;
  47   gpointer last;
  48   gint n_columns;
  49   gint sort_column_id;
  50   GList *sort_list;
  51   GtkSortType order;
  52   GType *column_headers;
  53   GtkTreeIterCompareFunc default_sort_func;
  54   gpointer default_sort_data;
  55   GtkDestroyNotify default_sort_destroy;
  56   guint columns_dirty : 1;
  57 };
  58
  59 struct _GtkTreeStoreClass
  60 {
  61   GObjectClass parent_class;
  62
  63   /* Padding for future expansion */
  64   void (*_gtk_reserved1) (void);
  65   void (*_gtk_reserved2) (void);
  66   void (*_gtk_reserved3) (void);
  67   void (*_gtk_reserved4) (void);
  68 };
  69
  70
  71 GType         gtk_tree_store_get_type         (void) G_GNUC_CONST;
  72 GtkTreeStore *gtk_tree_store_new              (gint          n_columns,
  73                                                ...);
  74 GtkTreeStore *gtk_tree_store_newv             (gint          n_columns,
  75                                                GType        *types);
  76 void          gtk_tree_store_set_column_types (GtkTreeStore *tree_store,
  77                                                gint          n_columns,
  78                                                GType        *types);
  79
  80 /* NOTE: use gtk_tree_model_get to get values from a GtkTreeStore */
  81
  82 void          gtk_tree_store_set_value        (GtkTreeStore *tree_store,
  83                                                GtkTreeIter  *iter,
  84                                                gint          column,
  85                                                GValue       *value);
  86 void          gtk_tree_store_set              (GtkTreeStore *tree_store,
  87                                                GtkTreeIter  *iter,
  88                                                ...);
  89 void          gtk_tree_store_set_valist       (GtkTreeStore *tree_store,
  90                                                GtkTreeIter  *iter,
  91                                                va_list       var_args);
  92 gboolean      gtk_tree_store_remove           (GtkTreeStore *tree_store,
  93                                                GtkTreeIter  *iter);
  94 void          gtk_tree_store_insert           (GtkTreeStore *tree_store,
  95                                                GtkTreeIter  *iter,
  96                                                GtkTreeIter  *parent,
  97                                                gint          position);
  98 void          gtk_tree_store_insert_before    (GtkTreeStore *tree_store,
  99                                                GtkTreeIter  *iter,
 100                                                GtkTreeIter  *parent,
 101                                                GtkTreeIter  *sibling);
 102 void          gtk_tree_store_insert_after     (GtkTreeStore *tree_store,
 103                                                GtkTreeIter  *iter,
 104                                                GtkTreeIter  *parent,
 105                                                GtkTreeIter  *sibling);
 106 void          gtk_tree_store_prepend          (GtkTreeStore *tree_store,
 107                                                GtkTreeIter  *iter,
 108                                                GtkTreeIter  *parent);
 109 void          gtk_tree_store_append           (GtkTreeStore *tree_store,
 110                                                GtkTreeIter  *iter,
 111                                                GtkTreeIter  *parent);
 112 gboolean      gtk_tree_store_is_ancestor      (GtkTreeStore *tree_store,
 113                                                GtkTreeIter  *iter,
 114                                                GtkTreeIter  *descendant);
 115 gint          gtk_tree_store_iter_depth       (GtkTreeStore *tree_store,
 116                                                GtkTreeIter  *iter);
 117 void          gtk_tree_store_clear            (GtkTreeStore *tree_store);
 118 gboolean      gtk_tree_store_iter_is_valid    (GtkTreeStore *tree_store,
 119                                                GtkTreeIter  *iter);
 120 void          gtk_tree_store_reorder          (GtkTreeStore *tree_store,
 121                                                GtkTreeIter  *parent,
 122                                                gint         *new_order);
 123 void          gtk_tree_store_swap             (GtkTreeStore *tree_store,
 124                                                GtkTreeIter  *a,
 125                                                GtkTreeIter  *b);
 126 void          gtk_tree_store_move_before      (GtkTreeStore *tree_store,
 127                                                GtkTreeIter  *iter,
 128                                                GtkTreeIter  *position);
 129 void          gtk_tree_store_move_after       (GtkTreeStore *tree_store,
 130                                                GtkTreeIter  *iter,
 131                                                GtkTreeIter  *position);
 132
 133
 134 #ifdef __cplusplus
 135 }
 136 #endif /* __cplusplus */
 137
 138
 139 #endif /* __GTK_TREE_STORE_H__ */