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