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, see <http://www.gnu.org/licenses/>.
16 */
17
18#ifndef __GTK_LIST_STORE_H__
19#define __GTK_LIST_STORE_H__
20
21#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
22#error "Only <gtk/gtk.h> can be included directly."
23#endif
24
25#include <gdk/gdk.h>
26#include <gtk/gtktreemodel.h>
27#include <gtk/gtktreesortable.h>
28
29
30G_BEGIN_DECLS
31
32
33#define GTK_TYPE_LIST_STORE (gtk_list_store_get_type ())
34#define GTK_LIST_STORE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_LIST_STORE, GtkListStore))
35#define GTK_LIST_STORE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_LIST_STORE, GtkListStoreClass))
36#define GTK_IS_LIST_STORE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_LIST_STORE))
37#define GTK_IS_LIST_STORE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_LIST_STORE))
38#define GTK_LIST_STORE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_LIST_STORE, GtkListStoreClass))
39
40typedef struct _GtkListStore GtkListStore;
41typedef struct _GtkListStorePrivate GtkListStorePrivate;
42typedef struct _GtkListStoreClass GtkListStoreClass;
43
44struct _GtkListStore
45{
46 GObject parent;
47
48 /*< private >*/
49 GtkListStorePrivate *priv;
50};
51
52struct _GtkListStoreClass
53{
54 GObjectClass parent_class;
55
56 /*< private >*/
57 gpointer padding[8];
58};
59
60
61GDK_AVAILABLE_IN_ALL
62GType gtk_list_store_get_type (void) G_GNUC_CONST;
63GDK_AVAILABLE_IN_ALL
64GtkListStore *gtk_list_store_new (int n_columns,
65 ...);
66GDK_AVAILABLE_IN_ALL
67GtkListStore *gtk_list_store_newv (int n_columns,
68 GType *types);
69GDK_AVAILABLE_IN_ALL
70void gtk_list_store_set_column_types (GtkListStore *list_store,
71 int n_columns,
72 GType *types);
73
74/* NOTE: use gtk_tree_model_get to get values from a GtkListStore */
75
76GDK_AVAILABLE_IN_ALL
77void gtk_list_store_set_value (GtkListStore *list_store,
78 GtkTreeIter *iter,
79 int column,
80 GValue *value);
81GDK_AVAILABLE_IN_ALL
82void gtk_list_store_set (GtkListStore *list_store,
83 GtkTreeIter *iter,
84 ...);
85GDK_AVAILABLE_IN_ALL
86void gtk_list_store_set_valuesv (GtkListStore *list_store,
87 GtkTreeIter *iter,
88 int *columns,
89 GValue *values,
90 int n_values);
91GDK_AVAILABLE_IN_ALL
92void gtk_list_store_set_valist (GtkListStore *list_store,
93 GtkTreeIter *iter,
94 va_list var_args);
95GDK_AVAILABLE_IN_ALL
96gboolean gtk_list_store_remove (GtkListStore *list_store,
97 GtkTreeIter *iter);
98GDK_AVAILABLE_IN_ALL
99void gtk_list_store_insert (GtkListStore *list_store,
100 GtkTreeIter *iter,
101 int position);
102GDK_AVAILABLE_IN_ALL
103void gtk_list_store_insert_before (GtkListStore *list_store,
104 GtkTreeIter *iter,
105 GtkTreeIter *sibling);
106GDK_AVAILABLE_IN_ALL
107void gtk_list_store_insert_after (GtkListStore *list_store,
108 GtkTreeIter *iter,
109 GtkTreeIter *sibling);
110GDK_AVAILABLE_IN_ALL
111void gtk_list_store_insert_with_values (GtkListStore *list_store,
112 GtkTreeIter *iter,
113 int position,
114 ...);
115GDK_AVAILABLE_IN_ALL
116void gtk_list_store_insert_with_valuesv (GtkListStore *list_store,
117 GtkTreeIter *iter,
118 int position,
119 int *columns,
120 GValue *values,
121 int n_values);
122GDK_AVAILABLE_IN_ALL
123void gtk_list_store_prepend (GtkListStore *list_store,
124 GtkTreeIter *iter);
125GDK_AVAILABLE_IN_ALL
126void gtk_list_store_append (GtkListStore *list_store,
127 GtkTreeIter *iter);
128GDK_AVAILABLE_IN_ALL
129void gtk_list_store_clear (GtkListStore *list_store);
130GDK_AVAILABLE_IN_ALL
131gboolean gtk_list_store_iter_is_valid (GtkListStore *list_store,
132 GtkTreeIter *iter);
133GDK_AVAILABLE_IN_ALL
134void gtk_list_store_reorder (GtkListStore *store,
135 int *new_order);
136GDK_AVAILABLE_IN_ALL
137void gtk_list_store_swap (GtkListStore *store,
138 GtkTreeIter *a,
139 GtkTreeIter *b);
140GDK_AVAILABLE_IN_ALL
141void gtk_list_store_move_after (GtkListStore *store,
142 GtkTreeIter *iter,
143 GtkTreeIter *position);
144GDK_AVAILABLE_IN_ALL
145void gtk_list_store_move_before (GtkListStore *store,
146 GtkTreeIter *iter,
147 GtkTreeIter *position);
148
149
150G_END_DECLS
151
152
153#endif /* __GTK_LIST_STORE_H__ */
154

source code of gtk/gtk/gtkliststore.h