类型

GtkAssistant

待淘汰:4.10 

说明 [src]

final class Gtk.Assistant : Gtk.Window
  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Native, Gtk.Root, Gtk.ShortcutManager {
  /* No available fields */
}

GtkAssistant 用作复杂系列之表示形式的 步骤。

An example GtkAssistant

每个步骤由一个或多个页面组成。GtkAssistant 指导用户浏览各个页面,并控制页面流程来收集 操作所需的数据。

除了状态信息,如已完成已提交页面状态之外,GtkAssistant 还负责处理基于页面序列知识和每个页面 GtkAssistantPageType 来显示哪些按钮以及使其保持敏感。

如果您遇到不适合 GtkAssistant 处理按钮的方式,则可以使用 GTK_ASSISTANT_PAGE_CUSTOM 页面类型,并亲自处理 按钮。

GtkAssistant 为每个添加的子项维护一个 GtkAssistantPage 对象,其中包含每个子项的属性。您可以使用 gtk_assistant_get_page() 获取子项的 GtkAssistantPage

作为 GtkBuildable 的 GtkAssistant

GtkAssistant 实现的 GtkBuildable 接口公开 action_area 为内部子项,其名称为 “action_area”。

要在 GtkBuilder 中向助手添加页面,只需将页面添加为 GtkAssistant 对象的子项即可。如果您需要设置每个对象的属性,请显式创建一个 GtkAssistantPage 对象,并将子项窗口小部件设置 为其属性。

CSS 节点

GtkAssistant 有一个带有名称窗口和样式类 .assistant 的单个 CSS 节点。

自版本 4.10 起弃用

此小部件将在 GTK 5 中移除。

层次结构

hierarchy this GtkAssistant implements_0 GtkAccessible this--implements_0 implements_1 GtkBuildable this--implements_1 implements_2 GtkConstraintTarget this--implements_2 implements_3 GtkNative this--implements_3 implements_4 GtkRoot this--implements_4 implements_5 GtkShortcutManager this--implements_5 ancestor_0 GtkWindow ancestor_0--this ancestor_1 GtkWidget ancestor_1--ancestor_0 ancestor_2 GInitiallyUnowned ancestor_2--ancestor_1 ancestor_3 GObject ancestor_3--ancestor_2

构造函数

gtk_assistant_new

创建新的 GtkAssistant

待淘汰:4.10 

实例方法

gtk_assistant_add_action_widget

将小部件添加到 GtkAssistant 的操作区域。

待淘汰:4.10 

gtk_assistant_append_page

将页面追加到 assistant

待淘汰:4.10 

gtk_assistant_commit

清除已访问的页面历史记录。

待淘汰:4.10 

gtk_assistant_get_current_page

返回当前页面的页码。

待淘汰:4.10 

gtk_assistant_get_n_pages

返回 assistant 中的页面数。

待淘汰:4.10 

gtk_assistant_get_nth_page

返回页号为 page_num 的子小部件。

待淘汰:4.10 

gtk_assistant_get_page

返回 childGtkAssistantPage 对象。

待淘汰:4.10 

gtk_assistant_get_page_complete

获取 page 是否已完成。

待淘汰:4.10 

gtk_assistant_get_page_title

获取 page 的标题。

待淘汰:4.10 

gtk_assistant_get_page_type

获取 page 的页面类型。

待淘汰:4.10 

gtk_assistant_get_pages

获取助理页面的列表模型。

待淘汰:4.10 

gtk_assistant_insert_page

在给定的位置插入页面到 assistant 中。

待淘汰:4.10 

gtk_assistant_next_page

导航到下一页。

待淘汰:4.10 

gtk_assistant_prepend_page

将页面前置到 assistant

待淘汰:4.10 

gtk_assistant_previous_page

导航到之前访问过的页面。

待淘汰:4.10 

gtk_assistant_remove_action_widget

GtkAssistant 的操作区域移除小部件。

待淘汰:4.10 

gtk_assistant_remove_page

assistant 移除 page_num 的页面。

待淘汰:4.10 

gtk_assistant_set_current_page

将页面切换到 page_num

待淘汰:4.10 

gtk_assistant_set_forward_page_func

将页面转发函数设置为 page_func

待淘汰:4.10 

gtk_assistant_set_page_complete

设置 page 内容是否已完成。

待淘汰:4.10 

gtk_assistant_set_page_title

设置 page 的标题。

