[−][src]Trait gtk::AssistantExt
Required methods
fn add_action_widget<P: IsA<Widget>>(&self, child: &P)
fn append_page<P: IsA<Widget>>(&self, page: &P) -> i32
fn commit(&self)
Erases the visited page history so the back button is not shown 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.
fn get_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.
fn get_n_pages(&self) -> i32
fn get_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
fn get_page_complete<P: IsA<Widget>>(&self, page: &P) -> bool
fn get_page_has_padding<P: IsA<Widget>>(&self, page: &P) -> bool
fn get_page_title<P: IsA<Widget>>(&self, page: &P) -> Option<GString>
fn get_page_type<P: IsA<Widget>>(&self, page: &P) -> AssistantPageType
fn insert_page<P: IsA<Widget>>(&self, page: &P, 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
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.
fn prepend_page<P: IsA<Widget>>(&self, page: &P) -> i32
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.
fn remove_action_widget<P: IsA<Widget>>(&self, child: &P)
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
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
AssistantExt::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.
fn set_forward_page_func(
&self,
page_func: Option<Box_<dyn Fn(i32) -> i32 + 'static>>
)
&self,
page_func: Option<Box_<dyn Fn(i32) -> i32 + 'static>>
)
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
data
user data for page_func
destroy
destroy notifier for data
fn set_page_complete<P: IsA<Widget>>(&self, page: &P, 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
fn set_page_has_padding<P: IsA<Widget>>(&self, page: &P, has_padding: bool)
Sets whether the assistant is adding padding around the page.
Feature: v3_18
page
a page of self
has_padding
whether this page has padding
fn set_page_title<P: IsA<Widget>>(&self, page: &P, 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
fn set_page_type<P: IsA<Widget>>(&self, page: &P, 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
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.
fn get_property_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
.
fn get_child_complete<T: IsA<Widget>>(&self, item: &T) -> bool
fn set_child_complete<T: IsA<Widget>>(&self, item: &T, complete: bool)
fn get_child_has_padding<T: IsA<Widget>>(&self, item: &T) -> bool
fn set_child_has_padding<T: IsA<Widget>>(&self, item: &T, has_padding: bool)
fn get_child_page_type<T: IsA<Widget>>(&self, item: &T) -> AssistantPageType
fn set_child_page_type<T: IsA<Widget>>(
&self,
item: &T,
page_type: AssistantPageType
)
&self,
item: &T,
page_type: AssistantPageType
)
fn get_child_title<T: IsA<Widget>>(&self, item: &T) -> Option<GString>
fn set_child_title<T: IsA<Widget>>(&self, item: &T, title: Option<&str>)
fn connect_apply<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId
The ::apply signal is 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 Assistant::prepare
signal of the progress
page.
fn connect_cancel<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId
The ::cancel signal is emitted when then the cancel button is clicked.
fn connect_close<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId
The ::close signal is 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.
fn connect_escape<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId
fn emit_escape(&self)
fn connect_prepare<F: Fn(&Self, &Widget) + 'static>(
&self,
f: F
) -> SignalHandlerId
&self,
f: F
) -> SignalHandlerId
The ::prepare signal is 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
Implementors
impl<O: IsA<Assistant>> AssistantExt for O
[src]
fn add_action_widget<P: IsA<Widget>>(&self, child: &P)
[src]
fn append_page<P: IsA<Widget>>(&self, page: &P) -> i32
[src]
fn commit(&self)
[src]
fn get_current_page(&self) -> i32
[src]
fn get_n_pages(&self) -> i32
[src]
fn get_nth_page(&self, page_num: i32) -> Option<Widget>
[src]
fn get_page_complete<P: IsA<Widget>>(&self, page: &P) -> bool
[src]
fn get_page_has_padding<P: IsA<Widget>>(&self, page: &P) -> bool
[src]
fn get_page_title<P: IsA<Widget>>(&self, page: &P) -> Option<GString>
[src]
fn get_page_type<P: IsA<Widget>>(&self, page: &P) -> AssistantPageType
[src]
fn insert_page<P: IsA<Widget>>(&self, page: &P, position: i32) -> i32
[src]
fn next_page(&self)
[src]
fn prepend_page<P: IsA<Widget>>(&self, page: &P) -> i32
[src]
fn previous_page(&self)
[src]
fn remove_action_widget<P: IsA<Widget>>(&self, child: &P)
[src]
fn remove_page(&self, page_num: i32)
[src]
fn set_current_page(&self, page_num: i32)
[src]
fn set_forward_page_func(
&self,
page_func: Option<Box_<dyn Fn(i32) -> i32 + 'static>>
)
[src]
&self,
page_func: Option<Box_<dyn Fn(i32) -> i32 + 'static>>
)
fn set_page_complete<P: IsA<Widget>>(&self, page: &P, complete: bool)
[src]
fn set_page_has_padding<P: IsA<Widget>>(&self, page: &P, has_padding: bool)
[src]
fn set_page_title<P: IsA<Widget>>(&self, page: &P, title: &str)
[src]
fn set_page_type<P: IsA<Widget>>(&self, page: &P, type_: AssistantPageType)
[src]
fn update_buttons_state(&self)
[src]
fn get_property_use_header_bar(&self) -> i32
[src]
fn get_child_complete<T: IsA<Widget>>(&self, item: &T) -> bool
[src]
fn set_child_complete<T: IsA<Widget>>(&self, item: &T, complete: bool)
[src]
fn get_child_has_padding<T: IsA<Widget>>(&self, item: &T) -> bool
[src]
fn set_child_has_padding<T: IsA<Widget>>(&self, item: &T, has_padding: bool)
[src]
fn get_child_page_type<T: IsA<Widget>>(&self, item: &T) -> AssistantPageType
[src]
fn set_child_page_type<T: IsA<Widget>>(
&self,
item: &T,
page_type: AssistantPageType
)
[src]
&self,
item: &T,
page_type: AssistantPageType
)
fn get_child_title<T: IsA<Widget>>(&self, item: &T) -> Option<GString>
[src]
fn set_child_title<T: IsA<Widget>>(&self, item: &T, title: Option<&str>)
[src]
fn connect_apply<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId
[src]
fn connect_cancel<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId
[src]
fn connect_close<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId
[src]
fn connect_escape<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId
[src]
fn emit_escape(&self)
[src]
fn connect_prepare<F: Fn(&Self, &Widget) + 'static>(
&self,
f: F
) -> SignalHandlerId
[src]
&self,
f: F
) -> SignalHandlerId