GtkListBox

GtkListBoxFilterFunc ()

gboolean
(*GtkListBoxFilterFunc) (GtkListBoxRow *row,
                         gpointer user_data);

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

С версии: 3.10

GtkListBoxSortFunc ()

gint
(*GtkListBoxSortFunc) (GtkListBoxRow *row1,
                       GtkListBoxRow *row2,
                       gpointer user_data);

Сравнивает две строки, чтобы определить, какая должна стоять первой.

С версии: 3.10

GtkListBoxUpdateHeaderFunc ()

void
(*GtkListBoxUpdateHeaderFunc) (GtkListBoxRow *row,
                               GtkListBoxRow *before,
                               gpointer user_data);

Вызывается всякий раз, когда меняется row или меняется порядок строк, позволяя обновить заголовок в row. Можно удалить или установить новый заголовок с помощью gtk_list_box_row_set_header() или просто изменить состояние текущего виджета заголовка.

С версии: 3.10

gtk_list_box_new ()

GtkWidget *
gtk_list_box_new (void);

Создаёт новый контейнер GtkListBox.

С версии: 3.10

gtk_list_box_prepend ()

void
gtk_list_box_prepend (GtkListBox *box,
                      GtkWidget *child);

Добавляет виджет в начало списка. Если задана функция сортировки, виджет будет фактически вставлен в рассчитанную позицию, и эта функция имеет тот же эффект, что и gtk_container_add().

С версии: 3.10

gtk_list_box_insert ()

void
gtk_list_box_insert (GtkListBox *box,
                     GtkWidget *child,
                     gint position);

Вставляет child в box на позиции position. Если задана функция сортировки, виджет будет фактически вставлен в рассчитанную позицию, и эта функция имеет тот же эффект, что и gtk_container_add().

Если position равно -1 или больше, чем общее количество элементов в box, то child будет добавлен в конец.

С версии: 3.10

gtk_list_box_select_row ()

void
gtk_list_box_select_row (GtkListBox *box,
                         GtkListBoxRow *row);

Устанавливает row в качестве выделенной строки.

С версии: 3.10

gtk_list_box_unselect_row ()

void
gtk_list_box_unselect_row (GtkListBox *box,
                           GtkListBoxRow *row);

Снимает выделение с единственной строки box, если режим выделения позволяет это.

С версии: 3.14

gtk_list_box_select_all ()

void
gtk_list_box_select_all (GtkListBox *box);

Выделяет все дочерние элементы box, если режим выделения позволяет это.

С версии: 3.14

gtk_list_box_unselect_all ()

void
gtk_list_box_unselect_all (GtkListBox *box);

Снимает выделение со всех дочерних элементов box, если режим выделения позволяет это.

С версии: 3.14

gtk_list_box_get_selected_row ()

GtkListBoxRow *
gtk_list_box_get_selected_row (GtkListBox *box);

Получает выбранную строку.

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

С: 3.10

GtkListBoxForeachFunc ()

void
(*GtkListBoxForeachFunc) (GtkListBox *box,
                          GtkListBoxRow *row,
                          gpointer user_data);

Функция, используемая gtk_list_box_selected_foreach(). Она будет вызываться для каждого выбранного дочернего элемента box.

С: 3.14

gtk_list_box_selected_foreach ()

void
gtk_list_box_selected_foreach (GtkListBox *box,
                               GtkListBoxForeachFunc func,
                               gpointer data);

Вызывает функцию для каждого выбранного дочернего элемента.

Обратите внимание, что выбор внутри этой функции изменить нельзя.

С: 3.14

gtk_list_box_get_selected_rows ()

GList *
gtk_list_box_get_selected_rows (GtkListBox *box);

Создаёт список всех выбранных дочерних элементов.

С: 3.14

gtk_list_box_set_selection_mode ()

void
gtk_list_box_set_selection_mode (GtkListBox *box,
                                 GtkSelectionMode mode);

Устанавливает режим работы выбора в списке. Подробности см. в GtkSelectionMode.

С: 3.10

gtk_list_box_get_selection_mode ()

GtkSelectionMode
gtk_list_box_get_selection_mode (GtkListBox *box);

Получает режим выбора списка.

С: 3.10

gtk_list_box_set_activate_on_single_click ()

void
gtk_list_box_set_activate_on_single_click
                               (GtkListBox *box,
                                gboolean single);

