GtkTreeModel

GtkTreeModelForeachFunc ()

gboolean
(*GtkTreeModelForeachFunc) (GtkTreeModel *model,
                            GtkTreePath *path,
                            GtkTreeIter *iter,
                            gpointer data);

Тип обратного вызова, передаваемого в gtk_tree_model_foreach() для итерации по строкам в модели дерева.

gtk_tree_path_new ()

GtkTreePath *
gtk_tree_path_new (void);

Создаёт новый GtkTreePath. Он ссылается на строку.

gtk_tree_path_new_from_string ()

GtkTreePath *
gtk_tree_path_new_from_string (const gchar *path);

Создаёт новый GtkTreePath, инициализированный значением path.

path ожидается как список чисел, разделённых двоеточиями. Например, строка “10:4:0” создаст путь глубиной 3, указывающий на 11-го потомка корневого узла, 5-го потомка этого 11-го потомка и 1-го потомка этого 5-го потомка. Если передана неверная строка пути, возвращается NULL.

gtk_tree_path_new_from_indices ()

GtkTreePath *
gtk_tree_path_new_from_indices (gint first_index,
                                ...);

Создаёт новый путь с first_index и varargs в качестве индексов.

С: 2.2

gtk_tree_path_new_from_indicesv ()

GtkTreePath *
gtk_tree_path_new_from_indicesv (gint *indices,
                                 gsize length);

Создаёт новый путь с заданным массивом indices индексов length.

[rename-to gtk_tree_path_new_from_indices]

С: 3.12

gtk_tree_path_to_string ()

gchar *
gtk_tree_path_to_string (GtkTreePath *path);

Генерирует строковое представление пути.

Эта строка — это список чисел, разделённых двоеточием. Например, “4:10:0:3” — это допустимое значение для этой строки.

gtk_tree_path_new_first ()

GtkTreePath *
gtk_tree_path_new_first (void);

Создаёт новый GtkTreePath.

Строковое представление этого пути — “0”.

gtk_tree_path_append_index ()

void
gtk_tree_path_append_index (GtkTreePath *path,
                            gint index_);

Добавляет новый индекс к пути.

В результате глубина пути увеличивается.

gtk_tree_path_prepend_index ()

void
gtk_tree_path_prepend_index (GtkTreePath *path,
                             gint index_);

Добавляет новый индекс в начало пути.

В результате глубина пути увеличивается.

gtk_tree_path_get_depth ()

gint
gtk_tree_path_get_depth (GtkTreePath *path);

Возвращает текущую глубину path.

gtk_tree_path_get_indices ()

gint *
gtk_tree_path_get_indices (GtkTreePath *path);

Возвращает текущие индексы path.

Это массив целых чисел, каждый из которых представляет узел в дереве. Это значение не должно освобождаться.

Длина массива может быть получена с помощью gtk_tree_path_get_depth().

[skip]

gtk_tree_path_get_indices_with_depth ()

gint *
gtk_tree_path_get_indices_with_depth (GtkTreePath *path,
                                      gint *depth);

Возвращает текущие индексы path.

Это массив целых чисел, каждый из которых представляет узел в дереве. Он также возвращает количество элементов в массиве. Массив не должен освобождаться.

[rename-to gtk_tree_path_get_indices]

С версии: 3.0

gtk_tree_path_free ()

void
gtk_tree_path_free (GtkTreePath *path);

Освобождает path. Если path равно NULL, он просто возвращается.

gtk_tree_path_copy ()

GtkTreePath *
gtk_tree_path_copy (const GtkTreePath *path);

Создает новый GtkTreePath как копию path.

gtk_tree_path_compare ()

gint
gtk_tree_path_compare (const GtkTreePath *a,
                       const GtkTreePath *b);

Сравнивает два пути.

Если a предшествует b в дереве, то возвращается -1. Если b предшествует a, то возвращается 1. Если два узла равны, то возвращается 0.

gtk_tree_path_next ()

void
gtk_tree_path_next (GtkTreePath *path);

Перемещает path для указания на следующий узел на текущей глубине.

gtk_tree_path_prev ()

gboolean
gtk_tree_path_prev (GtkTreePath *path);

Перемещает path для указания на предыдущий узел на текущей глубине, если он существует.

gtk_tree_path_up ()

gboolean
gtk_tree_path_up (GtkTreePath *path);

Перемещает path для указания на его родительский узел, если у него есть родитель.

gtk_tree_path_down ()

void
gtk_tree_path_down (GtkTreePath *path);

Перемещает path для указания на первого потомка текущего пути.

gtk_tree_path_is_ancestor ()

gboolean
gtk_tree_path_is_ancestor (GtkTreePath *path,
                           GtkTreePath *descendant);

Возвращает TRUE если descendant является потомком path.

