GtkListBox

GtkListBoxFilterFunc ()

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

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

GtkListBoxSortFunc ()

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

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

GtkListBoxUpdateHeaderFunc ()

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

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

gtk_list_box_new ()

GtkWidget *
gtk_list_box_new (void);

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

gtk_list_box_prepend ()

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

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

gtk_list_box_append ()

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

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

gtk_list_box_insert ()

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

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

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

gtk_list_box_remove ()

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

Удаляет дочерний элемент из box .

gtk_list_box_select_row ()

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

Делает row текущей выбранной строкой.

gtk_list_box_unselect_row ()

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

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

gtk_list_box_select_all ()

void
gtk_list_box_select_all (GtkListBox *box);

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

gtk_list_box_unselect_all ()

void
gtk_list_box_unselect_all (GtkListBox *box);

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

gtk_list_box_get_selected_row ()

GtkListBoxRow *
gtk_list_box_get_selected_row (GtkListBox *box);

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

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

GtkListBoxForeachFunc ()

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

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

gtk_list_box_selected_foreach ()

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

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

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

gtk_list_box_get_selected_rows ()

GList *
gtk_list_box_get_selected_rows (GtkListBox *box);

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

gtk_list_box_set_show_separators ()

void
gtk_list_box_set_show_separators (GtkListBox *box,
                                  gboolean show_separators);

Устанавливает, нужно ли отображать разделители между строками в списке.

gtk_list_box_get_show_separators ()

gboolean
gtk_list_box_get_show_separators (GtkListBox *box);

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

gtk_list_box_set_selection_mode ()

void
gtk_list_box_set_selection_mode (GtkListBox *box,
                                 GtkSelectionMode mode);

Устанавливает, как работает выбор в списке. См. GtkSelectionMode для подробностей.

gtk_list_box_get_selection_mode ()

GtkSelectionMode
gtk_list_box_get_selection_mode (GtkListBox *box);

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

gtk_list_box_set_activate_on_single_click ()

void
gtk_list_box_set_activate_on_single_click
                               (GtkListBox *box,
                                gboolean single);

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

gtk_list_box_get_activate_on_single_click ()

gboolean
gtk_list_box_get_activate_on_single_click
                               (GtkListBox *box);

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

gtk_list_box_get_adjustment ()

GtkAdjustment *
gtk_list_box_get_adjustment (GtkListBox *box);

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

gtk_list_box_set_adjustment ()

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

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

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

gtk_list_box_set_placeholder ()

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

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

gtk_list_box_get_row_at_index ()

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

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

gtk_list_box_get_row_at_y ()

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

Получает строку по позиции y.

gtk_list_box_invalidate_filter ()

void
gtk_list_box_invalidate_filter (GtkListBox *box);

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

gtk_list_box_invalidate_headers ()

void
gtk_list_box_invalidate_headers (GtkListBox *box);

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

gtk_list_box_invalidate_sort ()

void
gtk_list_box_invalidate_sort (GtkListBox *box);

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

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

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

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

gtk_list_box_drag_highlight_row ()

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

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

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

gtk_list_box_drag_unhighlight_row ()

void
gtk_list_box_drag_unhighlight_row (GtkListBox *box);

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

GtkListBoxCreateWidgetFunc ()

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

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

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()), пока box связан с моделью.

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

gtk_list_box_row_new ()

GtkWidget *
gtk_list_box_row_new (void);

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

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

gtk_list_box_row_is_selected ()

gboolean
gtk_list_box_row_is_selected (GtkListBoxRow *row);

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

gtk_list_box_row_get_child ()

GtkWidget *
gtk_list_box_row_get_child (GtkListBoxRow *row);

Получает дочерний виджет row.

gtk_list_box_row_set_child ()

void
gtk_list_box_row_set_child (GtkListBoxRow *row,
                            GtkWidget *child);

Устанавливает дочерний виджет self.

gtk_list_box_row_get_header ()

GtkWidget *
gtk_list_box_row_get_header (GtkListBoxRow *row);

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

gtk_list_box_row_set_header ()

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

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

gtk_list_box_row_get_index ()

int
gtk_list_box_row_get_index (GtkListBoxRow *row);

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

gtk_list_box_row_set_activatable ()

void
gtk_list_box_row_set_activatable (GtkListBoxRow *row,
                                  gboolean activatable);

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

gtk_list_box_row_get_activatable ()

gboolean
gtk_list_box_row_get_activatable (GtkListBoxRow *row);

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

gtk_list_box_row_set_selectable ()

void
gtk_list_box_row_set_selectable (GtkListBoxRow *row,
                                 gboolean selectable);

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

gtk_list_box_row_get_selectable ()

gboolean
gtk_list_box_row_get_selectable (GtkListBoxRow *row);

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