libegg/treeviewutils/eggtreemodelfilter.h

   1 /* eggtreemodelfilter.h
   2  * Copyright (C) 2000,2001  Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
   3  * Copyright (C) 2001,2002  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., 51 Franklin Street, Fifth Floor,
  18  * Boston, MA 02110-1301, USA.
  19  */
  20
  21 #ifndef __EGG_TREE_MODEL_FILTER_H__
  22 #define __EGG_TREE_MODEL_FILTER_H__
  23
  24 #include <gtk/gtktreemodel.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #define EGG_TYPE_TREE_MODEL_FILTER              (egg_tree_model_filter_get_type ())
  29 #define EGG_TREE_MODEL_FILTER(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), EGG_TYPE_TREE_MODEL_FILTER, EggTreeModelFilter))
  30 #define EGG_TREE_MODEL_FILTER_CLASS(vtable)     (G_TYPE_CHECK_CLASS_CAST ((vtable), EGG_TYPE_TREE_MODEL_FILTER, EggTreeModelFilterClass))
  31 #define EGG_IS_TREE_MODEL_FILTER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EGG_TYPE_TREE_MODEL_FILTER))
  32 #define EGG_IS_TREE_MODEL_FILTER_CLASS(vtable)  (G_TYPE_CHECK_CLASS_TYPE ((vtable), EGG_TYPE_TREE_MODEL_FILTER))
  33 #define EGG_TREE_MODEL_FILTER_GET_CLASS(inst)   (G_TYPE_INSTANCE_GET_CLASS ((obj), EGG_TYPE_TREE_MODEL_FILTER, EggTreeModelFilterClass))
  34
  35 typedef gboolean (* EggTreeModelFilterVisibleFunc) (GtkTreeModel *model,
  36                                                     GtkTreeIter  *iter,
  37                                                     gpointer      data);
  38 typedef void (* EggTreeModelFilterModifyFunc) (GtkTreeModel *model,
  39                                                GtkTreeIter  *iter,
  40                                                GValue       *value,
  41                                                gint          column,
  42                                                gpointer      data);
  43
  44 typedef struct _EggTreeModelFilter              EggTreeModelFilter;
  45 typedef struct _EggTreeModelFilterClass         EggTreeModelFilterClass;
  46
  47 struct _EggTreeModelFilter
  48 {
  49   GObject parent;
  50
  51   /*< private >*/
  52   gpointer root;
  53   gint stamp;
  54   guint child_flags;
  55   GtkTreeModel *child_model;
  56   gint zero_ref_count;
  57
  58   guint root_level_visible;
  59
  60   GtkTreePath *virtual_root;
  61
  62   EggTreeModelFilterVisibleFunc visible_func;
  63   gpointer visible_data;
  64   GtkDestroyNotify visible_destroy;
  65
  66   gint modify_n_columns;
  67   GType *modify_types;
  68   EggTreeModelFilterModifyFunc modify_func;
  69   gpointer modify_data;
  70   gpointer modify_destroy;
  71
  72   gint visible_column;
  73
  74   gboolean visible_method_set;
  75   gboolean modify_func_set;
  76
  77   /* signal ids */
  78   guint changed_id;
  79   guint inserted_id;
  80   guint has_child_toggled_id;
  81   guint deleted_id;
  82   guint reordered_id;
  83 };
  84
  85 struct _EggTreeModelFilterClass
  86 {
  87   GObjectClass parent_class;
  88 };
  89
  90 GType   egg_tree_model_filter_get_type                  (void);
  91 GtkTreeModel *egg_tree_model_filter_new                 (GtkTreeModel                 *child_model,
  92                                                          GtkTreePath                  *root);
  93 void    egg_tree_model_filter_set_visible_func          (EggTreeModelFilter           *filter,
  94                                                          EggTreeModelFilterVisibleFunc func,
  95                                                          gpointer                      data,
  96                                                          GtkDestroyNotify              destroy);
  97 void    egg_tree_model_filter_set_modify_func           (EggTreeModelFilter           *filter,
  98                                                          gint                          n_columns,
  99                                                          GType                        *types,
 100                                                          EggTreeModelFilterModifyFunc  func,
 101                                                          gpointer                      data,
 102                                                          GtkDestroyNotify              destroy);
 103 void    egg_tree_model_filter_set_visible_column        (EggTreeModelFilter           *filter,
 104                                                          gint                          column);
 105
 106 GtkTreeModel *egg_tree_model_filter_get_model           (EggTreeModelFilter           *filter);
 107
 108 /* conversion */
 109 void    egg_tree_model_filter_convert_child_iter_to_iter        (EggTreeModelFilter *filter,
 110                                                                  GtkTreeIter        *filter_iter,
 111                                                                  GtkTreeIter        *child_iter);
 112 void    egg_tree_model_filter_convert_iter_to_child_iter        (EggTreeModelFilter *filter,
 113                                                                  GtkTreeIter        *child_iter,
 114                                                                  GtkTreeIter        *filter_iter);
 115 GtkTreePath *egg_tree_model_filter_convert_child_path_to_path   (EggTreeModelFilter *filter,
 116                                                                  GtkTreePath        *child_path);
 117 GtkTreePath *egg_tree_model_filter_convert_path_to_child_path   (EggTreeModelFilter *path,
 118                                                                  GtkTreePath        *filter_path);
 119
 120 void    egg_tree_model_filter_refilter                  (EggTreeModelFilter           *filter);
 121 void    egg_tree_model_filter_clear_cache               (EggTreeModelFilter           *filter);
 122
 123 G_END_DECLS
 124
 125 #endif /* __EGG_TREE_MODEL_FILTER_H__ */