gtk_tree_path_is_descendant ()

gboolean
gtk_tree_path_is_descendant (GtkTreePath *path,
                             GtkTreePath *ancestor);

Возвращает TRUE если path является потомком ancestor.

gtk_tree_row_reference_new ()

GtkTreeRowReference *
gtk_tree_row_reference_new (GtkTreeModel *model,
                            GtkTreePath *path);

Создаёт ссылку на строку, основанную на path.

Эта ссылка будет продолжать указывать на узел, на который указывает path, до тех пор, пока он существует. Любые изменения, происходящие в model, будут переданы, а путь будет обновлён соответствующим образом. Если path не является допустимым путём в model, то возвращается NULL.

gtk_tree_row_reference_new_proxy ()

GtkTreeRowReference *
gtk_tree_row_reference_new_proxy (GObject *proxy,
                                  GtkTreeModel *model,
                                  GtkTreePath *path);

Вам не нужно использовать эту функцию.

Создаёт ссылку на строку, основанную на path.

Эта ссылка будет продолжать указывать на узел, на который указывает path, до тех пор, пока он существует. Если path не является допустимым путём в model, то возвращается NULL. Однако, в отличие от ссылок, созданных с помощью gtk_tree_row_reference_new(), она не отслеживает изменения в модели. Создатель ссылки на строку должен сделать это явно, используя gtk_tree_row_reference_inserted(), gtk_tree_row_reference_deleted(), gtk_tree_row_reference_reordered().

Эти функции должны вызываться ровно один раз на каждую прокси при выводе соответствующего сигнала модели. Это единственный вызов обновляет все ссылки на строки для этой прокси. Поскольку встроенные объекты GTK+, такие как GtkTreeView, уже используют этот механизм внутри, использование их в качестве объекта-прокси приведёт к непредсказуемым результатам. Кроме того, передача одного и того же объекта как model и proxy не работает по причинам внутренней реализации.

Этот тип ссылки на строку предназначен в первую очередь для структур, которым необходимо тщательно отслеживать, когда ссылка на строку обновляет себя, и обычно не требуется большинству приложений.

gtk_tree_row_reference_get_model ()

GtkTreeModel *
gtk_tree_row_reference_get_model (GtkTreeRowReference *reference);

Возвращает модель, которую отслеживает ссылка на строку.

С: 2.8

gtk_tree_row_reference_get_path ()

GtkTreePath *
gtk_tree_row_reference_get_path (GtkTreeRowReference *reference);

Возвращает текущий путь, на который указывает ссылка на строку, или NULL, если путь, на который она указывает, больше недействителен.

gtk_tree-row-reference-valid ()

gboolean
gtk_tree_row_reference_valid (GtkTreeRowReference *reference);

Возвращает TRUE, если reference не NULL и ссылается на текущий действительный путь.

gtk_tree_row_reference_free ()

void
gtk_tree_row_reference_free (GtkTreeRowReference *reference);

Освобождает reference. reference может быть NULL

gtk_tree_row_reference_copy ()

GtkTreeRowReference *
gtk_tree_row_reference_copy (GtkTreeRowReference *reference);

Копирует GtkTreeRowReference.

С: 2.2

gtk_tree_row_reference_inserted ()

void
gtk_tree_row_reference_inserted (GObject *proxy,
                                 GtkTreePath *path);

Позволяет набору ссылок на строки, созданных с помощью gtk_tree_row_reference_new_proxy(), узнать, что модель вывела сигнал “row-inserted”.

gtk_tree_row_reference_deleted ()

void
gtk_tree_row_reference_deleted (GObject *proxy,
                                GtkTreePath *path);

Сообщает набору ссылок на строки, созданных с помощью gtk_tree_row_reference_new_proxy(), что модель излучила сигнал “row-deleted”.

gtk_tree_row_reference_reordered ()

void
gtk_tree_row_reference_reordered (GObject *proxy,
                                  GtkTreePath *path,
                                  GtkTreeIter *iter,
                                  gint *new_order);

Сообщает набору ссылок на строки, созданных с помощью gtk_tree_row_reference_new_proxy(), что модель излучила сигнал “rows-reordered”.

[skip]

gtk_tree_iter_copy ()

GtkTreeIter *
gtk_tree_iter_copy (GtkTreeIter *iter);

Создаёт динамически выделенный итератор дерева как копию iter .

Эта функция не предназначена для использования в приложениях, так как вы можете просто скопировать структуры по значению (GtkTreeIter new_iter = iter;). Вы должны освободить этот итератор с помощью gtk_tree_iter_free().

gtk_tree_iter_free ()

void
gtk_tree_iter_free (GtkTreeIter *iter);

Освобождает итератор, выделенный с помощью gtk_tree_iter_copy().

Эта функция в основном используется для языковых библиотек.

