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