待淘汰:4.10 

gtk_assistant_set_page_type

设置 page 的页面类型。

待淘汰:4.10 

gtk_assistant_update_buttons_state

强制 assistant 重新计算按钮状态。

待淘汰:4.10 

继承自 GtkWindow 的方法 (55)

请参阅 GtkWindow 以获取完整的方法列表。

继承自 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

GtkNative 继承的方法 (5)
gtk_native_get_renderer

返回此 GtkNative 使用的渲染器。

gtk_native_get_surface

返回此 GtkNative 的表面。

gtk_native_get_surface_transform

检索 self 的表面转换。

gtk_native_realize

实现 GtkNative

gtk_native_unrealize

取消实现 GtkNative

GtkRoot 继承的方法 (3)
gtk_root_get_display

返回此 GtkRoot 所在的显示器。

gtk_root_get_focus

检索根中当前获得焦点的微件。

gtk_root_set_focus

如果 focus 不是当前获得焦点的微件,而且可以获得焦点,则将其设置为根的焦点微件。

属性

Gtk.Assistant:pages

包含页的 GListModel

Gtk.Assistant:use-header-bar

如果助手使用 GtkHeaderBar 作为动作按钮而不是动作区域,则为 TRUE

待淘汰:4.10 

GtkWindow 继承的属性 (25)
Gtk.Window:application

与窗口关联的 GtkApplication

Gtk.Window:child

子微件。

Gtk.Window:decorated

窗口是否应当有框架(也称为“装饰”)。

Gtk.Window:default-height

窗口的默认高度。

Gtk.Window:default-widget

默认微件。

Gtk.Window:default-width

窗口的默认宽度。

Gtk.Window:deletable

窗口框架是否应当有关闭按钮。

Gtk.Window:destroy-with-parent

如果此窗口应当在父窗口被销毁时被销毁。

Gtk.Window:display

将显示此窗口的显示器。

Gtk.Window:focus-visible

是否当前在此窗口中显示了“焦点矩形”。

Gtk.Window:focus-widget

焦点微件。

Gtk.Window:fullscreened

窗口是否处于全屏状态。

Gtk.Window:handle-menubar-accel

窗口框架是否应当处理 F10 来激活菜单栏。

自:4.2

Gtk.Window:hide-on-close

如果用户单击关闭按钮,是否应当隐藏此窗口。

Gtk.Window:icon-name

指定要用作窗口图标的主题图标的名称。

Gtk.Window:is-active

顶级窗口是否是当前活动的窗口。

Gtk.Window:maximized

窗口是否已最大化。

Gtk.Window:mnemonics-visible

是否当前在此窗口中显示了助记符。

Gtk.Window:modal

如果为真,则窗口是模态的。

Gtk.Window:resizable

如果为真,则用户可以调整窗口.

Gtk.Window:startup-id

用于设置窗口启动通知标识符的只写属性.

Gtk.Window:suspended

窗口是否处于暂停状态.

since: 4.12

Gtk.Window:title

窗口的标题.

Gtk.Window:titlebar

标题栏小部件.

since: 4.6

Gtk.Window:transient-for

窗口的瞬态父窗体.

继承自 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 实现的可访问角色.

信号

Gtk.Assistant::apply

单击“应用”按钮时发出.

待淘汰:4.10 

Gtk.Assistant::cancel

单击取消按钮时发出.

待淘汰:4.10 

Gtk.Assistant::close

在摘要页面的关闭按钮被点击时或流程中最后一页(类型为GTK_ASSISTANT_PAGE_CONFIRM)中的“应用”按钮被点击时触发。

待淘汰:4.10 

Gtk.Assistant::escape

Escape 绑定的操作信号。

待淘汰:4.10 

Gtk.Assistant::prepare

在将新页面设置为助理的当前页面时触发,在使新页面可见之前触发。

待淘汰:4.10 

GtkWindow 继承的信号 (5)
GtkWindow::activate-default

用户激活默认小组件时触发。

GtkWindow::activate-focus

用户激活 window 当前聚焦的小组件时触发。

GtkWindow::close-request

用户点击窗口的关闭按钮时触发。

GtkWindow::enable-debugging

用户启用或禁用交互式调试时触发。

GtkWindow::keys-changed

与窗口相关联的加速器或助记键集发生更改时触发。

待淘汰:4.10 

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() 等函数设置时,会触发通知信号。