Struct libhandy::Squeezer

pub struct Squeezer { /* private fields */ }

A best fit container.

The Squeezer widget is a container which only shows the first of its children that fits in the available size. It is convenient to offer different widgets to represent the same data with different levels of detail, making the widget seem to squeeze itself to fit in the available space.

Transitions between children can be animated as fades. This can be controlled with set_transition_type().

CSS nodes

Squeezer has a single CSS node with name squeezer.

Properties

homogeneous

Whether all children have the same size for the opposite orientation.

For example, if a squeezer is horizontal and is homogeneous, it will request the same height for all its children. If it isn’t, the squeezer may change size when a different child becomes visible.

Readable | Writeable

interpolate-size

Whether the squeezer interpolates its size when changing the visible child.

If TRUE, the squeezer will interpolate its size between the one of the previous visible child and the one of the new visible child, according to the set transition duration and the orientation, e.g. if the squeezer is horizontal, it will interpolate the its height.

Readable | Writeable

transition-duration

The animation duration, in milliseconds.

Readable | Writeable

transition-running

Whether a transition is currently running.

Readable

transition-type

The type of animation used for transitions between children.

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 child that is about to become current.

Readable | Writeable

visible-child

The currently visible child.

Readable

xalign

The horizontal alignment, from 0 (start) to 1 (end).

The xalign property determines the horizontal alignment of the children inside the squeezer’s size allocation. Compare this to halign, which determines how the squeezer’s size allocation is positioned in the space available for the squeezer.

This will affect the position of children too wide to fit in the squeezer as they are fading out.

Readable | Writeable

yalign

The vertical alignment, from 0 (start) to 1 (end).

The yalign property determines the vertical alignment of the children inside the squeezer’s size allocation. Compare this to valign, which determines how the squeezer’s size allocation is positioned in the space available for the squeezer.

This will affect the position of children too tall to fit in the squeezer as they are fading out.

Readable | Writeable

Container

border-width

Readable | Writeable

child

Writeable

resize-mode

Readable | Writeable

Widget

app-paintable

Readable | Writeable

can-default

Readable | Writeable

can-focus

Readable | Writeable

composite-child

Readable

double-buffered

Whether the widget is double buffered.

Readable | Writeable

events

Readable | Writeable

expand

Whether to expand in both directions. Setting this sets both #GtkWidget:hexpand and #GtkWidget:vexpand

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Before 3.20, several widgets (GtkButton, GtkFileChooserButton, GtkComboBox) implemented this property individually.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space, see #GtkAlign

Readable | Writeable

has-default

Readable | Writeable

has-focus

Readable | Writeable

has-tooltip

Enables or disables the emission of #GtkWidget::query-tooltip on @widget. A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using #GtkWidget::query-tooltip to determine whether it will provide a tooltip or not.

Note that setting this property to true for the first time will change the event masks of the GdkWindows of this widget to include leave-notify and motion-notify events. This cannot and will not be undone when the property is set to false again.

Readable | Writeable

height-request

Readable | Writeable

hexpand

Whether to expand horizontally. See gtk_widget_set_hexpand().

Readable | Writeable

hexpand-set

Whether to use the #GtkWidget:hexpand property. See gtk_widget_get_hexpand_set().

Readable | Writeable

is-focus

Readable | Writeable

margin

Sets all four sides’ margin at once. If read, returns max margin on any side.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally. This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-left

Margin on left side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-right

Margin on right side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally. This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

name

Readable | Writeable

no-show-all

Readable | Writeable

opacity

The requested opacity of the widget. See gtk_widget_set_opacity() for more details about window opacity.

Before 3.8 this was only available in GtkWindow

Readable | Writeable

parent

Readable | Writeable

receives-default

Readable | Writeable

scale-factor

The scale factor of the widget. See gtk_widget_get_scale_factor() for more details about widget scaling.

Readable

sensitive

Readable | Writeable

style

The style of the widget, which contains information about how it will look (colors, etc).

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. Also see gtk_tooltip_set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: #GtkWidget:has-tooltip will automatically be set to true and there will be taken care of #GtkWidget::query-tooltip in the default signal handler.

Note that if both #GtkWidget:tooltip-text and #GtkWidget:tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see gtk_tooltip_set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: #GtkWidget:has-tooltip will automatically be set to true and there will be taken care of #GtkWidget::query-tooltip in the default signal handler.

