Struct gtk4::AspectFrame

#[repr(transparent)]
pub struct AspectFrame { /* private fields */ }

AspectFrame preserves the aspect ratio of its child.

The frame can respect the aspect ratio of the child widget, or use its own aspect ratio.

CSS nodes

AspectFrame uses a CSS node with name frame.

Implements

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

Implementations

impl AspectFrame

pub fn new( xalign: f32, yalign: f32, ratio: f32, obey_child: bool ) -> AspectFrame

Create a new AspectFrame.

xalign

Horizontal alignment of the child within the parent. Ranges from 0.0 (left aligned) to 1.0 (right aligned)

yalign

Vertical alignment of the child within the parent. Ranges from 0.0 (top aligned) to 1.0 (bottom aligned)

ratio

The desired aspect ratio.

obey_child

If true, @ratio is ignored, and the aspect ratio is taken from the requistion of the child.

Returns

the new AspectFrame.

pub fn builder() -> AspectFrameBuilder

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

This method returns an instance of AspectFrameBuilder which can be used to create AspectFrame objects.

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

Gets the child widget of @self.

Returns

the child widget of self@

pub fn is_obey_child(&self) -> bool

Returns whether the child’s size request should override the set aspect ratio of the AspectFrame.

Returns

whether to obey the child’s size request

pub fn ratio(&self) -> f32

Returns the desired aspect ratio of the child.

Returns

the desired aspect ratio

pub fn xalign(&self) -> f32

Returns the horizontal alignment of the child within the allocation of the AspectFrame.

Returns

the horizontal alignment

pub fn yalign(&self) -> f32

Returns the vertical alignment of the child within the allocation of the AspectFrame.

Returns

the vertical alignment

pub fn set_child(&self, child: Option<&impl IsA<Widget>>)

Sets the child widget of @self.

child

the child widget

pub fn set_obey_child(&self, obey_child: bool)

Sets whether the aspect ratio of the child’s size request should override the set aspect ratio of the AspectFrame.

obey_child

If true, @ratio is ignored, and the aspect ratio is taken from the requistion of the child.

pub fn set_ratio(&self, ratio: f32)

Sets the desired aspect ratio of the child.

ratio

aspect ratio of the child

pub fn set_xalign(&self, xalign: f32)

Sets the horizontal alignment of the child within the allocation of the AspectFrame.

xalign

horizontal alignment, from 0.0 (left aligned) to 1.0 (right aligned)

pub fn set_yalign(&self, yalign: f32)

Sets the vertical alignment of the child within the allocation of the AspectFrame.

yalign

horizontal alignment, from 0.0 (top aligned) to 1.0 (bottom aligned)

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

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

pub fn connect_ratio_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 AspectFrame

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 AspectFrame

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

Formats the value using the given formatter.

impl Default for AspectFrame

fn default() -> Self

Returns the “default value” for a type.

impl Display for AspectFrame

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

Formats the value using the given formatter.

impl Hash for AspectFrame

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 AspectFrame

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl ParentClassIs for AspectFrame

type Parent = Widget

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

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 AspectFrame

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 AspectFrame

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for AspectFrame

impl IsA<Accessible> for AspectFrame

impl IsA<Buildable> for AspectFrame

impl IsA<ConstraintTarget> for AspectFrame

impl IsA<Widget> for AspectFrame