Pileus Git - ~andy/gtk/blob - gtk/gtktreesortable.h

   1 /* gtktreesortable.h
   2  * Copyright (C) 2001  Red Hat, Inc.
   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_SORTABLE_H__
  19 #define __GTK_TREE_SORTABLE_H__
  20
  21
  22 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  23 #error "Only <gtk/gtk.h> can be included directly."
  24 #endif
  25
  26 #include <gtk/gtkenums.h>
  27 #include <gtk/gtktreemodel.h>
  28
  29
  30 G_BEGIN_DECLS
  31
  32 #define GTK_TYPE_TREE_SORTABLE            (gtk_tree_sortable_get_type ())
  33 #define GTK_TREE_SORTABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_SORTABLE, GtkTreeSortable))
  34 #define GTK_TREE_SORTABLE_CLASS(obj)      (G_TYPE_CHECK_CLASS_CAST ((obj), GTK_TYPE_TREE_SORTABLE, GtkTreeSortableIface))
  35 #define GTK_IS_TREE_SORTABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_SORTABLE))
  36 #define GTK_TREE_SORTABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_TREE_SORTABLE, GtkTreeSortableIface))
  37
  38 enum {
  39   GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID = -1,
  40   GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID = -2
  41 };
  42
  43 typedef struct _GtkTreeSortable      GtkTreeSortable; /* Dummy typedef */
  44 typedef struct _GtkTreeSortableIface GtkTreeSortableIface;
  45
  46 /**
  47  * GtkTreeIterCompareFunc:
  48  * @model: The #GtkTreeModel the comparison is within
  49  * @a: A #GtkTreeIter in @model
  50  * @b: Another #GtkTreeIter in @model
  51  * @user_data: Data passed when the compare func is assigned e.g. by
  52  *  gtk_tree_sortable_set_sort_func()
  53  *
  54  * A GtkTreeIterCompareFunc should return a negative integer, zero, or a positive
  55  * integer if @a sorts before @b, @a sorts with @b, or @a sorts after @b
  56  * respectively. If two iters compare as equal, their order in the sorted model
  57  * is undefined. In order to ensure that the #GtkTreeSortable behaves as
  58  * expected, the GtkTreeIterCompareFunc must define a partial order on
  59  * the model, i.e. it must be reflexive, antisymmetric and transitive.
  60  *
  61  * For example, if @model is a product catalogue, then a compare function
  62  * for the "price" column could be one which returns
  63  * <literal>price_of(@a) - price_of(@b)</literal>.
  64  *
  65  * Returns: a negative integer, zero or a positive integer depending on whether
  66  *   @a sorts before, with or after @b
  67  */
  68 typedef gint (* GtkTreeIterCompareFunc) (GtkTreeModel *model,
  69                                          GtkTreeIter  *a,
  70                                          GtkTreeIter  *b,
  71                                          gpointer      user_data);
  72
  73
  74 struct _GtkTreeSortableIface
  75 {
  76   GTypeInterface g_iface;
  77
  78   /* signals */
  79   void     (* sort_column_changed)   (GtkTreeSortable        *sortable);
  80
  81   /* virtual table */
  82   gboolean (* get_sort_column_id)    (GtkTreeSortable        *sortable,
  83                                       gint                   *sort_column_id,
  84                                       GtkSortType            *order);
  85   void     (* set_sort_column_id)    (GtkTreeSortable        *sortable,
  86                                       gint                    sort_column_id,
  87                                       GtkSortType             order);
  88   void     (* set_sort_func)         (GtkTreeSortable        *sortable,
  89                                       gint                    sort_column_id,
  90                                       GtkTreeIterCompareFunc  sort_func,
  91                                       gpointer                user_data,
  92                                       GDestroyNotify          destroy);
  93   void     (* set_default_sort_func) (GtkTreeSortable        *sortable,
  94                                       GtkTreeIterCompareFunc  sort_func,
  95                                       gpointer                user_data,
  96                                       GDestroyNotify          destroy);
  97   gboolean (* has_default_sort_func) (GtkTreeSortable        *sortable);
  98 };
  99
 100
 101 GType    gtk_tree_sortable_get_type              (void) G_GNUC_CONST;
 102
 103 void     gtk_tree_sortable_sort_column_changed   (GtkTreeSortable        *sortable);
 104 gboolean gtk_tree_sortable_get_sort_column_id    (GtkTreeSortable        *sortable,
 105                                                   gint                   *sort_column_id,
 106                                                   GtkSortType            *order);
 107 void     gtk_tree_sortable_set_sort_column_id    (GtkTreeSortable        *sortable,
 108                                                   gint                    sort_column_id,
 109                                                   GtkSortType             order);
 110 void     gtk_tree_sortable_set_sort_func         (GtkTreeSortable        *sortable,
 111                                                   gint                    sort_column_id,
 112                                                   GtkTreeIterCompareFunc  sort_func,
 113                                                   gpointer                user_data,
 114                                                   GDestroyNotify          destroy);
 115 void     gtk_tree_sortable_set_default_sort_func (GtkTreeSortable        *sortable,
 116                                                   GtkTreeIterCompareFunc  sort_func,
 117                                                   gpointer                user_data,
 118                                                   GDestroyNotify          destroy);
 119 gboolean gtk_tree_sortable_has_default_sort_func (GtkTreeSortable        *sortable);
 120
 121 G_END_DECLS
 122
 123 #endif /* __GTK_TREE_SORTABLE_H__ */