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

   1 /* gtktreesortable.c
   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
  21 #include <config.h>
  22 #include "gtkalias.h"
  23 #include "gtktreesortable.h"
  24 #include "gtkmarshalers.h"
  25
  26 static void gtk_tree_sortable_base_init (gpointer g_class);
  27
  28 GType
  29 gtk_tree_sortable_get_type (void)
  30 {
  31   static GType tree_sortable_type = 0;
  32
  33   if (! tree_sortable_type)
  34     {
  35       static const GTypeInfo tree_sortable_info =
  36       {
  37         sizeof (GtkTreeSortableIface), /* class_size */
  38         gtk_tree_sortable_base_init,   /* base_init */
  39         NULL,           /* base_finalize */
  40         NULL,
  41         NULL,           /* class_finalize */
  42         NULL,           /* class_data */
  43         0,
  44         0,
  45         NULL
  46       };
  47
  48       tree_sortable_type =
  49         g_type_register_static (G_TYPE_INTERFACE, "GtkTreeSortable",
  50                                 &tree_sortable_info, 0);
  51
  52       g_type_interface_add_prerequisite (tree_sortable_type, GTK_TYPE_TREE_MODEL);
  53     }
  54
  55   return tree_sortable_type;
  56 }
  57
  58 static void
  59 gtk_tree_sortable_base_init (gpointer g_class)
  60 {
  61   static gboolean initialized = FALSE;
  62
  63   if (! initialized)
  64     {
  65       g_signal_new ("sort_column_changed",
  66                     GTK_TYPE_TREE_SORTABLE,
  67                     G_SIGNAL_RUN_LAST,
  68                     G_STRUCT_OFFSET (GtkTreeSortableIface, sort_column_changed),
  69                     NULL, NULL,
  70                     _gtk_marshal_VOID__VOID,
  71                     G_TYPE_NONE, 0);
  72       initialized = TRUE;
  73     }
  74 }
  75
  76 /**
  77  * gtk_tree_sortable_sort_column_changed:
  78  * @sortable: A #GtkTreeSortable
  79  *
  80  * Emits a GtkTreeSortable::sort_column_changed signal on
  81  **/
  82 void
  83 gtk_tree_sortable_sort_column_changed (GtkTreeSortable *sortable)
  84 {
  85   g_return_if_fail (GTK_IS_TREE_SORTABLE (sortable));
  86
  87   g_signal_emit_by_name (sortable, "sort_column_changed");
  88 }
  89
  90 /**
  91  * gtk_tree_sortable_get_sort_column_id:
  92  * @sortable: A #GtkTreeSortable
  93  * @sort_column_id: The sort column id to be filled in
  94  * @order: The #GtkSortType to be filled in
  95  *
  96  * Fills in @sort_column_id and @order with the current sort column and the
  97  * order, if applicable.  If the sort column is not set, then FALSE is returned,
  98  * and the values in @sort_column_id and @order are unchanged.
  99   *
 100  * Return value: %TRUE, if the sort column has been set
 101  **/
 102 gboolean
 103 gtk_tree_sortable_get_sort_column_id (GtkTreeSortable  *sortable,
 104                                       gint             *sort_column_id,
 105                                       GtkSortType      *order)
 106 {
 107   GtkTreeSortableIface *iface;
 108
 109   g_return_val_if_fail (GTK_IS_TREE_SORTABLE (sortable), FALSE);
 110
 111   iface = GTK_TREE_SORTABLE_GET_IFACE (sortable);
 112
 113   g_return_val_if_fail (iface != NULL, FALSE);
 114   g_return_val_if_fail (iface->get_sort_column_id != NULL, FALSE);
 115
 116   return (* iface->get_sort_column_id) (sortable, sort_column_id, order);
 117 }
 118
 119 /**
 120  * gtk_tree_sortable_set_sort_column_id:
 121  * @sortable: A #GtkTreeSortable
 122  * @sort_column_id: the sort column id to set
 123  * @order: The sort order of the column
 124  *
 125  * Sets the current sort column to be @sort_column_id.  The @sortable will
 126  * resort itself to reflect this change, after emitting a
 127  * GtkTreeSortable::sort_column_changed signal.  If @sort_column_id is
 128  * %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the default sort function
 129  * will be used, if it is set.
 130  **/
 131 void
 132 gtk_tree_sortable_set_sort_column_id (GtkTreeSortable  *sortable,
 133                                       gint              sort_column_id,
 134                                       GtkSortType       order)
 135 {
 136   GtkTreeSortableIface *iface;
 137
 138   g_return_if_fail (GTK_IS_TREE_SORTABLE (sortable));
 139
 140   iface = GTK_TREE_SORTABLE_GET_IFACE (sortable);
 141
 142   g_return_if_fail (iface != NULL);
 143   g_return_if_fail (iface->set_sort_column_id != NULL);
 144
 145   (* iface->set_sort_column_id) (sortable, sort_column_id, order);
 146 }
 147
 148 /**
 149  * gtk_tree_sortable_set_sort_func:
 150  * @sortable: A #GtkTreeSortable
 151  * @sort_column_id: the sort column id to set the function for
 152  * @sort_func: The sorting function
 153  * @user_data: User data to pass to the sort func, or %NULL
 154  * @destroy: Destroy notifier of @user_data, or %NULL
 155  *
 156  * Sets the comparison function used when sorting to be @sort_func.  If the
 157  * current sort column id of @sortable is the same as @sort_column_id, then the
 158  * model will sort using this function.
 159  **/
 160 void
 161 gtk_tree_sortable_set_sort_func (GtkTreeSortable        *sortable,
 162                                  gint                    sort_column_id,
 163                                  GtkTreeIterCompareFunc  sort_func,
 164                                  gpointer                user_data,
 165                                  GtkDestroyNotify        destroy)
 166 {
 167   GtkTreeSortableIface *iface;
 168
 169   g_return_if_fail (GTK_IS_TREE_SORTABLE (sortable));
 170
 171   iface = GTK_TREE_SORTABLE_GET_IFACE (sortable);
 172
 173   g_return_if_fail (iface != NULL);
 174   g_return_if_fail (iface->set_sort_func != NULL);
 175   g_return_if_fail (sort_column_id >= 0);
 176
 177   (* iface->set_sort_func) (sortable, sort_column_id, sort_func, user_data, destroy);
 178 }
 179
 180 /**
 181  * gtk_tree_sortable_set_default_sort_func:
 182  * @sortable: A #GtkTreeSortable
 183  * @sort_func: The sorting function
 184  * @user_data: User data to pass to the sort func, or %NULL
 185  * @destroy: Destroy notifier of @user_data, or %NULL
 186  *
 187  * Sets the default comparison function used when sorting to be @sort_func.  If
 188  * the current sort column id of @sortable is
 189  * %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using this function.
 190  *
 191  * If @sort_func is %NULL, then there will be no default comparison function.
 192  * This means that once the model  has been sorted, it can't go back to the
 193  * default state. In this case, when the current sort column id of @sortable is
 194  * GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted.
 195  **/
 196 void
 197 gtk_tree_sortable_set_default_sort_func (GtkTreeSortable        *sortable,
 198                                          GtkTreeIterCompareFunc  sort_func,
 199                                          gpointer                user_data,
 200                                          GtkDestroyNotify        destroy)
 201 {
 202   GtkTreeSortableIface *iface;
 203
 204   g_return_if_fail (GTK_IS_TREE_SORTABLE (sortable));
 205
 206   iface = GTK_TREE_SORTABLE_GET_IFACE (sortable);
 207
 208   g_return_if_fail (iface != NULL);
 209   g_return_if_fail (iface->set_default_sort_func != NULL);
 210
 211   (* iface->set_default_sort_func) (sortable, sort_func, user_data, destroy);
 212 }
 213
 214 /**
 215  * gtk_tree_sortable_has_default_sort_func:
 216  * @sortable: A #GtkTreeSortable
 217  *
 218  * Returns %TRUE if the model has a default sort function.  This is used
 219  * primarily by GtkTreeViewColumns in order to determine if a model can go back
 220  * to the default state, or not.
 221  *
 222  * Return value: %TRUE, if the model has a default sort function
 223  **/
 224 gboolean
 225 gtk_tree_sortable_has_default_sort_func (GtkTreeSortable *sortable)
 226 {
 227   GtkTreeSortableIface *iface;
 228
 229   g_return_val_if_fail (GTK_IS_TREE_SORTABLE (sortable), FALSE);
 230
 231   iface = GTK_TREE_SORTABLE_GET_IFACE (sortable);
 232
 233   g_return_val_if_fail (iface != NULL, FALSE);
 234   g_return_val_if_fail (iface->has_default_sort_func != NULL, FALSE);
 235
 236   return (* iface->has_default_sort_func) (sortable);
 237 }