Struct gtk4::Stack[−][src]

pub struct Stack(_);

Expand description

Stack is a container which only shows one of its children at a time.

In contrast to Notebook, Stack does not provide a means for users to change the visible child. Instead, a separate widget such as StackSwitcher or StackSidebar can be used with Stack to provide this functionality.

Transitions between pages can be animated as slides or fades. This can be controlled with set_transition_type(). These animations respect the property::Settings::gtk-enable-animations setting.

Stack maintains a StackPage object for each added child, which holds additional per-child properties. You obtain the StackPage for a child with page() and you can obtain a SelectionModel containing all the pages with pages().

GtkStack as GtkBuildable

To set child-specific properties in a .ui file, create StackPage objects explicitly, and set the child widget as a property on it:

  <object class="GtkStack" id="stack">
    <child>
      <object class="GtkStackPage">
        <property name="name">page1</property>
        <property name="title">In the beginning…</property>
        <property name="child">
          <object class="GtkLabel">
            <property name="label">It was dark</property>
          </object>
        </property>
      </object>
    </child>

CSS nodes

Stack has a single CSS node named stack.

Accessibility

Stack uses the AccessibleRole::TabPanel for the stack pages, which are the accessible parent objects of the child widgets.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

Implementations

impl Stack

pub fn new() -> Stack

Creates a new Stack.

Returns

pub fn builder() -> StackBuilder

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

This method returns an instance of StackBuilder which can be used to create Stack objects.

pub fn add_child<P: IsA<Widget>>(&self, child: &P) -> StackPage

Adds a child to self.

`child`

the widget to add

Returns

the StackPage for child

pub fn add_named<P: IsA<Widget>>(
    &self, 
    child: &P, 
    name: Option<&str>
) -> StackPage

Adds a child to self.

The child is identified by the name.

`child`

the widget to add

`name`

the name for child or None

Returns

the StackPage for child

pub fn add_titled<P: IsA<Widget>>(
    &self, 
    child: &P, 
    name: Option<&str>, 
    title: &str
) -> StackPage

Adds a child to self.

The child is identified by the name. The title will be used by StackSwitcher to represent child in a tab bar, so it should be short.

`child`

the widget to add

`name`

the name for child

`title`

a human-readable title for child

Returns

the StackPage for child

pub fn child_by_name(&self, name: &str) -> Option<Widget>

Finds the child with the name given as the argument.

Returns None if there is no child with this name.

`name`

the name of the child to find

Returns

the requested child of the Stack

pub fn is_hhomogeneous(&self) -> bool

Gets whether self is horizontally homogeneous.

Returns

whether self is horizontally homogeneous.

pub fn interpolates_size(&self) -> bool

Returns whether the Stack is set up to interpolate between the sizes of children on page switch.

Returns

true if child sizes are interpolated

pub fn page<P: IsA<Widget>>(&self, child: &P) -> Option<StackPage>

Returns the StackPage object for child.

`child`

a child of self

Returns

the StackPage for child

pub fn pages(&self) -> SelectionModel

Returns a GListModel that contains the pages of the stack.

This can be used to keep an up-to-date view. The model also implements SelectionModel and can be used to track and modify the visible page.

Returns

a SelectionModel for the stack’s children

pub fn transition_duration(&self) -> u32

Returns the amount of time (in milliseconds) that transitions between pages in self will take.

Returns

the transition duration

pub fn is_transition_running(&self) -> bool

Returns whether the self is currently in a transition from one page to another.

Returns

true if the transition is currently running, false otherwise.

pub fn transition_type(&self) -> StackTransitionType

Gets the type of animation that will be used for transitions between pages in self.

Returns

the current transition type of self

pub fn is_vhomogeneous(&self) -> bool

Gets whether self is vertically homogeneous.

Returns

whether self is vertically homogeneous.

pub fn visible_child(&self) -> Option<Widget>

Gets the currently visible child of self.

Returns None if there are no visible children.

Returns

the visible child of the Stack

pub fn visible_child_name(&self) -> Option<GString>

Returns the name of the currently visible child of self.

Returns None if there is no visible child.

Returns

the name of the visible child of the Stack

pub fn remove<P: IsA<Widget>>(&self, child: &P)

Removes a child widget from self.

`child`

the child to remove

pub fn set_hhomogeneous(&self, hhomogeneous: bool)

Sets the Stack to be horizontally homogeneous or not.

If it is homogeneous, the Stack will request the same width for all its children. If it isn’t, the stack may change width when a different child becomes visible.

`hhomogeneous`

true to make self horizontally homogeneous

pub fn set_interpolate_size(&self, interpolate_size: bool)

Sets whether or not self will interpolate its size when changing the visible child.

