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” для этой строки.

С: 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