Struct gtk4::ConstraintGuide

pub struct ConstraintGuide { /* private fields */ }

A ConstraintGuide is an invisible layout element in a ConstraintLayout.

The ConstraintLayout treats guides like widgets. They can be used as the source or target of a Constraint.

Guides have a minimum, maximum and natural size. Depending on the constraints that are applied, they can act like a guideline that widgets can be aligned to, or like flexible space.

Unlike a Widget, a ConstraintGuide will not be drawn.

Properties

max-height

The maximum height of the guide.

Readable | Writeable

max-width

The maximum width of the guide.

Readable | Writeable

min-height

The minimum height of the guide.

Readable | Writeable

min-width

The minimum width of the guide.

Readable | Writeable

name

A name that identifies the ConstraintGuide, for debugging.

Readable | Writeable

nat-height

The preferred, or natural, height of the guide.

Readable | Writeable

nat-width

The preferred, or natural, width of the guide.

Readable | Writeable

strength

The ConstraintStrength to be used for the constraint on the natural size of the guide.

Readable | Writeable

Implements

[trait@glib::ObjectExt], ConstraintTargetExt

Implementations

impl ConstraintGuide

pub fn new() -> ConstraintGuide

Creates a new ConstraintGuide object.

Returns

a new ConstraintGuide object.

pub fn builder() -> ConstraintGuideBuilder

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

This method returns an instance of ConstraintGuideBuilder which can be used to create ConstraintGuide objects.

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

Retrieves the name set using gtk_constraint_guide_set_name().

Returns

the name of the guide

pub fn strength(&self) -> ConstraintStrength

Retrieves the strength set using gtk_constraint_guide_set_strength().

Returns

the strength of the constraint on the natural size

pub fn set_max_size(&self, width: i32, height: i32)

Sets the maximum size of @self.

If @self is attached to a ConstraintLayout, the constraints will be updated to reflect the new size.

width

the new maximum width, or -1 to not change it

height

the new maximum height, or -1 to not change it

pub fn set_min_size(&self, width: i32, height: i32)

Sets the minimum size of @self.

If @self is attached to a ConstraintLayout, the constraints will be updated to reflect the new size.

width

the new minimum width, or -1 to not change it

height

the new minimum height, or -1 to not change it

pub fn set_name(&self, name: Option<&str>)

Sets a name for the given ConstraintGuide.

The name is useful for debugging purposes.

name

a name for the @self

pub fn set_nat_size(&self, width: i32, height: i32)

Sets the natural size of @self.

If @self is attached to a ConstraintLayout, the constraints will be updated to reflect the new size.

width

the new natural width, or -1 to not change it

height

the new natural height, or -1 to not change it

pub fn set_strength(&self, strength: ConstraintStrength)

Sets the strength of the constraint on the natural size of the given ConstraintGuide.

strength

the strength of the constraint

pub fn max_height(&self) -> i32

The maximum height of the guide.

pub fn set_max_height(&self, max_height: i32)

The maximum height of the guide.

pub fn max_width(&self) -> i32

The maximum width of the guide.

pub fn set_max_width(&self, max_width: i32)

The maximum width of the guide.

pub fn min_height(&self) -> i32

The minimum height of the guide.

pub fn set_min_height(&self, min_height: i32)

The minimum height of the guide.

pub fn min_width(&self) -> i32

The minimum width of the guide.

pub fn set_min_width(&self, min_width: i32)

The minimum width of the guide.

pub fn nat_height(&self) -> i32

The preferred, or natural, height of the guide.

pub fn set_nat_height(&self, nat_height: i32)

The preferred, or natural, height of the guide.

pub fn nat_width(&self) -> i32

The preferred, or natural, width of the guide.

pub fn set_nat_width(&self, nat_width: i32)

The preferred, or natural, width of the guide.

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

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

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

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

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

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

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

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

impl ConstraintGuide

pub fn max_size(&self) -> (i32, i32)

Gets the maximum size of @self.

Returns

width

return location for the maximum width

height

return location for the maximum height

pub fn min_size(&self) -> (i32, i32)

Gets the minimum size of @self.

Returns

width

return location for the minimum width

height

return location for the minimum height

pub fn nat_size(&self) -> (i32, i32)

Gets the natural size of @self.

Returns

width

return location for the natural width

height

return location for the natural height

Trait Implementations

impl Clone for ConstraintGuide

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 ConstraintGuide

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

Formats the value using the given formatter.

impl Default for ConstraintGuide

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for ConstraintGuide

type ParamSpec = ParamSpecObject

type SetValue = ConstraintGuide

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ConstraintGuide

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 ConstraintGuide

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 ConstraintGuide

type Parent = Object

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

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 ConstraintGuide

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 ConstraintGuide

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ConstraintGuide

impl IsA<ConstraintTarget> for ConstraintGuide