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

   1 /* gtkliststore.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_LIST_STORE_H__
  25 #define __GTK_LIST_STORE_H__
  26
  27 #include <gtk/gtktreemodel.h>
  28 #include <gtk/gtktreesortable.h>
  29
  30
  31 G_BEGIN_DECLS
  32
  33
  34 #define GTK_TYPE_LIST_STORE            (gtk_list_store_get_type ())
  35 #define GTK_LIST_STORE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_LIST_STORE, GtkListStore))
  36 #define GTK_LIST_STORE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_LIST_STORE, GtkListStoreClass))
  37 #define GTK_IS_LIST_STORE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_LIST_STORE))
  38 #define GTK_IS_LIST_STORE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_LIST_STORE))
  39 #define GTK_LIST_STORE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_LIST_STORE, GtkListStoreClass))
  40
  41 typedef struct _GtkListStore       GtkListStore;
  42 typedef struct _GtkListStoreClass  GtkListStoreClass;
  43
  44 struct _GtkListStore
  45 {
  46   GObject parent;
  47
  48   /*< private >*/
  49   gint stamp;
  50   gpointer seq;         /* head of the list */
  51   gpointer _gtk_reserved1;
  52   GList *sort_list;
  53   gint n_columns;
  54   gint sort_column_id;
  55   GtkSortType order;
  56   GType *column_headers;
  57   gint length;
  58   GtkTreeIterCompareFunc default_sort_func;
  59   gpointer default_sort_data;
  60   GDestroyNotify default_sort_destroy;
  61   guint columns_dirty : 1;
  62 };
  63
  64 struct _GtkListStoreClass
  65 {
  66   GObjectClass parent_class;
  67
  68   /* Padding for future expansion */
  69   void (*_gtk_reserved1) (void);
  70   void (*_gtk_reserved2) (void);
  71   void (*_gtk_reserved3) (void);
  72   void (*_gtk_reserved4) (void);
  73 };
  74
  75
  76 GType         gtk_list_store_get_type         (void) G_GNUC_CONST;
  77 GtkListStore *gtk_list_store_new              (gint          n_columns,
  78                                                ...);
  79 GtkListStore *gtk_list_store_newv             (gint          n_columns,
  80                                                GType        *types);
  81 void          gtk_list_store_set_column_types (GtkListStore *list_store,
  82                                                gint          n_columns,
  83                                                GType        *types);
  84
  85 /* NOTE: use gtk_tree_model_get to get values from a GtkListStore */
  86
  87 void          gtk_list_store_set_value        (GtkListStore *list_store,
  88                                                GtkTreeIter  *iter,
  89                                                gint          column,
  90                                                GValue       *value);
  91 void          gtk_list_store_set              (GtkListStore *list_store,
  92                                                GtkTreeIter  *iter,
  93                                                ...);
  94 void          gtk_list_store_set_valuesv      (GtkListStore *list_store,
  95                                                GtkTreeIter  *iter,
  96                                                gint         *columns,
  97                                                GValue       *values,
  98                                                gint          n_values);
  99 void          gtk_list_store_set_valist       (GtkListStore *list_store,
 100                                                GtkTreeIter  *iter,
 101                                                va_list       var_args);
 102 gboolean      gtk_list_store_remove           (GtkListStore *list_store,
 103                                                GtkTreeIter  *iter);
 104 void          gtk_list_store_insert           (GtkListStore *list_store,
 105                                                GtkTreeIter  *iter,
 106                                                gint          position);
 107 void          gtk_list_store_insert_before    (GtkListStore *list_store,
 108                                                GtkTreeIter  *iter,
 109                                                GtkTreeIter  *sibling);
 110 void          gtk_list_store_insert_after     (GtkListStore *list_store,
 111                                                GtkTreeIter  *iter,
 112                                                GtkTreeIter  *sibling);
 113 void          gtk_list_store_insert_with_values  (GtkListStore *list_store,
 114                                                   GtkTreeIter  *iter,
 115                                                   gint          position,
 116                                                   ...);
 117 void          gtk_list_store_insert_with_valuesv (GtkListStore *list_store,
 118                                                   GtkTreeIter  *iter,
 119                                                   gint          position,
 120                                                   gint         *columns,
 121                                                   GValue       *values,
 122                                                   gint          n_values);
 123 void          gtk_list_store_prepend          (GtkListStore *list_store,
 124                                                GtkTreeIter  *iter);
 125 void          gtk_list_store_append           (GtkListStore *list_store,
 126                                                GtkTreeIter  *iter);
 127 void          gtk_list_store_clear            (GtkListStore *list_store);
 128 gboolean      gtk_list_store_iter_is_valid    (GtkListStore *list_store,
 129                                                GtkTreeIter  *iter);
 130 void          gtk_list_store_reorder          (GtkListStore *store,
 131                                                gint         *new_order);
 132 void          gtk_list_store_swap             (GtkListStore *store,
 133                                                GtkTreeIter  *a,
 134                                                GtkTreeIter  *b);
 135 void          gtk_list_store_move_after       (GtkListStore *store,
 136                                                GtkTreeIter  *iter,
 137                                                GtkTreeIter  *position);
 138 void          gtk_list_store_move_before      (GtkListStore *store,
 139                                                GtkTreeIter  *iter,
 140                                                GtkTreeIter  *position);
 141
 142
 143 G_END_DECLS
 144
 145
 146 #endif /* __GTK_LIST_STORE_H__ */