If the property::Stack::interpolate-size property is set to true, self will interpolate its size between the current one and the one it’ll take after changing the visible child, according to the set transition duration.

`interpolate_size`

the new value

pub fn set_transition_duration(&self, duration: u32)

Sets the duration that transitions between pages in self will take.

`duration`

the new duration, in milliseconds

pub fn set_transition_type(&self, transition: StackTransitionType)

Sets the type of animation that will be used for transitions between pages in self.

Available types include various kinds of fades and slides.

The transition type can be changed without problems at runtime, so it is possible to change the animation based on the page that is about to become current.

`transition`

the new transition type

pub fn set_vhomogeneous(&self, vhomogeneous: bool)

Sets the Stack to be vertically homogeneous or not.

If it is homogeneous, the Stack will request the same height for all its children. If it isn’t, the stack may change height when a different child becomes visible.

`vhomogeneous`

true to make self vertically homogeneous

pub fn set_visible_child<P: IsA<Widget>>(&self, child: &P)

Makes child the visible child of self.

If child is different from the currently visible child, the transition between the two will be animated with the current transition type of self.

Note that the child widget has to be visible itself (see WidgetExt::show()) in order to become the visible child of self.

`child`

a child of self

pub fn set_visible_child_full(
    &self, 
    name: &str, 
    transition: StackTransitionType
)

Makes the child with the given name visible.

Note that the child widget has to be visible itself (see WidgetExt::show()) in order to become the visible child of self.

`name`

the name of the child to make visible

`transition`

the transition type to use

pub fn set_visible_child_name(&self, name: &str)

Makes the child with the given name visible.

If child is different from the currently visible child, the transition between the two will be animated with the current transition type of self.

Note that the child widget has to be visible itself (see WidgetExt::show()) in order to become the visible child of self.

`name`

the name of the child to make visible

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

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for Stack

fn clone(&self) -> Stack

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

impl Debug for Stack

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

Formats the value using the given formatter. Read more

impl Default for Stack

fn default() -> Self

Returns the “default value” for a type. Read more

impl Display for Stack

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

Formats the value using the given formatter. Read more

impl Hash for Stack

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

Feeds this value into the given Hasher. Read more

1.3.0[src]

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

Feeds a slice of this type into the given Hasher. Read more

impl Ord for Stack

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

This method returns an Ordering between self and other. Read more

1.21.0[src]

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

Compares and returns the maximum of two values. Read more

1.21.0[src]

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

Compares and returns the minimum of two values. Read more

1.50.0[src]

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

Restrict a value to a certain interval. Read more

impl ParentClassIs for Stack

type Parent = Widget

impl<T: ObjectType> PartialEq<T> for Stack

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

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

1.0.0[src]

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

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for Stack

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

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

1.0.0[src]

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

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

1.0.0[src]

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

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

1.0.0[src]

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

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

1.0.0[src]

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

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

impl StaticType for Stack

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Stack

impl IsA<Accessible> for Stack

impl IsA<Buildable> for Stack

impl IsA<ConstraintTarget> for Stack

impl IsA<Widget> for Stack

impl StructuralEq for Stack

Auto Trait Implementations

impl RefUnwindSafe for Stack

impl !Send for Stack

impl !Sync for Stack

impl Unpin for Stack

impl UnwindSafe for Stack

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized,

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Cast for T where
    T: ObjectType,

fn upcast<T>(self) -> T where
    Self: IsA<T>,
    T: ObjectType,

Upcasts an object to a superclass or interface T. Read more

fn upcast_ref<T>(&self) -> &T where
    Self: IsA<T>,
    T: ObjectType,

Upcasts an object to a reference of its superclass or interface T. Read more

fn downcast<T>(self) -> Result<T, Self> where
    Self: CanDowncast<T>,
    T: ObjectType,

Tries to downcast to a subclass or interface implementor T. Read more

fn downcast_ref<T>(&self) -> Option<&T> where
    Self: CanDowncast<T>,
    T: ObjectType,

Tries to downcast to a reference of its subclass or interface implementor T. Read more

fn dynamic_cast<T>(self) -> Result<T, Self> where
    T: ObjectType,

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

fn dynamic_cast_ref<T>(&self) -> Option<&T> where
    T: ObjectType,

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

unsafe fn unsafe_cast<T>(self) -> T where
    T: ObjectType,

Casts to T unconditionally. Read more

unsafe fn unsafe_cast_ref<T>(&self) -> &T where
    T: ObjectType,

Casts to &T unconditionally. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>,

pub fn into(self) -> U

Performs the conversion.

impl<T> ObjectExt for T where
    T: ObjectType,

pub fn is<U>(&self) -> bool where
    U: StaticType,