gtk_tree_model_get_flags ()

GtkTreeModelFlags
gtk_tree_model_get_flags (GtkTreeModel *tree_model);

Возвращает набор флагов, поддерживаемых этим интерфейсом.

Флаги представляют собой битовую комбинацию GtkTreeModelFlags. Поддерживаемые флаги не должны изменяться в течение всего жизненного цикла tree_model .

gtk_tree_model_get_n_columns ()

gint
gtk_tree_model_get_n_columns (GtkTreeModel *tree_model);

Возвращает количество столбцов, поддерживаемых tree_model .

gtk_tree_model_get_column_type ()

GType
gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
                                gint index_);

Возвращает тип столбца.

gtk_tree_model_get_iter ()

gboolean
gtk_tree_model_get_iter (GtkTreeModel *tree_model,
                         GtkTreeIter *iter,
                         GtkTreePath *path);

Устанавливает iter на корректный итератор, указывающий на path . Если path не существует, iter устанавливается на некорректный итератор и возвращается FALSE.

gtk_tree_model_get_iter_from_string ()

gboolean
gtk_tree_model_get_iter_from_string (GtkTreeModel *tree_model,
                                     GtkTreeIter *iter,
                                     const gchar *path_string);

Устанавливает iter на корректный итератор, указывающий на path_string , если он существует. В противном случае, iter остаётся некорректным и возвращается FALSE.

gtk_tree_model_get_iter_first ()

gboolean
gtk_tree_model_get_iter_first (GtkTreeModel *tree_model,
                               GtkTreeIter *iter);

Инициализирует iter первым итератором в дереве (тем, у которого путь "0") и возвращает TRUE. Возвращает FALSE, если дерево пусто.

gtk_tree_model_get_path ()

GtkTreePath *
gtk_tree_model_get_path (GtkTreeModel *tree_model,
                         GtkTreeIter *iter);

Возвращает новый GtkTreePath, на который ссылается iter.

Этот путь следует освободить с помощью gtk_tree_path_free().

gtk_tree_model_get_value ()

void
gtk_tree_model_get_value (GtkTreeModel *tree_model,
                          GtkTreeIter *iter,
                          gint column,
                          GValue *value);

Инициализирует и устанавливает value на значение из column.

После завершения работы с value, необходимо вызвать g_value_unset() для освобождения выделенной памяти.

gtk_tree_model_iter_next ()

gboolean
gtk_tree_model_iter_next (GtkTreeModel *tree_model,
                          GtkTreeIter *iter);

Устанавливает iter на следующий узел на текущем уровне.

Если следующего iter нет, возвращается FALSE, и iter становится недействительным.

gtk_tree_model_iter_previous ()

gboolean
gtk_tree_model_iter_previous (GtkTreeModel *tree_model,
                              GtkTreeIter *iter);

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

Если предыдущего iter нет, возвращается FALSE, и iter становится недействительным.

С: 3.0

gtk_tree_model_iter_children ()

gboolean
gtk_tree_model_iter_children (GtkTreeModel *tree_model,
                              GtkTreeIter *iter,
                              GtkTreeIter *parent);

Устанавливает iter на первого потомка parent.

Если у parent нет потомков, возвращается FALSE, и iter становится недействительным. parent останется действительным узлом после вызова этой функции.

Если parent равен NULL, возвращается первый узел, эквивалентно gtk_tree_model_get_iter_first (tree_model, iter);

gtk_tree_model_iter_has_child ()

gboolean
gtk_tree_model_iter_has_child (GtkTreeModel *tree_model,
                               GtkTreeIter *iter);

Возвращает TRUE, если у iter есть дочерние элементы, и FALSE в противном случае.

gtk_tree_model_iter_n_children ()

gint
gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
                                GtkTreeIter *iter);

Возвращает количество дочерних элементов у iter.

В качестве специального случая, если iter равно NULL, возвращается количество корневых узлов.

gtk_tree_model_iter_nth_child ()

gboolean
gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model,
                               GtkTreeIter *iter,
                               GtkTreeIter *parent,
                               gint n);

Устанавливает iter в качестве дочернего элемента parent, используя указанный индекс.

Первый индекс — 0. Если n слишком большой или у parent нет дочерних элементов, iter устанавливается в невалидный итератор, а возвращается FALSE. parent останется валидным узлом после вызова этой функции. В качестве специального случая, если parent равно NULL, устанавливается n-й корневой узел.

gtk_tree_model_iter_parent ()

gboolean
gtk_tree_model_iter_parent (GtkTreeModel *tree_model,
                            GtkTreeIter *iter,
                            GtkTreeIter *child);

Устанавливает iter в качестве родительского элемента child.

Если child находится на верхнем уровне и у него нет родителя, iter устанавливается в невалидный итератор, а возвращается FALSE. child останется валидным узлом после вызова этой функции.

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

