GtkTreeModelFilter

GtkTreeModelFilterVisibleFunc ()

gboolean
(*GtkTreeModelFilterVisibleFunc) (GtkTreeModel *model,
                                  GtkTreeIter *iter,
                                  gpointer data);

Функция, определяющая, видна ли строка, указанная параметром iter.

GtkTreeModelFilterModifyFunc ()

void
(*GtkTreeModelFilterModifyFunc) (GtkTreeModel *model,
                                 GtkTreeIter *iter,
                                 GValue *value,
                                 int column,
                                 gpointer data);

Функция, рассчитывающая значения отображения из исходных значений в модели. Она должна заполнить value значением отображения для столбца column в строке, указанной параметром iter.

Поскольку эта функция вызывается для каждого доступа к данным, это не особенно эффективный процесс.

gtk_tree_model_filter_new ()

GtkTreeModel *
gtk_tree_model_filter_new (GtkTreeModel *child_model,
                           GtkTreePath *root);

Создает новую GtkTreeModel, с child_model в качестве child_model и root в качестве виртуальной корневой строки.

gtk_tree_model_filter_set_visible_func ()

void
gtk_tree_model_filter_set_visible_func
                               (GtkTreeModelFilter *filter,
                                GtkTreeModelFilterVisibleFunc func,
                                gpointer data,
                                GDestroyNotify destroy);

Устанавливает функцию видимости, используемую при фильтрации filter, на func. Функция должна возвращать TRUE, если строка должна быть видимой, и FALSE в противном случае.

Если условие, вычисленное функцией, изменяется со временем (например, потому что оно зависит от глобальных параметров), необходимо вызвать gtk_tree_model_filter_refilter(), чтобы сохранить актуальность информации о видимости модели.

Обратите внимание, что func вызывается при каждом вставлении строки, когда она может быть еще пустой. Следовательно, функция видимости должна обрабатывать пустые строки с особой осторожностью, как в примере ниже.

static gboolean
visible_func (GtkTreeModel *model,
              GtkTreeIter  *iter,
              gpointer      data)
{
  // Visible if row is non-empty and first column is “HI”
  char *str;
  gboolean visible = FALSE;

  gtk_tree_model_get (model, iter, 0, &str, -1);
  if (str && strcmp (str, "HI") == 0)
    visible = TRUE;
  g_free (str);

  return visible;
}

Обратите внимание, что gtk_tree_model_filter_set_visible_func() или gtk_tree_model_filter_set_visible_column() могут быть вызваны только один раз для данной модели фильтра.

gtk_tree_model_filter_set_modify_func ()

void
gtk_tree_model_filter_set_modify_func (GtkTreeModelFilter *filter,
                                       int n_columns,
                                       GType *types,
                                       GtkTreeModelFilterModifyFunc func,
                                       gpointer data,
                                       GDestroyNotify destroy);

С помощью параметров n_columns и types вы задаете массив типов столбцов для этой модели (которые будут доступны родительской модели/представлению). Параметры func, data и destroy задают функцию модификации. Функция модификации будет вызываться при каждом доступе к данным, ее цель — возвращать данные, которые должны отображаться в указанном месте с использованием параметров функции модификации.

Обратите внимание, что gtk_tree_model_filter_set_modify_func() может быть вызвана только один раз для данной модели фильтра.

gtk_tree_model_filter_set_visible_column ()

void
gtk_tree_model_filter_set_visible_column
                               (GtkTreeModelFilter *filter,
                                int column);

Устанавливает column дочернего модели, в столбце, где filter должен искать информацию о видимости. columns должен быть столбцом типа G_TYPE_BOOLEAN, где TRUE означает, что строка видима, а FALSE - если нет.

Обратите внимание, что gtk_tree_model_filter_set_visible_func() или gtk_tree_model_filter_set_visible_column() могут быть вызваны только один раз для заданной модели фильтра.

gtk_tree_model_filter_get_model ()

GtkTreeModel *
gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter);

Возвращает указатель на дочернюю модель filter.

gtk_tree_model_filter_convert_child_iter_to_iter ()

gboolean
gtk_tree_model_filter_convert_child_iter_to_iter
                               (GtkTreeModelFilter *filter,
                                GtkTreeIter *filter_iter,
                                GtkTreeIter *child_iter);

Устанавливает filter_iter, чтобы указать на строку в filter, которая соответствует строке, на которую указывает child_iter . Если filter_iter не был установлен, возвращается FALSE.

gtk_tree_model_filter_convert_iter_to_child_iter ()

void
gtk_tree_model_filter_convert_iter_to_child_iter
                               (GtkTreeModelFilter *filter,
                                GtkTreeIter *child_iter,
                                GtkTreeIter *filter_iter);

Устанавливает child_iter, чтобы указать на строку, на которую указывает filter_iter.

gtk_tree_model_filter_convert_child_path_to_path ()

GtkTreePath *
gtk_tree_model_filter_convert_child_path_to_path
                               (GtkTreeModelFilter *filter,
                                GtkTreePath *child_path);

Преобразует child_path в путь, относящийся к filter. То есть, child_path указывает на путь в дочерней модели. Возвращаемый путь будет указывать на ту же строку в отфильтрованной модели. Если child_path не является допустимым путем в дочерней модели или указывает на строку, которая не видна в filter, возвращается NULL.

gtk_tree_model_filter_convert_path_to_child_path ()

GtkTreePath *
gtk_tree_model_filter_convert_path_to_child_path
                               (GtkTreeModelFilter *filter,
                                GtkTreePath *filter_path);

Преобразует filter_path в путь в дочерней модели filter. То есть, filter_path указывает на расположение в filter. Возвращаемый путь будет указывать на то же место в модели, не подвергавшейся фильтрации. Если filter_path не указывает на расположение в дочерней модели, возвращается NULL.

gtk_tree_model_filter_refilter ()

void
gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter);

Вызывает ::row_changed для каждой строки в дочерней модели, что заставляет фильтр повторно оценивать, видима ли та или иная строка.

gtk_tree_model_filter_clear_cache ()

void
gtk_tree_model_filter_clear_cache (GtkTreeModelFilter *filter);

Функцию почти никогда не следует вызывать. Она очищает filter любых кэшированных итераторов, которые не были переназначены с помощью gtk_tree_model_ref_node(). Это может быть полезно, если дочерняя модель, которая фильтруется, является статической (и не часто изменяется), и было много непереназначенных обращений к узлам. Побочным эффектом этой функции является то, что все непереназначенные итераторы станут недействительными.