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, 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_MODEL_SORT_H__
  21 #define __GTK_TREE_MODEL_SORT_H__
  22
  23 #include <gtk/gtktreemodel.h>
  24 #include <gtk/gtktreesortable.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #define GTK_TYPE_TREE_MODEL_SORT                        (gtk_tree_model_sort_get_type ())
  29 #define GTK_TREE_MODEL_SORT(obj)                        (GTK_CHECK_CAST ((obj), GTK_TYPE_TREE_MODEL_SORT, GtkTreeModelSort))
  30 #define GTK_TREE_MODEL_SORT_CLASS(klass)                (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_MODEL_SORT, GtkTreeModelSortClass))
  31 #define GTK_IS_TREE_MODEL_SORT(obj)                     (GTK_CHECK_TYPE ((obj), GTK_TYPE_TREE_MODEL_SORT))
  32 #define GTK_IS_TREE_MODEL_SORT_CLASS(klass)             (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_MODEL_SORT))
  33 #define GTK_TREE_MODEL_SORT_GET_CLASS(obj)              (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_TREE_MODEL_SORT, GtkTreeModelSortClass))
  34
  35 typedef struct _GtkTreeModelSort       GtkTreeModelSort;
  36 typedef struct _GtkTreeModelSortClass  GtkTreeModelSortClass;
  37
  38 struct _GtkTreeModelSort
  39 {
  40   GObject parent;
  41
  42   /* < private > */
  43   gpointer root;
  44   gint stamp;
  45   guint child_flags;
  46   GtkTreeModel *child_model;
  47   gint zero_ref_count;
  48
  49   /* sort information */
  50   GList *sort_list;
  51   gint sort_column_id;
  52   GtkSortType order;
  53
  54   /* default sort */
  55   GtkTreeIterCompareFunc default_sort_func;
  56   gpointer default_sort_data;
  57   GtkDestroyNotify default_sort_destroy;
  58
  59   /* signal ids */
  60   guint changed_id;
  61   guint inserted_id;
  62   guint has_child_toggled_id;
  63   guint deleted_id;
  64   guint reordered_id;
  65 };
  66
  67 struct _GtkTreeModelSortClass
  68 {
  69   GObjectClass parent_class;
  70
  71   /* Padding for future expansion */
  72   void (*_gtk_reserved1) (void);
  73   void (*_gtk_reserved2) (void);
  74   void (*_gtk_reserved3) (void);
  75   void (*_gtk_reserved4) (void);
  76 };
  77
  78
  79 GType         gtk_tree_model_sort_get_type                   (void) G_GNUC_CONST;
  80 GtkTreeModel *gtk_tree_model_sort_new_with_model             (GtkTreeModel     *child_model);
  81
  82 GtkTreeModel *gtk_tree_model_sort_get_model                  (GtkTreeModelSort *tree_model);
  83 GtkTreePath  *gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
  84                                                               GtkTreePath      *child_path);
  85 void          gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sort,
  86                                                               GtkTreeIter      *sort_iter,
  87                                                               GtkTreeIter      *child_iter);
  88 GtkTreePath  *gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort,
  89                                                               GtkTreePath      *sorted_path);
  90 void          gtk_tree_model_sort_convert_iter_to_child_iter (GtkTreeModelSort *tree_model_sort,
  91                                                               GtkTreeIter      *child_iter,
  92                                                               GtkTreeIter      *sorted_iter);
  93 void          gtk_tree_model_sort_reset_default_sort_func    (GtkTreeModelSort *tree_model_sort);
  94 void          gtk_tree_model_sort_clear_cache                (GtkTreeModelSort *tree_model_sort);
  95 gboolean      gtk_tree_model_sort_iter_is_valid              (GtkTreeModelSort *tree_model_sort,
  96                                                               GtkTreeIter      *iter);
  97
  98
  99 G_END_DECLS
 100
 101 #endif /* __GTK_TREE_MODEL_SORT_H__ */