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