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 #ifndef __GTK_TREE_SORTABLE_H__
  21 #define __GTK_TREE_SORTABLE_H__
  22
  23 #include <gtk/gtkenums.h>
  24 #include <gtk/gtktreemodel.h>
  25 #include <gtk/gtktypeutils.h>
  26
  27 G_BEGIN_DECLS
  28
  29 #define GTK_TYPE_TREE_SORTABLE            (gtk_tree_sortable_get_type ())
  30 #define GTK_TREE_SORTABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_SORTABLE, GtkTreeSortable))
  31 #define GTK_TREE_SORTABLE_CLASS(obj)      (G_TYPE_CHECK_CLASS_CAST ((obj), GTK_TYPE_TREE_SORTABLE, GtkTreeSortableIface))
  32 #define GTK_IS_TREE_SORTABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_SORTABLE))
  33 #define GTK_TREE_SORTABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_TREE_SORTABLE, GtkTreeSortableIface))
  34
  35 enum {
  36   GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID = -1,
  37   GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID = -2
  38 };
  39
  40 typedef struct _GtkTreeSortable      GtkTreeSortable; /* Dummy typedef */
  41 typedef struct _GtkTreeSortableIface GtkTreeSortableIface;
  42
  43 typedef gint (* GtkTreeIterCompareFunc) (GtkTreeModel *model,
  44                                          GtkTreeIter  *a,
  45                                          GtkTreeIter  *b,
  46                                          gpointer      user_data);
  47
  48
  49 struct _GtkTreeSortableIface
  50 {
  51   GTypeInterface g_iface;
  52
  53   /* signals */
  54   void     (* sort_column_changed)   (GtkTreeSortable        *sortable);
  55
  56   /* virtual table */
  57   gboolean (* get_sort_column_id)    (GtkTreeSortable        *sortable,
  58                                       gint                   *sort_column_id,
  59                                       GtkSortType            *order);
  60   void     (* set_sort_column_id)    (GtkTreeSortable        *sortable,
  61                                       gint                    sort_column_id,
  62                                       GtkSortType             order);
  63   void     (* set_sort_func)         (GtkTreeSortable        *sortable,
  64                                       gint                    sort_column_id,
  65                                       GtkTreeIterCompareFunc  func,
  66                                       gpointer                data,
  67                                       GtkDestroyNotify        destroy);
  68   void     (* set_default_sort_func) (GtkTreeSortable        *sortable,
  69                                       GtkTreeIterCompareFunc  func,
  70                                       gpointer                data,
  71                                       GtkDestroyNotify        destroy);
  72   gboolean (* has_default_sort_func) (GtkTreeSortable        *sortable);
  73 };
  74
  75
  76 GType    gtk_tree_sortable_get_type              (void) G_GNUC_CONST;
  77
  78 void     gtk_tree_sortable_sort_column_changed   (GtkTreeSortable        *sortable);
  79 gboolean gtk_tree_sortable_get_sort_column_id    (GtkTreeSortable        *sortable,
  80                                                   gint                   *sort_column_id,
  81                                                   GtkSortType            *order);
  82 void     gtk_tree_sortable_set_sort_column_id    (GtkTreeSortable        *sortable,
  83                                                   gint                    sort_column_id,
  84                                                   GtkSortType             order);
  85 void     gtk_tree_sortable_set_sort_func         (GtkTreeSortable        *sortable,
  86                                                   gint                    sort_column_id,
  87                                                   GtkTreeIterCompareFunc  sort_func,
  88                                                   gpointer                user_data,
  89                                                   GtkDestroyNotify        destroy);
  90 void     gtk_tree_sortable_set_default_sort_func (GtkTreeSortable        *sortable,
  91                                                   GtkTreeIterCompareFunc  sort_func,
  92                                                   gpointer                user_data,
  93                                                   GtkDestroyNotify        destroy);
  94 gboolean gtk_tree_sortable_has_default_sort_func (GtkTreeSortable        *sortable);
  95
  96
  97 G_END_DECLS
  98
  99 #endif /* __GTK_TREE_SORTABLE_H__ */