GtkSearchBar

说明 [src]

final class Gtk.SearchBar : Gtk.Widget
  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
  /* No available fields */
}

GtkSearchBar 是一个用于创建搜索输入的容器。

An example GtkSearchBar

还可以包含其他部件,例如下拉菜单或按钮。在通过键盘输入启动搜索或切换应用程序的搜索模式时,搜索栏会显示。

要使用键盘按压启动搜索,必须通过 gtk_search_bar_set_key_capture_widget() 通知搜索栏从哪个部件捕获按键事件。此部件通常是顶层窗口或搜索栏的父容器。常见的快捷方式(如 Ctrl+F)应作为应用程序操作或通过菜单项来处理。

还需要使用 gtk_search_bar_connect_entry() 告知搜索栏将哪个输入用作搜索输入。

以下示例演示如何创建一个更复杂的搜索输入。

一个简单的示例

快捷方式和手势

GtkSearchBar 支持以下键盘快捷方式

  • Esc 隐藏搜索栏。

CSS 节点

searchbar
╰── revealer
    ╰── box
         ├── [child]
         ╰── [button.close]

GtkSearchBar 有一个名为 searchbar 的主 CSS 节点。它有一个名为 revealer 的子节点,其中包含一个名为 box 的节点。box 节点同时包含子部件的 CSS 节点和一个可选按钮节点,该节点应用了 .close 样式类。

辅助功能

GtkSearchBar 使用 GTK_ACCESSIBLE_ROLE_SEARCH 角色。

层次结构

hierarchy this GtkSearchBar implements_0 GtkAccessible this--implements_0 implements_1 GtkBuildable this--implements_1 implements_2 GtkConstraintTarget this--implements_2 ancestor_0 GtkWidget ancestor_0--this ancestor_1 GInitiallyUnowned ancestor_1--ancestor_0 ancestor_2 GObject ancestor_2--ancestor_1

构造函数

gtk_search_bar_new

创建 GtkSearchBar

实例方法

gtk_search_bar_connect_entry

连接传递为要用于此搜索栏中的 GtkEditable 部件。

gtk_search_bar_get_child

获取 bar 的子部件。

gtk_search_bar_get_key_capture_widget

获取 bar 正在捕获其按键事件的部件。

gtk_search_bar_get_search_mode

返回搜索模式是已打开还是已关闭。

gtk_search_bar_get_show_close_button

返回是否显示关闭按钮。

gtk_search_bar_set_child

设置 bar 的子控件。

gtk_search_bar_set_key_capture_widget

widget 设置为 bar 将从中捕捉按键事件的控件。

gtk_search_bar_set_search_mode

打开或关闭搜索模式。

gtk_search_bar_set_show_close_button

显示或隐藏关闭按钮。

GtkWidget (162) 继承的方法

请参阅 GtkWidget 以了解方法的完整列表。

GObject (43) 继承的方法

请参阅 GObject 以了解方法的完整列表。

GtkAccessible (19) 继承的方法
gtk_accessible_announce

请求用户的屏幕阅读器播报给定的消息。

自:4.14

gtk_accessible_get_accessible_parent

检索可访问对象的辅助父对象。

自:4.10

gtk_accessible_get_accessible_role

检索可访问对象的辅助角色。

gtk_accessible_get_at_context

检索给定可访问对象的实现。

自:4.10

gtk_accessible_get_bounds

查询此可访问对象的坐标和尺寸。

自:4.10

gtk_accessible_get_first_accessible_child

检索可访问对象的第一个可访问子对象。

自:4.10

gtk_accessible_get_next_accessible_sibling

检索可访问对象的下一个可访问同级对象。

自:4.10

gtk_accessible_get_platform_state

查询平台状态,例如焦点。

自:4.10

gtk_accessible_reset_property

将辅助功能属性重置为其默认值。

gtk_accessible_reset_relation

将辅助功能关系重置为其默认值。

gtk_accessible_reset_state

将辅助功能状态重置为其默认值。

gtk_accessible_set_accessible_parent

设置可访问对象的父项和同级项。

自:4.10

gtk_accessible_update_next_accessible_sibling

更新下一个可访问同级对象。

自:4.10

gtk_accessible_update_property

更新可访问属性的列表。

gtk_accessible_update_property_value

更新可访问属性的数组。

gtk_accessible_update_relation

更新可访问关系的列表。

gtk_accessible_update_relation_value

更新可访问关系的数组。

gtk_accessible_update_state

更新可访问状态的列表。

gtk_accessible_update_state_value

更新可访问状态的数组。

GtkBuildable (1) 继承的方法
gtk_buildable_get_buildable_id

