Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtktreemodelfilter.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkTreeModelFilter
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A GtkTreeModel which hides parts of an underlying tree model
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 A #GtkTreeModelFilter is a tree model which wraps another tree model,
  10 and can do the following things:
  11 <itemizedlist>
  12 <listitem><para>
  13 Filter specific rows, based on data from a "visible column", a column
  14 storing booleans indicating whether the row should be filtered or not,
  15 or based on the return value of a "visible function", which gets a
  16 model, iter and user_data and returns a boolean indicating whether the
  17 row should be filtered or not.
  18 </para></listitem>
  19 <listitem><para>
  20 Modify the "appearance" of the model, using a modify function.
  21 This is extremely powerful and allows for just changing
  22 some values and also for creating a completely different model based on
  23 the given child model.
  24 </para></listitem>
  25 <listitem><para>
  26 Set a different root node, also known as a "virtual root". You can pass in
  27 a #GtkTreePath indicating the root node for the filter at construction time.
  28 </para></listitem>
  29 </itemizedlist>
  30 </para>
  31
  32 <!-- ##### SECTION See_Also ##### -->
  33 <para>
  34 #GtkTreeModelSort
  35 </para>
  36
  37 <!-- ##### STRUCT GtkTreeModelFilter ##### -->
  38 <para>
  39 The GtkTreeModelFilter struct contains only private fields.
  40 </para>
  41
  42
  43 <!-- ##### ARG GtkTreeModelFilter:child-model ##### -->
  44 <para>
  45
  46 </para>
  47
  48 <!-- ##### ARG GtkTreeModelFilter:virtual-root ##### -->
  49 <para>
  50
  51 </para>
  52
  53 <!-- ##### USER_FUNCTION GtkTreeModelFilterVisibleFunc ##### -->
  54 <para>
  55 A function which decides whether the row indicated by @iter is visible.
  56 </para>
  57
  58 @model: the #GtkTreeModelFilter
  59 @iter: a #GtkTreeIter pointing to the row whose visibility is determined
  60 @data: user data given to gtk_tree_model_filter_set_visible_func()
  61 @Returns: Whether the row indicated by @iter is visible.
  62
  63
  64 <!-- ##### USER_FUNCTION GtkTreeModelFilterModifyFunc ##### -->
  65 <para>
  66 A function which calculates display values from raw values in the model.
  67 It must fill @value with the display value for the column @column in the
  68 row indicated by @iter.
  69 </para>
  70
  71 @model: the #GtkTreeModelFilter
  72 @iter: a #GtkTreeIter pointing to the row whose display values are determined
  73 @value: A #GValue which is already initialized for with the correct type for
  74   the column @column.
  75 @column: the column whose display value is determined
  76 @data: user data given to gtk_tree_model_filter_set_modify_func()
  77
  78
  79 <!-- ##### FUNCTION gtk_tree_model_filter_new ##### -->
  80 <para>
  81
  82 </para>
  83
  84 @child_model:
  85 @root:
  86 @Returns:
  87
  88
  89 <!-- ##### FUNCTION gtk_tree_model_filter_set_visible_func ##### -->
  90 <para>
  91
  92 </para>
  93
  94 @filter:
  95 @func:
  96 @data:
  97 @destroy:
  98
  99
 100 <!-- ##### FUNCTION gtk_tree_model_filter_set_modify_func ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @filter:
 106 @n_columns:
 107 @types:
 108 @func:
 109 @data:
 110 @destroy:
 111
 112
 113 <!-- ##### FUNCTION gtk_tree_model_filter_set_visible_column ##### -->
 114 <para>
 115
 116 </para>
 117
 118 @filter:
 119 @column:
 120
 121
 122 <!-- ##### FUNCTION gtk_tree_model_filter_get_model ##### -->
 123 <para>
 124
 125 </para>
 126
 127 @filter:
 128 @Returns:
 129
 130
 131 <!-- ##### FUNCTION gtk_tree_model_filter_convert_child_iter_to_iter ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @filter:
 137 @filter_iter:
 138 @child_iter:
 139
 140
 141 <!-- ##### FUNCTION gtk_tree_model_filter_convert_iter_to_child_iter ##### -->
 142 <para>
 143
 144 </para>
 145
 146 @filter:
 147 @child_iter:
 148 @filter_iter:
 149
 150
 151 <!-- ##### FUNCTION gtk_tree_model_filter_convert_child_path_to_path ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @filter:
 157 @child_path:
 158 @Returns:
 159
 160
 161 <!-- ##### FUNCTION gtk_tree_model_filter_convert_path_to_child_path ##### -->
 162 <para>
 163
 164 </para>
 165
 166 @filter:
 167 @filter_path:
 168 @Returns:
 169 <!-- # Unused Parameters # -->
 170 @path:
 171
 172
 173 <!-- ##### FUNCTION gtk_tree_model_filter_refilter ##### -->
 174 <para>
 175
 176 </para>
 177
 178 @filter:
 179
 180
 181 <!-- ##### FUNCTION gtk_tree_model_filter_clear_cache ##### -->
 182 <para>
 183
 184 </para>
 185
 186 @filter:
 187
 188