Returns true if the object is an instance of (can be cast to) T.

pub fn type_(&self) -> Type

pub fn object_class(&self) -> &Class<Object>

pub fn class(&self) -> &Class<T> where
    T: IsClass,

pub fn class_of<U>(&self) -> Option<&Class<U>> where
    U: IsClass,

pub fn interface<U>(&self) -> Option<InterfaceRef<'_, U>> where
    U: IsInterface,

pub fn set_property<'a, N, V>(
    &self, 
    property_name: N, 
    value: V
) -> Result<(), BoolError> where
    V: ToValue,
    N: Into<&'a str>,

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(
    &self, 
    property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>

pub fn set_properties_from_value(
    &self, 
    property_values: &[(&str, Value)]
) -> Result<(), BoolError>

pub fn property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where
    N: Into<&'a str>,

pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
    N: Into<&'a str>,

pub fn property_type<'a, N>(&self, property_name: N) -> Option<Type> where
    N: Into<&'a str>,

pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
    N: Into<&'a str>,

pub fn list_properties(&self) -> Vec<ParamSpec, Global>

pub fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

pub unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where
    QD: 'static,

Safety Read more

pub unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>> where
    QD: 'static,

Safety Read more

pub unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
    QD: 'static,

Safety Read more

pub unsafe fn set_data<QD>(&self, key: &str, value: QD) where
    QD: 'static,

Safety Read more

pub unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>> where
    QD: 'static,

Safety Read more

pub unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
    QD: 'static,

Safety Read more

pub fn block_signal(&self, handler_id: &SignalHandlerId)

pub fn unblock_signal(&self, handler_id: &SignalHandlerId)

pub fn stop_signal_emission(&self, signal_name: &str)

pub fn connect<'a, N, F>(
    &self, 
    signal_name: N, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
    N: Into<&'a str>,

pub fn connect_id<F>(
    &self, 
    signal_id: SignalId, 
    details: Option<Quark>, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

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
    F: Fn(&[Value]) -> Option<Value> + 'static,
    N: Into<&'a str>,

pub fn connect_local_id<F>(
    &self, 
    signal_id: SignalId, 
    details: Option<Quark>, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value> + 'static,

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
    F: Fn(&[Value]) -> Option<Value>,
    N: Into<&'a str>,

pub unsafe fn connect_unsafe_id<F>(
    &self, 
    signal_id: SignalId, 
    details: Option<Quark>, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value>,

Same as connect_unsafe but takes a SignalId instead of a signal name.

pub fn emit(
    &self, 
    signal_id: SignalId, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>

Emit signal by signal id.

pub fn emit_with_values(
    &self, 
    signal_id: SignalId, 
    args: &[Value]
) -> Result<Option<Value>, BoolError>

Same as emit but takes Value for the arguments.

pub fn emit_by_name<'a, N>(
    &self, 
    signal_name: N, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
    N: Into<&'a str>,

Emit signal by its name.

pub fn emit_by_name_with_values<'a, N>(
    &self, 
    signal_name: N, 
    args: &[Value]
) -> Result<Option<Value>, BoolError> where
    N: Into<&'a str>,

Same as emit_by_name but takes Value for the arguments.

pub fn emit_with_details(
    &self, 
    signal_id: SignalId, 
    details: Quark, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>

Emit signal with details by signal id.

pub fn emit_with_details_and_values(
    &self, 
    signal_id: SignalId, 
    details: Quark, 
    args: &[Value]
) -> Result<Option<Value>, BoolError>

Same as emit_with_details but takes Value for the arguments.

pub fn disconnect(&self, handler_id: SignalHandlerId)

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 notify<'a, N>(&self, property_name: N) where
    N: Into<&'a str>,

pub fn notify_by_pspec(&self, pspec: &ParamSpec)

pub fn downgrade(&self) -> WeakRef<T>

pub fn bind_property<'a, O, N, M>(
    &'a self, 
    source_property: N, 
    target: &'a O, 
    target_property: M
) -> BindingBuilder<'a> where
    O: ObjectType,
    M: Into<&'a str>,
    N: Into<&'a str>,

pub fn ref_count(&self) -> u32

impl<T> ToOwned for T where
    T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToSendValue for T where
    T: Send + ToValue + ?Sized,

pub fn to_send_value(&self) -> SendValue

Returns a SendValue clone of self.

impl<T> ToString for T where
    T: Display + ?Sized,

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<Super, Sub> CanDowncast<Sub> for Super where
    Sub: IsA<Super>,
    Super: IsA<Super>,

impl<'a, T, C> FromValueOptional<'a> for T where
    C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,
    T: FromValue<'a, Checker = C>,