]> Pileus Git - ~andy/gtk/blob - gtk/gtktreemodelsort.h
Merge libgdk and libgtk
[~andy/gtk] / gtk / gtktreemodelsort.h
1 /* gtktreemodelsort.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 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
21 #error "Only <gtk/gtk.h> can be included directly."
22 #endif
23
24 #ifndef __GTK_TREE_MODEL_SORT_H__
25 #define __GTK_TREE_MODEL_SORT_H__
26
27 #include <gdk/gdk.h>
28 #include <gtk/gtktreemodel.h>
29 #include <gtk/gtktreesortable.h>
30
31 G_BEGIN_DECLS
32
33 #define GTK_TYPE_TREE_MODEL_SORT                        (gtk_tree_model_sort_get_type ())
34 #define GTK_TREE_MODEL_SORT(obj)                        (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_MODEL_SORT, GtkTreeModelSort))
35 #define GTK_TREE_MODEL_SORT_CLASS(klass)                (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_MODEL_SORT, GtkTreeModelSortClass))
36 #define GTK_IS_TREE_MODEL_SORT(obj)                     (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_MODEL_SORT))
37 #define GTK_IS_TREE_MODEL_SORT_CLASS(klass)             (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_MODEL_SORT))
38 #define GTK_TREE_MODEL_SORT_GET_CLASS(obj)              (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_MODEL_SORT, GtkTreeModelSortClass))
39
40 typedef struct _GtkTreeModelSort        GtkTreeModelSort;
41 typedef struct _GtkTreeModelSortClass   GtkTreeModelSortClass;
42 typedef struct _GtkTreeModelSortPrivate GtkTreeModelSortPrivate;
43
44 struct _GtkTreeModelSort
45 {
46   GObject parent;
47
48   /* < private > */
49   GtkTreeModelSortPrivate *priv;
50 };
51
52 struct _GtkTreeModelSortClass
53 {
54   GObjectClass parent_class;
55
56   /* Padding for future expansion */
57   void (*_gtk_reserved1) (void);
58   void (*_gtk_reserved2) (void);
59   void (*_gtk_reserved3) (void);
60   void (*_gtk_reserved4) (void);
61 };
62
63
64 GType         gtk_tree_model_sort_get_type                   (void) G_GNUC_CONST;
65 GtkTreeModel *gtk_tree_model_sort_new_with_model             (GtkTreeModel     *child_model);
66
67 GtkTreeModel *gtk_tree_model_sort_get_model                  (GtkTreeModelSort *tree_model);
68 GtkTreePath  *gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
69                                                               GtkTreePath      *child_path);
70 gboolean      gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sort,
71                                                               GtkTreeIter      *sort_iter,
72                                                               GtkTreeIter      *child_iter);
73 GtkTreePath  *gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort,
74                                                               GtkTreePath      *sorted_path);
75 void          gtk_tree_model_sort_convert_iter_to_child_iter (GtkTreeModelSort *tree_model_sort,
76                                                               GtkTreeIter      *child_iter,
77                                                               GtkTreeIter      *sorted_iter);
78 void          gtk_tree_model_sort_reset_default_sort_func    (GtkTreeModelSort *tree_model_sort);
79 void          gtk_tree_model_sort_clear_cache                (GtkTreeModelSort *tree_model_sort);
80 gboolean      gtk_tree_model_sort_iter_is_valid              (GtkTreeModelSort *tree_model_sort,
81                                                               GtkTreeIter      *iter);
82
83
84 G_END_DECLS
85
86 #endif /* __GTK_TREE_MODEL_SORT_H__ */