Note that if both #GtkWidget:tooltip-text and #GtkWidget:tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space, see #GtkAlign

Readable | Writeable

vexpand

Whether to expand vertically. See gtk_widget_set_vexpand().

Readable | Writeable

vexpand-set

Whether to use the #GtkWidget:vexpand property. See gtk_widget_get_vexpand_set().

Readable | Writeable

visible

Readable | Writeable

width-request

Readable | Writeable

window

The widget’s window if it is realized, None otherwise.

Readable

Orientable

orientation

The orientation of the orientable.

Readable | Writeable

Implements

gtk::prelude::ContainerExt, gtk::prelude::WidgetExt, glib::ObjectExt, gtk::prelude::BuildableExt, gtk::prelude::OrientableExt

Implementations

impl Squeezer

pub fn new() -> Squeezer

Creates a new Squeezer.

Returns

the newly created Squeezer

pub fn builder() -> SqueezerBuilder

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

This method returns an instance of SqueezerBuilder which can be used to create Squeezer objects.

pub fn is_child_enabled(&self, child: &impl IsA<Widget>) -> bool

Gets whether @child is enabled.

See set_child_enabled().

child

a child of @self

Returns

whether @child is enabled

pub fn is_homogeneous(&self) -> bool

Gets whether @self is homogeneous.

Returns

whether @self is homogeneous

pub fn is_interpolate_size(&self) -> bool

Gets whether @self should interpolate its size on visible child change.

Returns

whether @self interpolates its size on visible child change

pub fn transition_duration(&self) -> u32

Gets the amount of time that transitions between children will take.

Returns

the transition duration, in milliseconds

pub fn is_transition_running(&self) -> bool

Gets whether a transition is currently running for @self.

Returns

whether a transition is currently running

pub fn transition_type(&self) -> SqueezerTransitionType

Gets the animation type that will be used for transitions between children.

Returns

the current transition type of @self

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

Gets the currently visible child of @self.

Returns

the visible child

pub fn xalign(&self) -> f32

Gets the horizontal alignment.

Returns

the xalign property

pub fn yalign(&self) -> f32

Gets the vertical alignment.

Returns

the yalign property

pub fn set_child_enabled(&self, child: &impl IsA<Widget>, enabled: bool)

Sets whether @child is enabled.

If a child is disabled, it will be ignored when looking for the child fitting the available size best. This allows to programmatically and prematurely hide a child of @self even if it fits in the available space.

This can be used e.g. to ensure a certain child is hidden below a certain window width, or any other constraint you find suitable.

child

a child of @self

enabled

whether to enable the child

pub fn set_homogeneous(&self, homogeneous: bool)

Sets whether all children have the same size for the opposite orientation.

homogeneous

TRUE to make @self homogeneous

pub fn set_interpolate_size(&self, interpolate_size: bool)

Sets whether @self should interpolate its size on visible child change.

interpolate_size

TRUE to interpolate the size

pub fn set_transition_duration(&self, duration: u32)

Sets the duration that transitions between children in @self will take.

duration

the new duration, in milliseconds

pub fn set_transition_type(&self, transition: SqueezerTransitionType)

Sets the animation type that will be used for transitions between children.

transition

the new transition type

pub fn set_xalign(&self, xalign: f32)

Sets the horizontal alignment.

xalign

the new xalign value, between 0 and 1

pub fn set_yalign(&self, yalign: f32)

Sets the vertical alignment.

yalign

the new yalign value, between 0 and 1

pub fn connect_homogeneous_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_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_visible_child_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

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

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

Trait Implementations

impl Clone for Squeezer

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 Squeezer

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

Formats the value using the given formatter.

impl Default for Squeezer

fn default() -> Self

Returns the “default value” for a type.

impl Display for Squeezer

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

Formats the value using the given formatter.

impl HasParamSpec for Squeezer

type ParamSpec = ParamSpecObject

type SetValue = Squeezer

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Squeezer>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Squeezer

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Squeezer

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for Squeezer

type Parent = Container

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

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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 Squeezer

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Squeezer

impl IsA<Buildable> for Squeezer

impl IsA<Container> for Squeezer

impl IsA<Orientable> for Squeezer

impl IsA<Widget> for Squeezer