Wiki
Задать вопрос на форуме...

prev

up

home

gtk+ reference manual

next

top  |  description  |  object hierarchy  |  implemented interfaces  |  properties

gtktreemodelfilter

gtktreemodelfilter — gtktreemodel который скрывает части основной модели дерева

краткое описание

#include <gtk/gtk.h>

            gtktreemodelfilter;
gboolean    (*gtktreemodelfiltervisiblefunc)
                                            (gtktreemodel *model,
                                             gtktreeiter *iter,
                                             gpointer data);
void        (*gtktreemodelfiltermodifyfunc) (gtktreemodel *model,
                                             gtktreeiter *iter,
                                             gvalue *value,
                                             gint column,
                                             gpointer data);

gtktreemodel* gtk_tree_model_filter_new     (gtktreemodel *child_model,
                                             gtktreepath *root);
void        gtk_tree_model_filter_set_visible_func
                                            (gtktreemodelfilter *filter,
                                             gtktreemodelfiltervisiblefunc func,
                                             gpointer data,
                                             gtkdestroynotify destroy);
void        gtk_tree_model_filter_set_modify_func

                                            (gtktreemodelfilter *filter,
                                             gint n_columns,
                                             gtype *types,
                                             gtktreemodelfiltermodifyfunc func,
                                             gpointer data,
                                             gtkdestroynotify destroy);
void        gtk_tree_model_filter_set_visible_column

                                            (gtktreemodelfilter *filter,
                                             gint column);
gtktreemodel* gtk_tree_model_filter_get_model
                                            (gtktreemodelfilter *filter);

gboolean    gtk_tree_model_filter_convert_child_iter_to_iter
                                            (gtktreemodelfilter *filter,
                                             gtktreeiter *filter_iter,
                                             gtktreeiter *child_iter);
void        gtk_tree_model_filter_convert_iter_to_child_iter

                                            (gtktreemodelfilter *filter,
                                             gtktreeiter *child_iter,
                                             gtktreeiter *filter_iter);
gtktreepath* gtk_tree_model_filter_convert_child_path_to_path
                                            (gtktreemodelfilter *filter,
                                             gtktreepath *child_path);

gtktreepath* gtk_tree_model_filter_convert_path_to_child_path
                                            (gtktreemodelfilter *filter,
                                             gtktreepath *filter_path);
void        gtk_tree_model_filter_refilter  (gtktreemodelfilter *filter);
void        gtk_tree_model_filter_clear_cache

                                            (gtktreemodelfilter *filter);

иерархия объектов

  gobject
   +----gtktreemodelfilter

осуществляемые интерфейсы

gtktreemodelfilter осуществляет gtktreemodel и gtktreedragsource.

свойства

  "child-model"          gtktreemodel          : read / write / construct only
  "virtual-root"         gtktreepath           : read / write / construct only

описание

gtktreemodelfilter это модель дерева которая является оболочкой для другой модели дерева и может выполнять следующее:

  • фильтровать определённые строки, основываясь на данных из "visible column", столбец хранящий логическое значение указывающее должны ли строки фильтроваться или нет, или основываясь на возвращаемом значении "visible function", которая получает модель, итератор, user_data и возвращает логическое значение должны ли строки фильтроваться или нет.

  • изменять "внешность" модели, используя модифицирующую функцию. это черезвычайно действенно и позволяет просто изменять некоторые значения, а так же создавать полностью разные модели основываясь на полученной дочерней модели.

  • устанавливать разные корневые узлы, также известные как "virtual root". вы можете передать в gtktreepath указатель корневого узла для фильтрации во время конструирования.

детали

gtktreemodelfilter

typedef struct _gtktreemodelfilter gtktreemodelfilter;

структура gtktreemodelfilter содержит только закрытые поля.

gtktreemodelfiltervisiblefunc ()

gboolean    (*gtktreemodelfiltervisiblefunc)
                                            (gtktreemodel *model,
                                             gtktreeiter *iter,
                                             gpointer data);

функция которая решает видима ли строка указанная iter.

model :

дочерняя модель gtktreemodelfilter

iter :

