Assistant

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_assistant_get_type ()" ) ]
[ Version ( deprecated = true , deprecated_since = "4.10" ) ]
public sealed class Assistant : Window, Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager

Warning: Assistant is deprecated since 4.10.

`GtkAssistant` is used to represent a complex as a series of steps.

Note:

This widget will be removed in GTK 5

![An example GtkAssistant](assistant.png)

Each step consists of one or more pages. `GtkAssistant` guides the user through the pages, and controls the page flow to collect the data needed for the operation.

`GtkAssistant` handles which buttons to show and to make sensitive based on page sequence knowledge and the [enum@Gtk.AssistantPageType] of each page in addition to state information like the *completed* and *committed* page statuses.

If you have a case that doesn’t quite fit in `GtkAssistant`s way of handling buttons, you can use the gtk_assistant_page_custom page type and handle buttons yourself.

`GtkAssistant` maintains a `GtkAssistantPage` object for each added child, which holds additional per-child properties. You obtain the `GtkAssistantPage` for a child with [method@Gtk.Assistant.get_page].

GtkAssistant as GtkBuildable

The `GtkAssistant` implementation of the `GtkBuildable` interface exposes the action_area as internal children with the name “action_area”.

To add pages to an assistant in `GtkBuilder`, simply add it as a child to the `GtkAssistant` object. If you need to set per-object properties, create a `GtkAssistantPage` object explicitly, and set the child widget as a property on it.

CSS nodes

`GtkAssistant` has a single CSS node with the name window and style class .assistant.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public ListModel pages { owned get; }
`GListModel` containing the pages.
public int use_header_bar { get; construct; }
true if the assistant uses a `GtkHeaderBar` for action buttons instead of the action-area.

Creation methods:

public Assistant ()
Creates a new `GtkAssistant`.

Methods:

public void add_action_widget (Widget child)
Adds a widget to the action area of a `GtkAssistant`.
public int append_page (Widget page)
Appends a page to the this.
public void commit ()
Erases the visited page history.
public int get_current_page ()
Returns the page number of the current page.
public int get_n_pages ()
Returns the number of pages in the this
public unowned Widget? get_nth_page (int page_num)
Returns the child widget contained in page number page_num.
public unowned AssistantPage get_page (Widget child)
Returns the `GtkAssistantPage` object for child.
public bool get_page_complete (Widget page)
Gets whether page is complete.
public unowned string get_page_title (Widget page)
Gets the title for page.
public AssistantPageType get_page_type (Widget page)
Gets the page type of page.
public ListModel get_pages ()
Gets a list model of the assistant pages.
public int insert_page (Widget page, int position)
Inserts a page in the this at a given position.
public void next_page ()
Navigate to the next page.
public int prepend_page (Widget page)
Prepends a page to the this.
public void previous_page ()
Navigate to the previous visited page.
public void remove_action_widget (Widget child)
Removes a widget from the action area of a `GtkAssistant`.
public void remove_page (int page_num)
Removes the page_num’s page from this.
public void set_current_page (int page_num)
Switches the page to page_num.
public void set_forward_page_func (owned AssistantPageFunc? page_func)
Sets the page forwarding function to be page_func.
public void set_page_complete (Widget page, bool complete)
Sets whether page contents are complete.
public void set_page_title (Widget page, string title)
Sets a title for page.
public void set_page_type (Widget page, AssistantPageType type)
Sets the page type for page.
public void update_buttons_state ()
Forces this to recompute the buttons state.

Signals:

public signal void apply ()
Emitted when the apply button is clicked.
public signal void cancel ()
Emitted when then the cancel button is clicked.
public signal void close ()
Emitted either when the close button of a summary page is clicked, or when the apply button in the last page in the flow (of type gtk_assistant_page_confirm) is clicked.
public signal void escape ()
The action signal for the Escape binding.
public signal void prepare (Widget page)
Emitted when a new page is set as the assistant's current page, before making the new page visible.

Inherited Members:

All known members inherited from class Gtk.Window

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Buildable

All known members inherited from interface Gtk.Native

All known members inherited from interface Gtk.Root

get_display

get_focus

set_focus

All known members inherited from interface Gtk.ShortcutManager

add_controller

remove_controller