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