gtk_tree_model_get_string_from_iter ()

gchar *
gtk_tree_model_get_string_from_iter (GtkTreeModel *tree_model,
                                     GtkTreeIter *iter);

Генерирует строковое представление итератора.

Эта строка — список чисел, разделённых двоеточием. Например, «4:10:0:3» — допустимое значение для этой строки.

Since: 2.2

gtk_tree_model_ref_node ()

void
gtk_tree_model_ref_node (GtkTreeModel *tree_model,
                         GtkTreeIter *iter);

Позволяет дереву сохранить ссылку на узел.

Это необязательный метод для моделей. Модели могут игнорировать этот вызов, так как он существует в первую очередь для повышения производительности.

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

Модель должна иметь возможность получать итератор независимо от своего состояния сохранения ссылки.

gtk_tree_model_unref_node ()

void
gtk_tree_model_unref_node (GtkTreeModel *tree_model,
                           GtkTreeIter *iter);

Разрешает дереву удалить ссылку на узел.

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

Обратите внимание, что удаленные узлы не освобождаются от ссылок.

gtk_tree_model_get ()

void
gtk_tree_model_get (GtkTreeModel *tree_model,
                    GtkTreeIter *iter,
                    ...);

Получает значение одной или нескольких ячеек в строке, на которую ссылается iter. Список аргументов должен содержать целочисленные номера столбцов, каждый номер столбца должен следовать за местом для хранения получаемого значения. Список завершается -1. Например, чтобы получить значение из столбца 0 с типом G_TYPE_STRING, вы бы написали: gtk_tree_model_get (model, iter, 0, &place_string_here, -1), где place_string_here является gchararray, который будет заполнен строкой.

Возвращаемые значения с типом G_TYPE_OBJECT должны быть освобождены от ссылок, значения с типом G_TYPE_STRING или G_TYPE_BOXED должны быть освобождены. Другие значения передаются по значению.

gtk_tree_model_get_valist ()

void
gtk_tree_model_get_valist (GtkTreeModel *tree_model,
                           GtkTreeIter *iter,
                           va_list var_args);

См. gtk_tree_model_get(), этот вариант принимает va_list для использования языковыми связующими.

gtk_tree_model_foreach ()

void
gtk_tree_model_foreach (GtkTreeModel *model,
                        GtkTreeModelForeachFunc func,
                        gpointer user_data);

Вызывает func для каждого узла в модели в порядке обхода в глубину.

Если func возвращает TRUE, то обход дерева прекращается, и gtk_tree_model_foreach() возвращается.

gtk_tree_model_row_changed ()

void
gtk_tree_model_row_changed (GtkTreeModel *tree_model,
                            GtkTreePath *path,
                            GtkTreeIter *iter);

Отправляет сигнал “row-changed” на tree_model.

gtk_tree_model_row_inserted ()

void
gtk_tree_model_row_inserted (GtkTreeModel *tree_model,
                             GtkTreePath *path,
                             GtkTreeIter *iter);

Отправляет сигнал “row-inserted” на tree_model .

gtk_tree_model_row_has_child_toggled ()

void
gtk_tree_model_row_has_child_toggled (GtkTreeModel *tree_model,
                                      GtkTreePath *path,
                                      GtkTreeIter *iter);

Отправляет сигнал “row-has-child-toggled” на tree_model. Этот метод должен вызываться моделями после изменения состояния дочерних элементов узла.

gtk_tree_model_row_deleted ()

void
gtk_tree_model_row_deleted (GtkTreeModel *tree_model,
                            GtkTreePath *path);

Отправляет сигнал “row-deleted” на tree_model.

Этот метод должен вызываться моделями после удаления строки. Место, на которое указывает path, должно быть местом, где ранее находилась строка. Оно может больше не быть действительным.

Удаленные узлы не освобождаются от ссылок, это означает, что все активные ссылки на удаленный узел не должны быть освобождены.

gtk_tree_model_rows_reordered ()

void
gtk_tree_model_rows_reordered (GtkTreeModel *tree_model,
                               GtkTreePath *path,
                               GtkTreeIter *iter,
                               gint *new_order);

Вызывает сигнал “rows-reordered” для tree_model.

Этот метод следует вызывать моделям, когда их строки были переупорядочены.

[skip]

gtk_tree_model_rows_reordered_with_length ()

void
gtk_tree_model_rows_reordered_with_length
                               (GtkTreeModel *tree_model,
                                GtkTreePath *path,
                                GtkTreeIter *iter,
                                gint *new_order,
                                gint length);

Вызывает сигнал “rows-reordered” для tree_model.

Этот метод следует вызывать моделям, когда их строки были переупорядочены.

[rename-to gtk_tree_model_rows_reordered]

С: 3.10