Struct gtk4::Assistant [−][src]
pub struct Assistant(_);Expand description
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
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.
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.
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
Returns the AssistantPage object for child.
child
a child of self
Returns
the AssistantPage for child
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.
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.
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
Switches the page to page_num.
Note that this will only be necessary in custom buttons,
as the self flow can be set with
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.
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
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.
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.
Emitted when then the cancel button is clicked.
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.
The action signal for the Escape binding.
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
Trait Implementations
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
Returns the type identifier of Self.
Auto Trait Implementations
impl RefUnwindSafe for Assistant
impl UnwindSafe for Assistant
Blanket Implementations
Mutably borrows from an owned value. Read more
Upcasts an object to a superclass or interface T. Read more
Upcasts an object to a reference of its superclass or interface T. Read more
Tries to downcast to a subclass or interface implementor T. Read more
Tries to downcast to a reference of its subclass or interface implementor T. Read more
Tries to cast to an object of type T. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast and upcast will do many checks at compile-time already. Read more
Tries to cast to reference to an object of type T. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast and upcast will do many checks at compile-time already. Read more
Casts to T unconditionally. Read more
Casts to &T unconditionally. Read more
Returns true if the object is an instance of (can be cast to) T.
pub fn set_property<'a, N, V>(
&self,
property_name: N,
value: V
) -> Result<(), BoolError> where
N: Into<&'a str>,
V: ToValue,
pub fn set_property_from_value<'a, N>(
&self,
property_name: N,
value: &Value
) -> Result<(), BoolError> where
N: Into<&'a str>,
pub fn set_properties_from_value(
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>
pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
N: Into<&'a str>,
pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
N: Into<&'a str>,
Safety Read more
Safety Read more
Safety Read more
Safety Read more
pub fn connect<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
N: Into<&'a str>,
F: 'static + Fn(&[Value]) -> Option<Value> + Send + Sync,
Same as connect but takes a SignalId instead of a signal name.
pub fn connect_local<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
N: Into<&'a str>,
F: 'static + Fn(&[Value]) -> Option<Value>,
Same as connect_local but takes a SignalId instead of a signal name.
pub unsafe fn connect_unsafe<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
N: Into<&'a str>,
F: Fn(&[Value]) -> Option<Value>,
Same as connect_unsafe but takes a SignalId instead of a signal name.
Emit signal by signal id.
Same as emit but takes Value for the arguments.
Emit signal by its name.
Same as emit_by_name but takes Value for the arguments.
Emit signal with details by signal id.
Same as emit_with_details but takes Value for the arguments.
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,
pub fn connect_notify_local<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec),
pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
pub fn bind_property<'a, O, N, M>(
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
O: ObjectType,
N: Into<&'a str>,
M: Into<&'a str>,
Returns a SendValue clone of self.