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/PageDown.

В обычном случае, когда 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().

Since: 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()).

Since: 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.

Since: 3.10

gtk_list_box_drag_unhighlight_row ()

void
gtk_list_box_drag_unhighlight_row (GtkListBox *box);

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

Since: 3.10

GtkListBoxCreateWidgetFunc ()

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

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

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

Since: 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. При использовании модели фильтрация и сортировка должны быть реализованы в модели.

С: 3.16

gtk_list_box_row_new ()

GtkWidget *
gtk_list_box_row_new (void);

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

С: 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() при любом изменении модели, но это дороже.

С: 3.10

gtk_list_box_row_is_selected ()

gboolean
gtk_list_box_row_is_selected (GtkListBoxRow *row);

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

С: 3.14

gtk_list_box_row_get_header ()

GtkWidget *
gtk_list_box_row_get_header (GtkListBoxRow *row);

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

С: 3.10

gtk_list_box_row_set_header ()

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

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

С: 3.10

gtk_list_box_row_get_index ()

gint
gtk_list_box_row_get_index (GtkListBoxRow *row);

Возвращает текущий индекс row в контейнере GtkListBox.

С: 3.10

gtk_list_box_row_set_activatable ()

void
gtk_list_box_row_set_activatable (GtkListBoxRow *row,
                                  gboolean activatable);

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

С момента: 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