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, see <http://www.gnu.org/licenses/>.
16 */
17
18#ifndef __GTK_TREE_STORE_H__
19#define __GTK_TREE_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#include <stdarg.h>
29
30
31G_BEGIN_DECLS
32
33
34#define GTK_TYPE_TREE_STORE (gtk_tree_store_get_type ())
35#define GTK_TREE_STORE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_STORE, GtkTreeStore))
36#define GTK_TREE_STORE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_STORE, GtkTreeStoreClass))
37#define GTK_IS_TREE_STORE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_STORE))
38#define GTK_IS_TREE_STORE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_STORE))
39#define GTK_TREE_STORE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_STORE, GtkTreeStoreClass))
40
41typedef struct _GtkTreeStore GtkTreeStore;
42typedef struct _GtkTreeStoreClass GtkTreeStoreClass;
43typedef struct _GtkTreeStorePrivate GtkTreeStorePrivate;
44
45struct _GtkTreeStore
46{
47 GObject parent;
48
49 GtkTreeStorePrivate *priv;
50};
51
52struct _GtkTreeStoreClass
53{
54 GObjectClass parent_class;
55
56 /*< private >*/
57 gpointer padding[8];
58};
59
60
61GDK_AVAILABLE_IN_ALL
62GType gtk_tree_store_get_type (void) G_GNUC_CONST;
63GDK_AVAILABLE_IN_ALL
64GtkTreeStore *gtk_tree_store_new (int n_columns,
65 ...);
66GDK_AVAILABLE_IN_ALL
67GtkTreeStore *gtk_tree_store_newv (int n_columns,
68 GType *types);
69GDK_AVAILABLE_IN_ALL
70void gtk_tree_store_set_column_types (GtkTreeStore *tree_store,
71 int n_columns,
72 GType *types);
73
74/* NOTE: use gtk_tree_model_get to get values from a GtkTreeStore */
75
76GDK_AVAILABLE_IN_ALL
77void gtk_tree_store_set_value (GtkTreeStore *tree_store,
78 GtkTreeIter *iter,
79 int column,
80 GValue *value);
81GDK_AVAILABLE_IN_ALL
82void gtk_tree_store_set (GtkTreeStore *tree_store,
83 GtkTreeIter *iter,
84 ...);
85GDK_AVAILABLE_IN_ALL
86void gtk_tree_store_set_valuesv (GtkTreeStore *tree_store,
87 GtkTreeIter *iter,
88 int *columns,
89 GValue *values,
90 int n_values);
91GDK_AVAILABLE_IN_ALL
92void gtk_tree_store_set_valist (GtkTreeStore *tree_store,
93 GtkTreeIter *iter,
94 va_list var_args);
95GDK_AVAILABLE_IN_ALL
96gboolean gtk_tree_store_remove (GtkTreeStore *tree_store,
97 GtkTreeIter *iter);
98GDK_AVAILABLE_IN_ALL
99void gtk_tree_store_insert (GtkTreeStore *tree_store,
100 GtkTreeIter *iter,
101 GtkTreeIter *parent,
102 int position);
103GDK_AVAILABLE_IN_ALL
104void gtk_tree_store_insert_before (GtkTreeStore *tree_store,
105 GtkTreeIter *iter,
106 GtkTreeIter *parent,
107 GtkTreeIter *sibling);
108GDK_AVAILABLE_IN_ALL
109void gtk_tree_store_insert_after (GtkTreeStore *tree_store,
110 GtkTreeIter *iter,
111 GtkTreeIter *parent,
112 GtkTreeIter *sibling);
113GDK_AVAILABLE_IN_ALL
114void gtk_tree_store_insert_with_values (GtkTreeStore *tree_store,
115 GtkTreeIter *iter,
116 GtkTreeIter *parent,
117 int position,
118 ...);
119GDK_AVAILABLE_IN_ALL
120void gtk_tree_store_insert_with_valuesv (GtkTreeStore *tree_store,
121 GtkTreeIter *iter,
122 GtkTreeIter *parent,
123 int position,
124 int *columns,
125 GValue *values,
126 int n_values);
127GDK_AVAILABLE_IN_ALL
128void gtk_tree_store_prepend (GtkTreeStore *tree_store,
129 GtkTreeIter *iter,
130 GtkTreeIter *parent);
131GDK_AVAILABLE_IN_ALL
132void gtk_tree_store_append (GtkTreeStore *tree_store,
133 GtkTreeIter *iter,
134 GtkTreeIter *parent);
135GDK_AVAILABLE_IN_ALL
136gboolean gtk_tree_store_is_ancestor (GtkTreeStore *tree_store,
137 GtkTreeIter *iter,
138 GtkTreeIter *descendant);
139GDK_AVAILABLE_IN_ALL
140int gtk_tree_store_iter_depth (GtkTreeStore *tree_store,
141 GtkTreeIter *iter);
142GDK_AVAILABLE_IN_ALL
143void gtk_tree_store_clear (GtkTreeStore *tree_store);
144GDK_AVAILABLE_IN_ALL
145gboolean gtk_tree_store_iter_is_valid (GtkTreeStore *tree_store,
146 GtkTreeIter *iter);
147GDK_AVAILABLE_IN_ALL
148void gtk_tree_store_reorder (GtkTreeStore *tree_store,
149 GtkTreeIter *parent,
150 int *new_order);
151GDK_AVAILABLE_IN_ALL
152void gtk_tree_store_swap (GtkTreeStore *tree_store,
153 GtkTreeIter *a,
154 GtkTreeIter *b);
155GDK_AVAILABLE_IN_ALL
156void gtk_tree_store_move_before (GtkTreeStore *tree_store,
157 GtkTreeIter *iter,
158 GtkTreeIter *position);
159GDK_AVAILABLE_IN_ALL
160void gtk_tree_store_move_after (GtkTreeStore *tree_store,
161 GtkTreeIter *iter,
162 GtkTreeIter *position);
163
164
165G_END_DECLS
166
167
168#endif /* __GTK_TREE_STORE_H__ */
169

source code of gtk/gtk/gtktreestore.h