Если single равно TRUE, строки будут активироваться при нажатии, иначе требуется двойной щелчок.

С: 3.10

gtk_list_box_get_activate_on_single_click ()

gboolean
gtk_list_box_get_activate_on_single_click
                               (GtkListBox *box);

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

С: 3.10

gtk_list_box_get_adjustment ()

GtkAdjustment *
gtk_list_box_get_adjustment (GtkListBox *box);

Получает настройку (если есть), используемую виджетом для вертикальной прокрутки.

С: 3.10

gtk_list_box_set_adjustment ()

void
gtk_list_box_set_adjustment (GtkListBox *box,
                             GtkAdjustment *adjustment);

Устанавливает настройку (если есть), используемую виджетом для вертикальной прокрутки. Например, это используется для получения размера страницы для обработки клавиш PageUp/Down.

В нормальном случае, когда box упакован внутри GtkScrolledWindow, настройка из неё будет автоматически получена, поэтому нет необходимости делать это вручную.

С: 3.10

gtk_list_box_set_placeholder ()

void
gtk_list_box_set_placeholder (GtkListBox *box,
                              GtkWidget *placeholder);

Устанавливает виджет-заполнитель, который отображается в списке, когда он не отображает видимых дочерних элементов.

С: 3.10

gtk_list_box_get_row_at_index ()

GtkListBoxRow *
gtk_list_box_get_row_at_index (GtkListBox *box,
                               gint index_);

Возвращает n-ый дочерний элемент в списке (не считая заголовков). Если _index отрицательное или больше, чем количество элементов в списке, возвращается NULL.

С: 3.10

gtk_list_box_get_row_at_y ()

GtkListBoxRow *
gtk_list_box_get_row_at_y (GtkListBox *box,
                           gint y);

Возвращает строку по позиции y.

С: 3.10

gtk_list_box_invalidate_filter ()

void
gtk_list_box_invalidate_filter (GtkListBox *box);

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

С: 3.10

gtk_list_box_invalidate_headers ()

void
gtk_list_box_invalidate_headers (GtkListBox *box);

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

С: 3.10

gtk_list_box_invalidate_sort ()

void
gtk_list_box_invalidate_sort (GtkListBox *box);

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

С: 3.10

gtk_list_box_set_filter_func ()

void
gtk_list_box_set_filter_func (GtkListBox *box,
                              GtkListBoxFilterFunc filter_func,
                              gpointer user_data,
                              GDestroyNotify destroy);

Установив функцию фильтрации для box, можно динамически определять, какие строки отображать. Например, чтобы реализовать функцию поиска в списке, которая фильтрует исходный список, отображая только соответствующие строки.

Функция filter_func будет вызываться для каждой строки после вызова, а также каждый раз, когда изменяется строка (через gtk_list_box_row_changed()) или когда вызывается gtk_list_box_invalidate_filter().

Обратите внимание, что использование функции фильтрации несовместимо с использованием модели (см. gtk_list_box_bind_model()).

С: 3.10

gtk_list_box_set_header_func ()

void
gtk_list_box_set_header_func (GtkListBox *box,
                              GtkListBoxUpdateHeaderFunc update_header,
                              gpointer user_data,
                              GDestroyNotify destroy);

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

Функция update_header может получить текущий виджет заголовка с помощью gtk_list_box_row_get_header() и либо обновить состояние виджета по мере необходимости, либо установить новый с помощью gtk_list_box_row_set_header(). Если заголовок не нужен, установите заголовок в NULL.

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

Функция update_header будет вызываться для каждой строки после вызова, и она будет продолжать вызываться каждый раз, когда строка меняется (через gtk_list_box_row_changed()) и когда строка перед ней меняется (либо из-за gtk_list_box_row_changed() в предыдущей строке, либо когда предыдущая строка становится другой). Она также вызывается для всех строк при вызове gtk_list_box_invalidate_headers().

С: 3.10

gtk_list_box_set_sort_func ()

void
gtk_list_box_set_sort_func (GtkListBox *box,
                            GtkListBoxSortFunc sort_func,
                            gpointer user_data,
                            GDestroyNotify destroy);

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

Функция sort_func будет вызываться для каждой строки после вызова и будет продолжать вызываться каждый раз, когда строка изменяется (через gtk_list_box_row_changed()) и когда вызывается gtk_list_box_invalidate_sort().

