Struct ClampLayout

pub struct ClampLayout { /* private fields */ }

A layout manager constraining its children to a given size.

ClampLayout constraints the size of the widgets it contains to a given maximum size. It will constrain the width if it is horizontal, or the height if it is vertical. The expansion of the children from their minimum to their maximum size is eased out for a smooth transition.

If a child requires more than the requested maximum size, it will be allocated the minimum size it can fit in instead.

ClampLayout can scale with the text scale factor, use the unit property to enable that behavior.

See also: Clamp, ClampScrollable.

Properties

maximum-size

The maximum size to allocate to the children.

It is the width if the layout is horizontal, or the height if it is vertical.

Readable | Writeable

tightening-threshold

The size above which the children are clamped.

Starting from this size, the layout will tighten its grip on the children, slowly allocating less and less of the available size up to the maximum allocated size. Below that threshold and below the maximum size, the children will be allocated all the available size.

If the threshold is greater than the maximum size to allocate to the children, they will be allocated the whole size up to the maximum. If the threshold is lower than the minimum size to allocate to the children, that size will be used as the tightening threshold.

Effectively, tightening the grip on a child before it reaches its maximum size makes transitions to and from the maximum size smoother when resizing.

Readable | Writeable

unit

The length unit for maximum size and tightening threshold.

Allows the sizes to vary depending on the text scale factor.

Readable | Writeable

Orientable

orientation

The orientation of the orientable.

Readable | Writeable

Implements

gtk::prelude::LayoutManagerExt, [trait@glib::ObjectExt], gtk::prelude::OrientableExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl ClampLayout

pub fn new() -> ClampLayout

Creates a new ClampLayout.

Returns

the newly created ClampLayout

pub fn builder() -> ClampLayoutBuilder

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

This method returns an instance of ClampLayoutBuilder which can be used to create ClampLayout objects.

pub fn maximum_size(&self) -> i32

Gets the maximum size allocated to the children.

Returns

the maximum size to allocate to the children

pub fn tightening_threshold(&self) -> i32

Gets the size above which the children are clamped.

Returns

the size above which the children are clamped

pub fn unit(&self) -> LengthUnit

Available on crate feature v1_4 only.

Gets the length unit for maximum size and tightening threshold.

Returns

the length unit

pub fn set_maximum_size(&self, maximum_size: i32)

Sets the maximum size allocated to the children.

It is the width if the layout is horizontal, or the height if it is vertical.

maximum_size

the maximum size

pub fn set_tightening_threshold(&self, tightening_threshold: i32)

Sets the size above which the children are clamped.

Starting from this size, the layout will tighten its grip on the children, slowly allocating less and less of the available size up to the maximum allocated size. Below that threshold and below the maximum size, the children will be allocated all the available size.

If the threshold is greater than the maximum size to allocate to the children, they will be allocated the whole size up to the maximum. If the threshold is lower than the minimum size to allocate to the children, that size will be used as the tightening threshold.

Effectively, tightening the grip on a child before it reaches its maximum size makes transitions to and from the maximum size smoother when resizing.

tightening_threshold

the tightening threshold

pub fn set_unit(&self, unit: LengthUnit)

Available on crate feature v1_4 only.

Sets the length unit for maximum size and tightening threshold.

Allows the sizes to vary depending on the text scale factor.

unit

the length unit

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

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

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

Available on crate feature v1_4 only.

Trait Implementations

impl Clone for ClampLayout

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for ClampLayout

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

Formats the value using the given formatter.

impl Default for ClampLayout

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for ClampLayout

type ParamSpec = ParamSpecObject

type SetValue = ClampLayout

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ClampLayout

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

where H: Hasher,

Hashes the memory address of this object.

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 ClampLayout

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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,

Restrict a value to a certain interval.

impl ParentClassIs for ClampLayout

type Parent = LayoutManager

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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

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

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ClampLayout

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ClampLayout

impl IsA<LayoutManager> for ClampLayout

impl IsA<Orientable> for ClampLayout