获取 buildable 对象的 ID

属性

Gtk.SearchBar:child

子控件。

Gtk.SearchBar:key-capture-widget

按键捕获控件。

Gtk.SearchBar:search-mode-enabled

搜索模式是否开启,搜索栏是否显示。

Gtk.SearchBar:show-close-button

是否在搜索栏中显示关闭按钮。

GtkWidget (34) 继承的属性
Gtk.Widget:can-focus

此控件或其任何后代是否可以接受输入焦点。

Gtk.Widget:can-target

控件是否可以接收指针事件。

Gtk.Widget:css-classes

应用于此控件的 CSS 类列表。

Gtk.Widget:css-name

此控件在 CSS 树中的名称。

Gtk.Widget:cursor

widget 使用的光标。

Gtk.Widget:focus-on-click

当使用鼠标单击该控件时,该控件是否应获取焦点。

Gtk.Widget:focusable

此控件本身是否将接受输入焦点。

Gtk.Widget:halign

如果窗口小部件获取额外的空间,如何分配水平空间。

Gtk.Widget:has-default

窗口小部件是否是默认窗口小部件。

Gtk.Widget:has-focus

窗口小部件是否具有输入焦点。

Gtk.Widget:has-tooltip

启用或禁用在 `widget` 上发出 `GtkWidget::query-tooltip` 信号。

Gtk.Widget:height-request

窗口小部件高度请求的覆盖。

Gtk.Widget:hexpand

是否水平扩展。

Gtk.Widget:hexpand-set

是否使用 `hexpand` 属性。

Gtk.Widget:layout-manager

用于计算窗口小部件的首选大小及其分配子项的 `GtkLayoutManager` 实例。

Gtk.Widget:margin-bottom

窗口小部件底部边距。

Gtk.Widget:margin-end

窗口小部件末端的边距(水平)。

Gtk.Widget:margin-start

窗口小部件开始处的边距(水平)。

Gtk.Widget:margin-top

窗口小部件顶部边距。

Gtk.Widget:name

窗口小部件的名称。

Gtk.Widget:opacity

窗口小部件请求的不透明度。

Gtk.Widget:overflow

如何处理窗口小部件内容区域外部的内容。

Gtk.Widget:parent

此窗口小部件的父窗口小部件。

Gtk.Widget:receives-default

窗口小部件在获得焦点后是否能接收默认操作。

Gtk.Widget:root

包含此窗口小部件的窗口小部件树的 `GtkRoot` 窗口小部件。

Gtk.Widget:scale-factor

窗口小部件的比例因子。

Gtk.Widget:sensitive

窗口小部件是否响应输入。

Gtk.Widget:tooltip-markup

将工具提示的文本设置为给定的字符串,该字符串通过 Pango 标记进行标记。

Gtk.Widget:tooltip-text

将工具提示的文本设置为给定的字符串。

Gtk.Widget:valign

如果窗口小部件获取额外的空间,如何分配垂直空间。

Gtk.Widget:vexpand

是否垂直扩展。

Gtk.Widget:vexpand-set

是否使用 `vexpand` 属性。

Gtk.Widget:visible

窗口小部件是否可见。

Gtk.Widget:width-request

窗口小部件宽度请求的覆盖。

GtkAccessible(1) 继承的属性
GtkAccessible:accessible-role

给定 `GtkAccessible` 实现的可访问角色。

信号

GtkWidget(13) 继承的信号
GtkWidget::destroy

所有对窗口小部件的引用持有者应释放其所持有的引用的信号。

GtkWidget::direction-changed

当窗口小部件的文本方向发生改变时发出。

GtkWidget::hide

当 `widget` 被隐藏时发出。

GtkWidget::keynav-failed

如果键盘导航失败,则发出。

GtkWidget::map

当 `widget` 即将被映射时发出。

GtkWidget::mnemonic-activate

当窗口小部件通过助记符激活时发出。

GtkWidget::move-focus

焦点移动时发出。

GtkWidget::query-tooltip

当窗口小部件的工具提示即将显示时发出。

GtkWidget::realize

当 `widget` 与 `GdkSurface` 关联时发出。

GtkWidget::show

当 `widget` 显示时发出。

GtkWidget::state-flags-changed

当窗口小部件状态发生变化时发出。

GtkWidget::unmap

当 `widget` 即将取消映射时发出。

GtkWidget::unrealize

与 `widget` 关联的 `GdkSurface` 被销毁时发出。

GObject(1) 继承的信号
GObject::notify

当对象的某个属性通过 g_object_set_property()、g_object_set()、等方式设置其值时,会在对象上发出通知信号。