gtktreeiter указывающий на строку в model для определения видимости

data :

пользовательские данные для gtk_tree_model_filter_set_visible_func()

возвращает :

видима ли строка указанная параметром iter.

gtktreemodelfiltermodifyfunc ()

void        (*gtktreemodelfiltermodifyfunc) (gtktreemodel *model,
                                             gtktreeiter *iter,
                                             gvalue *value,
                                             gint column,
                                             gpointer data);

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

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

model :

gtktreemodelfilter

iter :

gtktreeiter указывающий на строку которая определяет отображаемое значение

value :

gvalue инициализированный правильным типом для столбца column.

column :

столбец определяющий отображаемое значение

data :

пользовательские данные для gtk_tree_model_filter_set_modify_func()

gtk_tree_model_filter_new ()

gtktreemodel* gtk_tree_model_filter_new     (gtktreemodel *child_model,
                                             gtktreepath *root);

создаёт новый gtktreemodel, с child_model как дочерней моделью и root как виртуальный корень.

child_model :

gtktreemodel.

root :

gtktreepath или null.

возвращает :

новый gtktreemodel.

начиная с версии 2.4

gtk_tree_model_filter_set_visible_func ()

void        gtk_tree_model_filter_set_visible_func
                                            (gtktreemodelfilter *filter,
                                             gtktreemodelfiltervisiblefunc func,
                                             gpointer data,
                                             gtkdestroynotify destroy);

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

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

filter :

gtktreemodelfilter.

func :

gtktreemodelfiltervisiblefunc, функция видимости.

data :

пользовательские данные помещаемые в функцию видимости, или null.

destroy :

разрушающее уведомление data, или null.

начиная с версии 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,
                                             gtkdestroynotify destroy);

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

filter :

gtktreemodelfilter.

n_columns :

количество столбцов в фильтруемой модели.

types :

gtypes столбцов.

func :

gtktreemodelfiltermodifyfunc

data :

пользовательские данные помещаемые в модифицирующую функцию, или null.

destroy :

разрушающее уведомление data, или null.

начиная с версии 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 нет.

filter :

gtktreemodelfilter.

column :

gint который обозначает столбец содержащий информацию видимости.

начиная с версии 2.4

gtk_tree_model_filter_get_model ()

gtktreemodel* gtk_tree_model_filter_get_model
                                            (gtktreemodelfilter *filter);

возвращает указатель для дочерней модели filter.

filter :

gtktreemodelfilter.

возвращает :

указатель для gtktreemodel.

начиная с версии 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.

filter :

gtktreemodelfilter.

filter_iter :

неинициализированный gtktreeiter.

child_iter :

допустимый gtktreeiter указывающий строку в дочерней модели.

возвращает :

true, если filter_iter был установлен, то есть если child_iter доступный итератор указывающий видимую строку в дочерней модели.

начиная с версии 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.

filter :

gtktreemodelfilter.

child_iter :

неинициализированный gtktreeiter.

filter_iter :

доступный gtktreeiter указывающий строку в filter.

начиная с версии 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.

filter :

gtktreemodelfilter.

child_path :

gtktreepath для преобразования.

возвращает :

вновь распределённый gtktreepath, или 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.

filter :

gtktreemodelfilter.

filter_path :

gtktreepath для преобразования.

возвращает :

вновь распределенный gtktreepath, или null.

начиная с версии 2.4

gtk_tree_model_filter_refilter ()

void        gtk_tree_model_filter_refilter  (gtktreemodelfilter *filter);

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

filter :

gtktreemodelfilter.

начиная с версии 2.4

gtk_tree_model_filter_clear_cache ()

void        gtk_tree_model_filter_clear_cache
                                            (gtktreemodelfilter *filter);

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

filter :

gtktreemodelfilter.

начиная с версии 2.4

детали свойств

свойство "child-model"

  "child-model"          gtktreemodel          : read / write / construct only

модель для фильтрации.

свойство "virtual-root"

  "virtual-root"         gtktreepath           : read / write / construct only

виртуальный корень (относительно дочерней модели) для этой фильтруемой модели.

смотрите также

gtktreemodelsort