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