GtkTreeModelFilter

GtkTreeModelFilterVisibleFunc ()

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

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

GtkTreeModelFilterModifyFunc ()

void
(*GtkTreeModelFilterModifyFunc) (GtkTreeModel *model,
                                 GtkTreeIter *iter,
                                 GValue *value,
                                 gint 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 в качестве виртуального корня.

С: 2.4

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”
  gchar *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() могут быть вызваны только один раз для заданной модели фильтра.

С: 2.4

gtk_tree_model_filter_set_modify_func ()

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

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

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

С: 2.4

gtk_tree_model_filter_set_visible_column ()

void
gtk_tree_model_filter_set_visible_column
                               (GtkTreeModelFilter *filter,
                                gint column);

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

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

С: 2.4

gtk_tree_model_filter_get_model ()

GtkTreeModel *
gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter);

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

С: 2.4

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.

С: 2.4

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.

С: 2.4

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.

С версии: 2.4

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.

С версии: 2.4

gtk_tree_model_filter_refilter ()

void
gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter);

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

С версии: 2.4

gtk_tree_model_filter_clear_cache ()

void
gtk_tree_model_filter_clear_cache (GtkTreeModelFilter *filter);

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

С версии: 2.4