Обратите внимание, что использование функции сортировки несовместимо с использованием модели (см. gtk_list_box_bind_model()).

С: 3.10

gtk_list_box_drag_highlight_row ()

void
gtk_list_box_drag_highlight_row (GtkListBox *box,
                                 GtkListBoxRow *row);

Это вспомогательная функция для реализации перетаскивания на GtkListBox. Переданная row строка будет выделена с помощью gtk_drag_highlight(), а любая ранее выделенная строка будет снята с выделения.

Строка также будет снята с выделения при получении события drag leave виджетом.

С: 3.10

gtk_list_box_drag_unhighlight_row ()

void
gtk_list_box_drag_unhighlight_row (GtkListBox *box);

Если строка была ранее выделена с помощью gtk_list_box_drag_highlight_row(), выделение будет снято.

С: 3.10

GtkListBoxCreateWidgetFunc ()

GtkWidget *
(*GtkListBoxCreateWidgetFunc) (gpointer item,
                               gpointer user_data);

Вызывается для списков, привязанных к GListModel с помощью gtk_list_box_bind_model() для каждого добавляемого в модель элемента.

Версии GTK+ до 3.18 вызывали gtk_widget_show_all() для созданных GtkListBoxCreateWidgetFunc строк, но это принудительно отображало все виджеты внутри строки, и этого больше нет. Приложения должны быть обновлены для отображения необходимых виджетов строк.

С: 3.16

gtk_list_box_bind_model ()

void
gtk_list_box_bind_model (GtkListBox *box,
                         GListModel *model,
                         GtkListBoxCreateWidgetFunc create_widget_func,
                         gpointer user_data,
                         GDestroyNotify user_data_free_func);

Связывает model с box.

Если box уже было связано с моделью, то предыдущая привязка уничтожается.

Содержимое box очищается и затем заполняется виджетами, представляющими элементы из model. box обновляется всякий раз, когда model изменяется. Если model равно NULL, box остается пустым.

Не определено прямо добавлять или удалять виджеты (например, с помощью gtk_list_box_insert() или gtk_container_add()), пока box связано с моделью.

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

Since: 3.16

gtk_list_box_row_new ()

GtkWidget *
gtk_list_box_row_new (void);

Создает новый GtkListBoxRow, который будет использоваться в качестве дочернего элемента GtkListBox.

Since: 3.10

gtk_list_box_row_changed ()

void
gtk_list_box_row_changed (GtkListBoxRow *row);

Помечает row как изменённый, вызывая обновление любого состояния, зависящего от этого. Это влияет на сортировку, фильтрацию и заголовки.

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

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

Since: 3.10

gtk_list_box_row_is_selected ()

gboolean
gtk_list_box_row_is_selected (GtkListBoxRow *row);

Возвращает, выбрана ли дочерняя строка в контейнере GtkListBox.

Since: 3.14

gtk_list_box_row_get_header ()

GtkWidget *
gtk_list_box_row_get_header (GtkListBoxRow *row);

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

Since: 3.10

gtk_list_box_row_set_header ()

void
gtk_list_box_row_set_header (GtkListBoxRow *row,
                             GtkWidget *header);

Устанавливает текущий заголовок row. Это разрешается вызывать только из GtkListBoxUpdateHeaderFunc. Он заменит любой существующий заголовок в строке и будет отображаться перед строкой в listbox.

Since: 3.10

gtk_list_box_row_get_index ()

gint
gtk_list_box_row_get_index (GtkListBoxRow *row);

Получает текущий индекс row в контейнере GtkListBox.

Since: 3.10

gtk_list_box_row_set_activatable ()

void
gtk_list_box_row_set_activatable (GtkListBoxRow *row,
                                  gboolean activatable);

Установите свойство “activatable” для этой строки.

Since: 3.14

gtk_list_box_row_get_activatable ()

gboolean
gtk_list_box_row_get_activatable (GtkListBoxRow *row);

Получает значение свойства “activatable” для этой строки.

С версии: 3.14

gtk_list_box_row_set_selectable ()

void
gtk_list_box_row_set_selectable (GtkListBoxRow *row,
                                 gboolean selectable);

Устанавливает свойство “selectable” для этой строки.

С версии: 3.14

gtk_list_box_row_get_selectable ()

gboolean
gtk_list_box_row_get_selectable (GtkListBoxRow *row);

Получает значение свойства “selectable” для этой строки.

С версии: 3.14