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