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 library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library 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  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  22 #error "Only <gtk/gtk.h> can be included directly."
  23 #endif
  24
  25 #ifndef __GTK_TREE_MODEL_FILTER_H__
  26 #define __GTK_TREE_MODEL_FILTER_H__
  27
  28 #include <gtk/gtktreemodel.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define GTK_TYPE_TREE_MODEL_FILTER              (gtk_tree_model_filter_get_type ())
  33 #define GTK_TREE_MODEL_FILTER(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_MODEL_FILTER, GtkTreeModelFilter))
  34 #define GTK_TREE_MODEL_FILTER_CLASS(vtable)     (G_TYPE_CHECK_CLASS_CAST ((vtable), GTK_TYPE_TREE_MODEL_FILTER, GtkTreeModelFilterClass))
  35 #define GTK_IS_TREE_MODEL_FILTER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_MODEL_FILTER))
  36 #define GTK_IS_TREE_MODEL_FILTER_CLASS(vtable)  (G_TYPE_CHECK_CLASS_TYPE ((vtable), GTK_TYPE_TREE_MODEL_FILTER))
  37 #define GTK_TREE_MODEL_FILTER_GET_CLASS(inst)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_MODEL_FILTER, GtkTreeModelFilterClass))
  38
  39 typedef gboolean (* GtkTreeModelFilterVisibleFunc) (GtkTreeModel *model,
  40                                                     GtkTreeIter  *iter,
  41                                                     gpointer      data);
  42 typedef void (* GtkTreeModelFilterModifyFunc) (GtkTreeModel *model,
  43                                                GtkTreeIter  *iter,
  44                                                GValue       *value,
  45                                                gint          column,
  46                                                gpointer      data);
  47
  48 typedef struct _GtkTreeModelFilter          GtkTreeModelFilter;
  49 typedef struct _GtkTreeModelFilterClass     GtkTreeModelFilterClass;
  50 typedef struct _GtkTreeModelFilterPrivate   GtkTreeModelFilterPrivate;
  51
  52 struct _GtkTreeModelFilter
  53 {
  54   GObject parent;
  55
  56   /*< private >*/
  57   GtkTreeModelFilterPrivate *priv;
  58 };
  59
  60 struct _GtkTreeModelFilterClass
  61 {
  62   GObjectClass parent_class;
  63
  64   /* Padding for future expansion */
  65   void (*_gtk_reserved0) (void);
  66   void (*_gtk_reserved1) (void);
  67   void (*_gtk_reserved2) (void);
  68   void (*_gtk_reserved3) (void);
  69 };
  70
  71 /* base */
  72 GType         gtk_tree_model_filter_get_type                   (void) G_GNUC_CONST;
  73 GtkTreeModel *gtk_tree_model_filter_new                        (GtkTreeModel                 *child_model,
  74                                                                 GtkTreePath                  *root);
  75 void          gtk_tree_model_filter_set_visible_func           (GtkTreeModelFilter           *filter,
  76                                                                 GtkTreeModelFilterVisibleFunc func,
  77                                                                 gpointer                      data,
  78                                                                 GtkDestroyNotify              destroy);
  79 void          gtk_tree_model_filter_set_modify_func            (GtkTreeModelFilter           *filter,
  80                                                                 gint                          n_columns,
  81                                                                 GType                        *types,
  82                                                                 GtkTreeModelFilterModifyFunc  func,
  83                                                                 gpointer                      data,
  84                                                                 GtkDestroyNotify              destroy);
  85 void          gtk_tree_model_filter_set_visible_column         (GtkTreeModelFilter           *filter,
  86                                                                 gint                          column);
  87
  88 GtkTreeModel *gtk_tree_model_filter_get_model                  (GtkTreeModelFilter           *filter);
  89
  90 /* conversion */
  91 gboolean      gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter           *filter,
  92                                                                 GtkTreeIter                  *filter_iter,
  93                                                                 GtkTreeIter                  *child_iter);
  94 void          gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter           *filter,
  95                                                                 GtkTreeIter                  *child_iter,
  96                                                                 GtkTreeIter                  *filter_iter);
  97 GtkTreePath  *gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter           *filter,
  98                                                                 GtkTreePath                  *child_path);
  99 GtkTreePath  *gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter           *filter,
 100                                                                 GtkTreePath                  *filter_path);
 101
 102 /* extras */
 103 void          gtk_tree_model_filter_refilter                   (GtkTreeModelFilter           *filter);
 104 void          gtk_tree_model_filter_clear_cache                (GtkTreeModelFilter           *filter);
 105
 106 G_END_DECLS
 107
 108 #endif /* __GTK_TREE_MODEL_FILTER_H__ */