]> Pileus Git - ~andy/gtk/blob - gtk/gtkliststore.h
Write documentation Write documentation
[~andy/gtk] / 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 #ifndef __GTK_LIST_STORE_H__
21 #define __GTK_LIST_STORE_H__
22
23 #include <gtk/gtktreemodel.h>
24 #include <gtk/gtktreesortable.h>
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif /* __cplusplus */
29
30 #define GTK_TYPE_LIST_STORE            (gtk_list_store_get_type ())
31 #define GTK_LIST_STORE(obj)            (GTK_CHECK_CAST ((obj), GTK_TYPE_LIST_STORE, GtkListStore))
32 #define GTK_LIST_STORE_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_LIST_STORE, GtkListStoreClass))
33 #define GTK_IS_LIST_STORE(obj)         (GTK_CHECK_TYPE ((obj), GTK_TYPE_LIST_STORE))
34 #define GTK_IS_LIST_STORE_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), GTK_TYPE_LIST_STORE))
35 #define GTK_LIST_STORE_GET_CLASS(obj)  (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_LIST_STORE, GtkListStoreClass))
36
37 typedef struct _GtkListStore       GtkListStore;
38 typedef struct _GtkListStoreClass  GtkListStoreClass;
39
40 struct _GtkListStore
41 {
42   GObject parent;
43
44   /*< private >*/
45   gint stamp;
46   gpointer root;
47   gpointer tail;
48   GList *sort_list;
49   gint n_columns;
50   gint sort_column_id;
51   GtkSortType order;
52   GType *column_headers;
53   gint length;
54   GtkTreeIterCompareFunc default_sort_func;
55   gpointer default_sort_data;
56   GtkDestroyNotify default_sort_destroy;
57 };
58
59 struct _GtkListStoreClass
60 {
61   GObjectClass parent_class;
62 };
63
64
65 GtkType       gtk_list_store_get_type        (void);
66 GtkListStore *gtk_list_store_new             (gint          n_columns,
67                                               ...);
68 GtkListStore *gtk_list_store_newv            (gint          n_columns,
69                                               GType        *types);
70 void          gtk_list_store_set_value       (GtkListStore *list_store,
71                                               GtkTreeIter  *iter,
72                                               gint          column,
73                                               GValue       *value);
74 void          gtk_list_store_set             (GtkListStore *list_store,
75                                               GtkTreeIter  *iter,
76                                               ...);
77 void          gtk_list_store_set_valist      (GtkListStore *list_store,
78                                               GtkTreeIter  *iter,
79                                               va_list       var_args);
80 void          gtk_list_store_remove          (GtkListStore *list_store,
81                                               GtkTreeIter  *iter);
82 void          gtk_list_store_insert          (GtkListStore *list_store,
83                                               GtkTreeIter  *iter,
84                                               gint          position);
85 void          gtk_list_store_insert_before   (GtkListStore *list_store,
86                                               GtkTreeIter  *iter,
87                                               GtkTreeIter  *sibling);
88 void          gtk_list_store_insert_after    (GtkListStore *list_store,
89                                               GtkTreeIter  *iter,
90                                               GtkTreeIter  *sibling);
91 void          gtk_list_store_prepend         (GtkListStore *list_store,
92                                               GtkTreeIter  *iter);
93 void          gtk_list_store_append          (GtkListStore *list_store,
94                                               GtkTreeIter  *iter);
95 void          gtk_list_store_clear           (GtkListStore *list_store);
96
97
98 #ifdef __cplusplus
99 }
100 #endif /* __cplusplus */
101
102
103 #endif /* __GTK_LIST_STORE_H__ */