Enum gtk::AssistantPageType

#[non_exhaustive]
pub enum AssistantPageType {
    Content,
    Intro,
    Confirm,
    Summary,
    Progress,
    Custom,
    // some variants omitted
}

An enum for determining the page role inside the Assistant. It’s used to handle buttons sensitivity and visibility.

Note that an assistant needs to end its page flow with a page of type Confirm, Summary or Progress to be correct.

The Cancel button will only be shown if the page isn’t “committed”. See AssistantExt::commit() for details.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Content

The page has regular contents. Both the Back and forward buttons will be shown.

Intro

The page contains an introduction to the assistant task. Only the Forward button will be shown if there is a next page.

Confirm

The page lets the user confirm or deny the changes. The Back and Apply buttons will be shown.

Summary

The page informs the user of the changes done. Only the Close button will be shown.

Progress

Used for tasks that take a long time to complete, blocks the assistant until the page is marked as complete. Only the back button will be shown.

Custom

Used for when other page types are not appropriate. No buttons will be shown, and the application must add its own buttons through AssistantExt::add_action_widget().

Trait Implementations

impl Clone for AssistantPageType

fn clone(&self) -> AssistantPageType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AssistantPageType

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

Formats the value using the given formatter.

impl Display for AssistantPageType

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

Formats the value using the given formatter.

impl<'a> FromValue<'a> for AssistantPageType

type Checker = GenericValueTypeChecker<AssistantPageType>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl Hash for AssistantPageType

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

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 AssistantPageType

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<AssistantPageType> for AssistantPageType

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<AssistantPageType> for AssistantPageType

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

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

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

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

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

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

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

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

const 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 AssistantPageType

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for AssistantPageType

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl ValueType for AssistantPageType

type Type = AssistantPageType

Type to get the Type from.

impl Copy for AssistantPageType

impl Eq for AssistantPageType

impl StructuralEq for AssistantPageType

impl StructuralPartialEq for AssistantPageType