gtktreestore.h 6.22 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/* gtktreestore.h
 * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

20 21 22 23
#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

24 25 26
#ifndef __GTK_TREE_STORE_H__
#define __GTK_TREE_STORE_H__

27
#include <gdkconfig.h>
28
#include <gtk/gtktreemodel.h>
29
#include <gtk/gtktreesortable.h>
30
#include <stdarg.h>
31

32 33 34

G_BEGIN_DECLS

35 36

#define GTK_TYPE_TREE_STORE			(gtk_tree_store_get_type ())
Manish Singh's avatar
Manish Singh committed
37 38 39 40 41
#define GTK_TREE_STORE(obj)			(G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_STORE, GtkTreeStore))
#define GTK_TREE_STORE_CLASS(klass)		(G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_STORE, GtkTreeStoreClass))
#define GTK_IS_TREE_STORE(obj)			(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_STORE))
#define GTK_IS_TREE_STORE_CLASS(klass)		(G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_STORE))
#define GTK_TREE_STORE_GET_CLASS(obj)		(G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_STORE, GtkTreeStoreClass))
42 43 44 45 46 47

typedef struct _GtkTreeStore       GtkTreeStore;
typedef struct _GtkTreeStoreClass  GtkTreeStoreClass;

struct _GtkTreeStore
{
48
  GObject parent;
49

Tim Janik's avatar
Tim Janik committed
50 51 52 53 54 55 56 57 58 59
  gint GSEAL (stamp);
  gpointer GSEAL (root);
  gpointer GSEAL (last);
  gint GSEAL (n_columns);
  gint GSEAL (sort_column_id);
  GList *GSEAL (sort_list);
  GtkSortType GSEAL (order);
  GType *GSEAL (column_headers);
  GtkTreeIterCompareFunc GSEAL (default_sort_func);
  gpointer GSEAL (default_sort_data);
60
  GDestroyNotify GSEAL (default_sort_destroy);
61
  guint GSEAL (columns_dirty) : 1;
62 63 64 65
};

struct _GtkTreeStoreClass
{
66
  GObjectClass parent_class;
67 68 69 70 71 72

  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
73 74
};

75

Matthias Clasen's avatar
Matthias Clasen committed
76
GType         gtk_tree_store_get_type         (void) G_GNUC_CONST;
77 78 79 80 81 82 83
GtkTreeStore *gtk_tree_store_new              (gint          n_columns,
					       ...);
GtkTreeStore *gtk_tree_store_newv             (gint          n_columns,
					       GType        *types);
void          gtk_tree_store_set_column_types (GtkTreeStore *tree_store,
					       gint          n_columns,
					       GType        *types);
84 85 86

/* NOTE: use gtk_tree_model_get to get values from a GtkTreeStore */

87 88 89 90 91 92 93
void          gtk_tree_store_set_value        (GtkTreeStore *tree_store,
					       GtkTreeIter  *iter,
					       gint          column,
					       GValue       *value);
void          gtk_tree_store_set              (GtkTreeStore *tree_store,
					       GtkTreeIter  *iter,
					       ...);
94 95 96 97 98
void          gtk_tree_store_set_valuesv      (GtkTreeStore *tree_store,
					       GtkTreeIter  *iter,
					       gint         *columns,
					       GValue       *values,
					       gint          n_values);
99 100 101
void          gtk_tree_store_set_valist       (GtkTreeStore *tree_store,
					       GtkTreeIter  *iter,
					       va_list       var_args);
Kristian Rietveld's avatar
Kristian Rietveld committed
102
gboolean      gtk_tree_store_remove           (GtkTreeStore *tree_store,
103 104 105 106 107 108 109 110 111 112 113 114 115
					       GtkTreeIter  *iter);
void          gtk_tree_store_insert           (GtkTreeStore *tree_store,
					       GtkTreeIter  *iter,
					       GtkTreeIter  *parent,
					       gint          position);
void          gtk_tree_store_insert_before    (GtkTreeStore *tree_store,
					       GtkTreeIter  *iter,
					       GtkTreeIter  *parent,
					       GtkTreeIter  *sibling);
void          gtk_tree_store_insert_after     (GtkTreeStore *tree_store,
					       GtkTreeIter  *iter,
					       GtkTreeIter  *parent,
					       GtkTreeIter  *sibling);
116 117 118 119 120 121 122 123 124 125 126 127
void          gtk_tree_store_insert_with_values (GtkTreeStore *tree_store,
						 GtkTreeIter  *iter,
						 GtkTreeIter  *parent,
						 gint          position,
						 ...);
void          gtk_tree_store_insert_with_valuesv (GtkTreeStore *tree_store,
						  GtkTreeIter  *iter,
						  GtkTreeIter  *parent,
						  gint          position,
						  gint         *columns,
						  GValue       *values,
						  gint          n_values);
128 129 130 131 132 133 134 135 136 137 138 139
void          gtk_tree_store_prepend          (GtkTreeStore *tree_store,
					       GtkTreeIter  *iter,
					       GtkTreeIter  *parent);
void          gtk_tree_store_append           (GtkTreeStore *tree_store,
					       GtkTreeIter  *iter,
					       GtkTreeIter  *parent);
gboolean      gtk_tree_store_is_ancestor      (GtkTreeStore *tree_store,
					       GtkTreeIter  *iter,
					       GtkTreeIter  *descendant);
gint          gtk_tree_store_iter_depth       (GtkTreeStore *tree_store,
					       GtkTreeIter  *iter);
void          gtk_tree_store_clear            (GtkTreeStore *tree_store);
Kristian Rietveld's avatar
Kristian Rietveld committed
140 141
gboolean      gtk_tree_store_iter_is_valid    (GtkTreeStore *tree_store,
                                               GtkTreeIter  *iter);
142 143 144
void          gtk_tree_store_reorder          (GtkTreeStore *tree_store,
                                               GtkTreeIter  *parent,
                                               gint         *new_order);
145
void          gtk_tree_store_swap             (GtkTreeStore *tree_store,
146 147
                                               GtkTreeIter  *a,
                                               GtkTreeIter  *b);
148
void          gtk_tree_store_move_before      (GtkTreeStore *tree_store,
149
                                               GtkTreeIter  *iter,
150 151 152 153
                                               GtkTreeIter  *position);
void          gtk_tree_store_move_after       (GtkTreeStore *tree_store,
                                               GtkTreeIter  *iter,
                                               GtkTreeIter  *position);
154

155

156
G_END_DECLS
157 158 159


#endif /* __GTK_TREE_STORE_H__ */