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

   1 /* gtktreemodelfilter.h
   2  * Copyright (C) 2000,2001  Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
   3  * Copyright (C) 2001-2003  Kristian Rietveld <kris@gtk.org>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of the
   8  * License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public
  16  * License along with this program; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef __GTK_TREE_MODEL_FILTER_H__
  22 #define __GTK_TREE_MODEL_FILTER_H__
  23
  24 #include <gtk/gtktreemodel.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #define GTK_TYPE_TREE_MODEL_FILTER              (gtk_tree_model_filter_get_type ())
  29 #define GTK_TREE_MODEL_FILTER(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_MODEL_FILTER, GtkTreeModelFilter))
  30 #define GTK_TREE_MODEL_FILTER_CLASS(vtable)     (G_TYPE_CHECK_CLASS_CAST ((vtable), GTK_TYPE_TREE_MODEL_FILTER, GtkTreeModelFilterClass))
  31 #define GTK_IS_TREE_MODEL_FILTER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_MODEL_FILTER))
  32 #define GTK_IS_TREE_MODEL_FILTER_CLASS(vtable)  (G_TYPE_CHECK_CLASS_TYPE ((vtable), GTK_TYPE_TREE_MODEL_FILTER))
  33 #define GTK_TREE_MODEL_FILTER_GET_CLASS(inst)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_MODEL_FILTER, GtkTreeModelFilterClass))
  34
  35 typedef gboolean (* GtkTreeModelFilterVisibleFunc) (GtkTreeModel *model,
  36                                                     GtkTreeIter  *iter,
  37                                                     gpointer      data);
  38 typedef void (* GtkTreeModelFilterModifyFunc) (GtkTreeModel *model,
  39                                                GtkTreeIter  *iter,
  40                                                GValue       *value,
  41                                                gint          column,
  42                                                gpointer      data);
  43
  44 typedef struct _GtkTreeModelFilter          GtkTreeModelFilter;
  45 typedef struct _GtkTreeModelFilterClass     GtkTreeModelFilterClass;
  46 typedef struct _GtkTreeModelFilterPrivate   GtkTreeModelFilterPrivate;
  47
  48 struct _GtkTreeModelFilter
  49 {
  50   GObject parent;
  51
  52   /*< private >*/
  53   GtkTreeModelFilterPrivate *priv;
  54 };
  55
  56 struct _GtkTreeModelFilterClass
  57 {
  58   GObjectClass parent_class;
  59 };
  60
  61 /* base */
  62 GType         gtk_tree_model_filter_get_type                   (void);
  63 GtkTreeModel *gtk_tree_model_filter_new                        (GtkTreeModel                 *child_model,
  64                                                                 GtkTreePath                  *root);
  65 void          gtk_tree_model_filter_set_visible_func           (GtkTreeModelFilter           *filter,
  66                                                                 GtkTreeModelFilterVisibleFunc func,
  67                                                                 gpointer                      data,
  68                                                                 GtkDestroyNotify              destroy);
  69 void          gtk_tree_model_filter_set_modify_func            (GtkTreeModelFilter           *filter,
  70                                                                 gint                          n_columns,
  71                                                                 GType                        *types,
  72                                                                 GtkTreeModelFilterModifyFunc  func,
  73                                                                 gpointer                      data,
  74                                                                 GtkDestroyNotify              destroy);
  75 void          gtk_tree_model_filter_set_visible_column         (GtkTreeModelFilter           *filter,
  76                                                                 gint                          column);
  77
  78 GtkTreeModel *gtk_tree_model_filter_get_model                  (GtkTreeModelFilter           *filter);
  79
  80 /* conversion */
  81 void          gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter           *filter,
  82                                                                 GtkTreeIter                  *filter_iter,
  83                                                                 GtkTreeIter                  *child_iter);
  84 void          gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter           *filter,
  85                                                                 GtkTreeIter                  *child_iter,
  86                                                                 GtkTreeIter                  *filter_iter);
  87 GtkTreePath  *gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter           *filter,
  88                                                                 GtkTreePath                  *child_path);
  89 GtkTreePath  *gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter           *path,
  90                                                                 GtkTreePath                  *filter_path);
  91
  92 /* extras */
  93 void          gtk_tree_model_filter_refilter                   (GtkTreeModelFilter           *filter);
  94 void          gtk_tree_model_filter_clear_cache                (GtkTreeModelFilter           *filter);
  95
  96 G_END_DECLS
  97
  98 #endif /* __GTK_TREE_MODEL_FILTER_H__ */