1/* gtktreesortable.h
2 * Copyright (C) 2001 Red Hat, Inc.
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_TREE_SORTABLE_H__
21#define __GTK_TREE_SORTABLE_H__
22
23
24#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
25#error "Only <gtk/gtk.h> can be included directly."
26#endif
27
28#include <gtk/gtktreemodel.h>
29#include <gtk/gtktypeutils.h>
30
31
32G_BEGIN_DECLS
33
34#define GTK_TYPE_TREE_SORTABLE (gtk_tree_sortable_get_type ())
35#define GTK_TREE_SORTABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_SORTABLE, GtkTreeSortable))
36#define GTK_TREE_SORTABLE_CLASS(obj) (G_TYPE_CHECK_CLASS_CAST ((obj), GTK_TYPE_TREE_SORTABLE, GtkTreeSortableIface))
37#define GTK_IS_TREE_SORTABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_SORTABLE))
38#define GTK_TREE_SORTABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_TREE_SORTABLE, GtkTreeSortableIface))
39
40enum {
41 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID = -1,
42 GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID = -2
43};
44
45typedef struct _GtkTreeSortable GtkTreeSortable; /* Dummy typedef */
46typedef struct _GtkTreeSortableIface GtkTreeSortableIface;
47
48typedef gint (* GtkTreeIterCompareFunc) (GtkTreeModel *model,
49 GtkTreeIter *a,
50 GtkTreeIter *b,
51 gpointer user_data);
52
53
54struct _GtkTreeSortableIface
55{
56 GTypeInterface g_iface;
57
58 /* signals */
59 void (* sort_column_changed) (GtkTreeSortable *sortable);
60
61 /* virtual table */
62 gboolean (* get_sort_column_id) (GtkTreeSortable *sortable,
63 gint *sort_column_id,
64 GtkSortType *order);
65 void (* set_sort_column_id) (GtkTreeSortable *sortable,
66 gint sort_column_id,
67 GtkSortType order);
68 void (* set_sort_func) (GtkTreeSortable *sortable,
69 gint sort_column_id,
70 GtkTreeIterCompareFunc func,
71 gpointer data,
72 GDestroyNotify destroy);
73 void (* set_default_sort_func) (GtkTreeSortable *sortable,
74 GtkTreeIterCompareFunc func,
75 gpointer data,
76 GDestroyNotify destroy);
77 gboolean (* has_default_sort_func) (GtkTreeSortable *sortable);
78};
79
80
81GType gtk_tree_sortable_get_type (void) G_GNUC_CONST;
82
83void gtk_tree_sortable_sort_column_changed (GtkTreeSortable *sortable);
84gboolean gtk_tree_sortable_get_sort_column_id (GtkTreeSortable *sortable,
85 gint *sort_column_id,
86 GtkSortType *order);
87void gtk_tree_sortable_set_sort_column_id (GtkTreeSortable *sortable,
88 gint sort_column_id,
89 GtkSortType order);
90void gtk_tree_sortable_set_sort_func (GtkTreeSortable *sortable,
91 gint sort_column_id,
92 GtkTreeIterCompareFunc sort_func,
93 gpointer user_data,
94 GDestroyNotify destroy);
95void gtk_tree_sortable_set_default_sort_func (GtkTreeSortable *sortable,
96 GtkTreeIterCompareFunc sort_func,
97 gpointer user_data,
98 GDestroyNotify destroy);
99gboolean gtk_tree_sortable_has_default_sort_func (GtkTreeSortable *sortable);
100
101G_END_DECLS
102
103#endif /* __GTK_TREE_SORTABLE_H__ */
104