Struct gtk4::Assistant

#[repr(transparent)]
pub struct Assistant { /* private fields */ }

Assistant is used to represent a complex as a series of steps.

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

Assistant handles which buttons to show and to make sensitive based on page sequence knowledge and the 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 Assistants way of handling buttons, you can use the AssistantPageType::Custom page type and handle buttons yourself.

Assistant maintains a AssistantPage object for each added child, which holds additional per-child properties. You obtain the AssistantPage for a child with page().

GtkAssistant as GtkBuildable

The Assistant implementation of the Buildable interface exposes the @action_area as internal children with the name “action_area”.

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

CSS nodes

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

Implements

GtkWindowExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, NativeExt, RootExt, ShortcutManagerExt, WidgetExtManual, AccessibleExtManual

Implementations

impl Assistant

pub fn new() -> Assistant

Creates a new Assistant.

Returns

a newly created Assistant

pub fn builder() -> AssistantBuilder

Creates a new builder-pattern struct instance to construct Assistant objects.

This method returns an instance of AssistantBuilder which can be used to create Assistant objects.

pub fn add_action_widget(&self, child: &impl IsA<Widget>)

Adds a widget to the action area of a Assistant.

child

a Widget

pub fn append_page(&self, page: &impl IsA<Widget>) -> i32

Appends a page to the @self.

page

a Widget

Returns

the index (starting at 0) of the inserted page

pub fn commit(&self)

Erases the visited page history.

GTK will then hide the back button on the current page, and removes the cancel button from subsequent pages.

Use this when the information provided up to the current page is hereafter deemed permanent and cannot be modified or undone. For example, showing a progress page to track a long-running, unreversible operation after the user has clicked apply on a confirmation page.

pub fn current_page(&self) -> i32

Returns the page number of the current page.

Returns

The index (starting from 0) of the current page in the @self, or -1 if the @self has no pages, or no current page

pub fn n_pages(&self) -> i32

Returns the number of pages in the @self

Returns

the number of pages in the @self

pub fn nth_page(&self, page_num: i32) -> Option<Widget>

Returns the child widget contained in page number @page_num.

page_num

the index of a page in the @self, or -1 to get the last page

Returns

the child widget, or None if @page_num is out of bounds

pub fn page(&self, child: &impl IsA<Widget>) -> AssistantPage

Returns the AssistantPage object for @child.

child

a child of @self

Returns

the AssistantPage for @child

pub fn page_is_complete(&self, page: &impl IsA<Widget>) -> bool

Gets whether @page is complete.

page

a page of @self

Returns

true if @page is complete.

pub fn page_title(&self, page: &impl IsA<Widget>) -> GString

Gets the title for @page.

page

a page of @self

Returns

the title for @page

pub fn page_type(&self, page: &impl IsA<Widget>) -> AssistantPageType

Gets the page type of @page.

page

a page of @self

Returns

the page type of @page

pub fn pages(&self) -> ListModel

Gets a list model of the assistant pages.

Returns

A list model of the pages.

pub fn insert_page(&self, page: &impl IsA<Widget>, position: i32) -> i32

Inserts a page in the @self at a given position.

page

a Widget

position

the index (starting at 0) at which to insert the page, or -1 to append the page to the @self

Returns

the index (starting from 0) of the inserted page

pub fn next_page(&self)

Navigate to the next page.

It is a programming error to call this function when there is no next page.

This function is for use when creating pages of the AssistantPageType::Custom type.

pub fn prepend_page(&self, page: &impl IsA<Widget>) -> i32

Prepends a page to the @self.

page

a Widget

Returns

the index (starting at 0) of the inserted page

pub fn previous_page(&self)

Navigate to the previous visited page.

It is a programming error to call this function when no previous page is available.

This function is for use when creating pages of the AssistantPageType::Custom type.

pub fn remove_action_widget(&self, child: &impl IsA<Widget>)

Removes a widget from the action area of a Assistant.

child

a Widget

pub fn remove_page(&self, page_num: i32)

Removes the @page_num’s page from @self.

page_num

the index of a page in the @self, or -1 to remove the last page

pub fn set_current_page(&self, page_num: i32)

Switches the page to @page_num.

Note that this will only be necessary in custom buttons, as the @self flow can be set with gtk_assistant_set_forward_page_func().

page_num

index of the page to switch to, starting from 0. If negative, the last page will be used. If greater than the number of pages in the @self, nothing will be done.

pub fn set_forward_page_func<P: Fn(i32) -> i32 + 'static>(&self, page_func: P)

Sets the page forwarding function to be @page_func.

This function will be used to determine what will be the next page when the user presses the forward button. Setting @page_func to None will make the assistant to use the default forward function, which just goes to the next visible page.

page_func

the GtkAssistantPageFunc, or None to use the default one

pub fn set_page_complete(&self, page: &impl IsA<Widget>, complete: bool)

Sets whether @page contents are complete.

This will make @self update the buttons state to be able to continue the task.

page

a page of @self

complete

the completeness status of the page

pub fn set_page_title(&self, page: &impl IsA<Widget>, title: &str)

Sets a title for @page.

The title is displayed in the header area of the assistant when @page is the current page.

page

a page of @self

title

the new title for @page

pub fn set_page_type(&self, page: &impl IsA<Widget>, type_: AssistantPageType)

Sets the page type for @page.

The page type determines the page behavior in the @self.

page

a page of @self

type_

the new type for @page

pub fn update_buttons_state(&self)

Forces @self to recompute the buttons state.

GTK automatically takes care of this in most situations, e.g. when the user goes to a different page, or when the visibility or completeness of a page changes.

One situation where it can be necessary to call this function is when changing a value on the current page affects the future page flow of the assistant.

pub fn use_header_bar(&self) -> i32

true if the assistant uses a HeaderBar for action buttons instead of the action-area.

For technical reasons, this property is declared as an integer property, but you should only set it to true or false.

pub fn connect_apply<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted when the apply button is clicked.

The default behavior of the Assistant is to switch to the page after the current page, unless the current page is the last one.

A handler for the ::apply signal should carry out the actions for which the wizard has collected data. If the action takes a long time to complete, you might consider putting a page of type AssistantPageType::Progress after the confirmation page and handle this operation within the signal::Assistant::prepare signal of the progress page.

pub fn connect_cancel<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted when then the cancel button is clicked.

pub fn connect_close<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

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 AssistantPageType::Confirm) is clicked.

pub fn connect_escape<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

The action signal for the Escape binding.

pub fn emit_escape(&self)

pub fn connect_prepare<F: Fn(&Self, &Widget) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Emitted when a new page is set as the assistant’s current page, before making the new page visible.

A handler for this signal can do any preparations which are necessary before showing @page.

page

the current page

pub fn connect_pages_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

impl Assistant

pub fn unset_forward_page_func(&self)

Trait Implementations

impl Clone for Assistant

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Assistant

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Assistant

fn default() -> Self

Returns the “default value” for a type.

impl Display for Assistant

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Assistant

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Assistant

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl ParentClassIs for Assistant

type Parent = Window

impl<OT: ObjectType> PartialEq<OT> for Assistant

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<OT: ObjectType> PartialOrd<OT> for Assistant

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Assistant

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Assistant

impl IsA<Accessible> for Assistant

impl IsA<Buildable> for Assistant

impl IsA<ConstraintTarget> for Assistant

impl IsA<Native> for Assistant

impl IsA<Root> for Assistant

impl IsA<ShortcutManager> for Assistant

impl IsA<Widget> for Assistant

impl IsA<Window> for Assistant