2 * Copyright (C) 2001 Red Hat, Inc.
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.
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.
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.
20 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
21 #error "Only <gtk/gtk.h> can be included directly."
24 #ifndef __GTK_TREE_SORTABLE_H__
25 #define __GTK_TREE_SORTABLE_H__
28 #include <gtk/gtkenums.h>
29 #include <gtk/gtktreemodel.h>
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))
41 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID = -1,
42 GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID = -2
45 typedef struct _GtkTreeSortable GtkTreeSortable; /* Dummy typedef */
46 typedef struct _GtkTreeSortableIface GtkTreeSortableIface;
49 * GtkTreeIterCompareFunc:
50 * @model: The #GtkTreeModel the comparison is within
51 * @a: A #GtkTreeIter in @model
52 * @b: Another #GtkTreeIter in @model
53 * @user_data: Data passed when the compare func is assigned e.g. by
54 * gtk_tree_sortable_set_sort_func()
56 * A GtkTreeIterCompareFunc should return a negative integer, zero, or a positive
57 * integer if @a sorts before @b, @a sorts with @b, or @a sorts after @b
58 * respectively. If two iters compare as equal, their order in the sorted model
59 * is undefined. In order to ensure that the #GtkTreeSortable behaves as
60 * expected, the GtkTreeIterCompareFunc must define a partial order on
61 * the model, i.e. it must be reflexive, antisymmetric and transitive.
63 * For example, if @model is a product catalogue, then a compare function
64 * for the "price" column could be one which returns
65 * <literal>price_of(@a) - price_of(@b)</literal>.
67 * Returns: a negative integer, zero or a positive integer depending on whether
68 * @a sorts before, with or after @b
70 typedef gint (* GtkTreeIterCompareFunc) (GtkTreeModel *model,
76 struct _GtkTreeSortableIface
78 GTypeInterface g_iface;
81 void (* sort_column_changed) (GtkTreeSortable *sortable);
84 gboolean (* get_sort_column_id) (GtkTreeSortable *sortable,
87 void (* set_sort_column_id) (GtkTreeSortable *sortable,
90 void (* set_sort_func) (GtkTreeSortable *sortable,
92 GtkTreeIterCompareFunc sort_func,
94 GDestroyNotify destroy);
95 void (* set_default_sort_func) (GtkTreeSortable *sortable,
96 GtkTreeIterCompareFunc sort_func,
98 GDestroyNotify destroy);
99 gboolean (* has_default_sort_func) (GtkTreeSortable *sortable);
103 GType gtk_tree_sortable_get_type (void) G_GNUC_CONST;
105 void gtk_tree_sortable_sort_column_changed (GtkTreeSortable *sortable);
106 gboolean gtk_tree_sortable_get_sort_column_id (GtkTreeSortable *sortable,
107 gint *sort_column_id,
109 void gtk_tree_sortable_set_sort_column_id (GtkTreeSortable *sortable,
112 void gtk_tree_sortable_set_sort_func (GtkTreeSortable *sortable,
114 GtkTreeIterCompareFunc sort_func,
116 GDestroyNotify destroy);
117 void gtk_tree_sortable_set_default_sort_func (GtkTreeSortable *sortable,
118 GtkTreeIterCompareFunc sort_func,
120 GDestroyNotify destroy);
121 gboolean gtk_tree_sortable_has_default_sort_func (GtkTreeSortable *sortable);
125 #endif /* __GTK_TREE_SORTABLE_H__ */