GtkSearchBar
GtkSearchBar — Панель инструментов для интеграции поля поиска
Функции
| GtkWidget * | gtk_search_bar_new () |
| void | gtk_search_bar_set_child () |
| GtkWidget * | gtk_search_bar_get_child () |
| void | gtk_search_bar_connect_entry () |
| gboolean | gtk_search_bar_get_search_mode () |
| void | gtk_search_bar_set_search_mode () |
| gboolean | gtk_search_bar_get_show_close_button () |
| void | gtk_search_bar_set_show_close_button () |
| void | gtk_search_bar_set_key_capture_widget () |
| GtkWidget * | gtk_search_bar_get_key_capture_widget () |
Свойства
| GtkWidget * | child | Чтение/Запись/Создание |
| GtkWidget * | key-capture-widget | Чтение/Запись/Создание |
| gboolean | search-mode-enabled | Чтение/Запись |
| gboolean | show-close-button | Чтение/Запись/Создание |
Типы и значения
Иерархия объектов
GObject
╰── GInitiallyUnowned
╰── GtkWidget
╰── GtkSearchBar
Реализованные интерфейсы
GtkSearchBar реализует GtkAccessible, GtkBuildable и GtkConstraintTarget.
Файлы заголовков
#include <gtk/gtk.h>
Описание
GtkSearchBar — контейнер, предназначенный для встраивания поля поиска (возможно, с дополнительными связанными виджетами, такими как выпадающие меню или кнопки). Панель поиска будет отображаться при запуске поиска с помощью ввода с клавиатуры или при переключении режима поиска приложения.
Для запуска поиска с помощью нажатий клавиш панель поиска должна получить указание о виджете, который будет принимать события нажатия клавиш, с помощью gtk_search_bar_set_key_capture_widget(). Этот виджет обычно представляет собой главное окно или контейнер-родитель панели поиска. Общие сочетания клавиш, такие как Ctrl+F, должны обрабатываться как действие приложения или с помощью элементов меню.
Также необходимо указать панели поиска, какое поле ввода используется в качестве поля поиска, с помощью gtk_search_bar_connect_entry(). Следующий пример показывает, как создать более сложное поле поиска.
Создание панели поиска
Узлы CSS
searchbar
╰── revealer
╰── box
├── [child]
╰── [button.close]GtkSearchBar имеет главный узел CSS с именем searchbar. Он имеет дочерний узел с именем revealer, который содержит узел с именем box. Узел box содержит как узел CSS дочернего виджета, так и необязательный узел кнопки, которому применяется класс стиля .close.
Удобство использования
GtkSearchBar использует роль GTK_ACCESSIBLE_ROLE_SEARCH.
Функции
gtk_search_bar_new ()
GtkWidget *
gtk_search_bar_new (void); Создаёт GtkSearchBar. Вам необходимо указать виджет, который будет вашей текстовой областью, используя gtk_search_bar_connect_entry().
Возвращает
новый GtkSearchBar
gtk_search_bar_set_child ()
void gtk_search_bar_set_child (GtkSearchBar *bar,GtkWidget *child);
Устанавливает дочерний виджет для bar .
Параметры
bar | ||
child | дочерний виджет. | [allow-none] |
gtk_search_bar_get_child ()
GtkWidget *
gtk_search_bar_get_child (GtkSearchBar *bar); Возвращает дочерний виджет для bar .
Параметры
bar |
Возвращает
дочерний виджет для bar .
[nullable][transfer none]
gtk_search_bar_connect_entry ()
void gtk_search_bar_connect_entry (GtkSearchBar *bar,GtkEditable *entry);
Подключает виджет GtkEntry, переданный в качестве используемого в этом поисковом поле. Виджет должен быть потомком поискового поля. Это необходимо только если виджет не является непосредственным потомком поискового поля (как в нашем главном примере).
Параметры
bar | ||
entry |
gtk_search_bar_get_search_mode ()
gboolean
gtk_search_bar_get_search_mode (GtkSearchBar *bar); Возвращает, включён ли режим поиска.
Параметры
bar |
Возвращает
включён ли режим поиска
gtk_search_bar_set_search_mode ()
void gtk_search_bar_set_search_mode (GtkSearchBar *bar,gboolean search_mode);
Переключает режим поиска.
Параметры
bar | ||
search_mode | новое состояние режима поиска |
gtk_search_bar_get_show_close_button ()
gboolean
gtk_search_bar_get_show_close_button (GtkSearchBar *bar); Возвращает, отображается ли кнопка закрытия.
Параметры
bar |
Возвращает
отображается ли кнопка закрытия
gtk_search_bar_set_show_close_button ()
void gtk_search_bar_set_show_close_button (GtkSearchBar *bar,gboolean visible);
Отображает или скрывает кнопку закрытия. Приложениям, у которых уже есть кнопка переключения "поиск", не следует отображать кнопку закрытия в поисковом поле, так как это дублирует роль кнопки переключения.
Параметры
bar | ||
visible | будет ли отображаться кнопка закрытия |
gtk_search_bar_set_key_capture_widget ()
void gtk_search_bar_set_key_capture_widget (GtkSearchBar *bar,GtkWidget *widget);
Устанавливает widget в качестве виджета, который bar будет получать события нажатия клавиш от.
Если события нажатия клавиш обрабатываются поисковым полем, поле будет отображаться, а в поле ввода будет отображаться введённый текст.
Параметры
bar | ||
widget | a GtkWidget. | [nullable][transfer none] |
gtk_search_bar_get_key_capture_widget ()
GtkWidget *
gtk_search_bar_get_key_capture_widget (GtkSearchBar *bar); Возвращает виджет, от которого bar получает события нажатия клавиш.
Параметры
bar |
Возвращает
Виджет захвата нажатий клавиш.
[transfer none]
Типы и значения
GtkSearchBar
typedef struct _GtkSearchBar GtkSearchBar;
Подробное описание свойств
Свойство “child”
“child” GtkWidget *
Дочерний виджет.
Владелец: GtkSearchBar
Флаги: Чтение / Запись / Создание
Свойство “key-capture-widget”
“key-capture-widget” GtkWidget *
Виджет захвата нажатий клавиш.
Владелец: GtkSearchBar
Флаги: Чтение / Запись / Создание
Свойство “search-mode-enabled”
“search-mode-enabled” gboolean
Включён ли режим поиска и отображается ли поисковая строка.
См. gtk_search_bar_set_search_mode() для подробностей.
Владелец: GtkSearchBar
Флаги: Чтение / Запись
Значение по умолчанию: FALSE
Свойство “show-close-button”
“show-close-button” gboolean
Отображать ли кнопку закрытия в поисковой строке.
Владелец: GtkSearchBar
Флаги: Чтение / Запись / Создание
Значение по умолчанию: FALSE
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer-old.gnome.org/gtk4/4.0/GtkSearchBar.html
