GtkSearchEntry

描述 [src]

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

GtkSearchEntry 是一个已针对用作搜索条目进行定制的输入控件。

用于以输入形式与 GtkSearchEntry 交互的主要 APIGtkEditable 接口。

An example GtkSearchEntry

当搜索输入为空时,它将显示一个非活动符号 “查找” 图标,当有文本时将显示一个符号 “清除” 图标。当点击 “清除” 图标时,将会清空搜索输入。

为了让过滤显得更具响应性,最好不要立即对输入文本中的每次更改做出反应,而仅在短暂延迟后做出反应。为了支持这一点,GtkSearchEntry 发出 GtkSearchEntry::search-changed 信号,该信号能够用于代替 GtkEditable::changed 信号。

可以利用 GtkSearchEntry::previous-matchGtkSearchEntry::next-matchGtkSearchEntry::stop-search 信号来实现移动搜索结果和结束搜索。

通常,GtkSearchEntry 将通过放置在 GtkSearchBar 中的方式接收事件。如果不是这种情况,可以使用 gtk_search_entry_set_key_capture_widget() 允许它从另一个控件捕获按键输入。

GtkSearchEntry 仅提供最简单的 API,应与 GtkEditable API 结合使用。

快捷键和手势

以下信号具有默认键绑定

CSS 节点

entry.search
╰── text

GtkSearchEntry 具有一个名称为 entry 的单个 CSS 节点,它带有 .search 样式类,而且文本节点是该节点的子项。

辅助功能

GtkSearchEntry 使用 GTK_ACCESSIBLE_ROLE_SEARCH_BOX 角色。

层次结构

hierarchy this GtkSearchEntry implements_0 GtkAccessible this--implements_0 implements_1 GtkBuildable this--implements_1 implements_2 GtkConstraintTarget this--implements_2 implements_3 GtkEditable this--implements_3 ancestor_0 GtkWidget ancestor_0--this ancestor_1 GInitiallyUnowned ancestor_1--ancestor_0 ancestor_2 GObject ancestor_2--ancestor_1

构造函数

gtk_search_entry_new

创建 GtkSearchEntry

实例方法

gtk_search_entry_get_input_hints

获取 entry 的输入目的。

自:4.14

gtk_search_entry_get_input_purpose

获取 entry 的输入目的。

自:4.14

gtk_search_entry_get_key_capture_widget

获取 entry 从中捕获按键事件的小组件。

gtk_search_entry_get_placeholder_text

获取与 entry 关联的占位符文本。

自:4.10

gtk_search_entry_get_search_delay

获取在上一次按键和 GtkSearchEntry::search-changed 信号发送之间使用的时间延迟。

自:4.8

gtk_search_entry_set_input_hints

设置 entry 的输入提示。

自:4.14

gtk_search_entry_set_input_purpose

设置 entry 的输入目的。

自:4.14

gtk_search_entry_set_key_capture_widget

设置 widget 作为 entry 将从此处捕获按键事件的小组件。

gtk_search_entry_set_placeholder_text

设置与 entry 关联的占位符文本。

自:4.10

gtk_search_entry_set_search_delay

设置在上一次按键和 GtkSearchEntry::search-changed 信号发送之间使用的时间延迟。

自:4.8

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

查询平台状态,如 focus。

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

GtkEditable (24) 继承的方法

有关方法的完整列表,请参阅 GtkEditable 。

属性

Gtk.SearchEntry:activates-default

当按 Enter 键时是否激活默认小组件。

Gtk.SearchEntry:input-hints

用于更改输入法行为的`GtkSearchEntry` 的输入提示。

自:4.14

Gtk.SearchEntry:input-purpose

用于更改输入法行为的`GtkSearchEntry` 输入的用途。

自:4.14

Gtk.SearchEntry:placeholder-text

当`GtkSearchEntry` 为空且没有焦点时,将在其中显示的文本。

Gtk.SearchEntry:search-delay

从最后一次按键到搜索更改信号之间的延迟(以毫秒为单位)。

自:4.8

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实现的可访问角色。

GtkEditable继承的属性(8)
GtkEditable:cursor-position

光标在字符中的当前位置。

GtkEditable:editable

条目内容是否可编辑。

GtkEditable:enable-undo

是否为可编辑内容启用撤消/重做。

GtkEditable:max-width-chars

条目的期望最大宽度,以字符为单位。

GtkEditable:selection-bound

从光标到选中内容另一端的相对位置,以字符为单位。

GtkEditable:text

条目的内容。

GtkEditable:width-chars

在条目中留出空格的字符数。

GtkEditable:xalign

水平对齐,从 0(左)到 1(右)。

信号

Gtk.SearchEntry::activate

条目激活后发出。

Gtk.SearchEntry::next-match

当用户发起操作以查找当前搜索字符串的下一匹配项后发出。

Gtk.SearchEntry::previous-match

当用户发起操作以查找当前搜索字符串的上一匹配项时发出。

Gtk.SearchEntry::search-changed

延迟发出。可以使用 `GtkSearchEntry:search-delay` 属性更改延迟时长。

Gtk.SearchEntry::search-started

当用户在条目上发起搜索时发出。

Gtk.SearchEntry::stop-search

当用户通过键盘输入停止搜索时发出。

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

widgetGdkSurface相关联后发出。

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() 等方式将对象的某个属性的值设为某个值时,该对象上会发出 notify 信号。

GtkEditable继承的信号(3)
GtkEditable::changed

在对内容执行单个用户可以看见的操作的结尾发出。

GtkEditable::delete-text

当用户从该控件中删除文本时发出。

GtkEditable::insert-text

当用户将文本插入到该控件中时发出。