Struct AspectFrame

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 aspectframe.

Accessibility

Until GTK 4.10, AspectFrame used the GTK_ACCESSIBLE_ROLE_GROUP role.

Starting from GTK 4.12, AspectFrame uses the GTK_ACCESSIBLE_ROLE_GENERIC role.

Properties

child

The child widget.

Readable | Writeable

obey-child

Whether the AspectFrame should use the aspect ratio of its child.

Readable | Writeable

ratio

The aspect ratio to be used by the AspectFrame.

This property is only used if obey-child is set to false.

Readable | Writeable

xalign

The horizontal alignment of the child.

Readable | Writeable

yalign

The vertical alignment of the child.

Readable | Writeable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

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.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

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

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

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 WidgetExt::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 WidgetExt::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 WidgetExt::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 WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

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

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

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

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

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

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Implements

WidgetExt, [trait@glib::ObjectExt], AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

GLib type: GObject with reference counted clone semantics.

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 requisition 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

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 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 HasParamSpec for AspectFrame

type ParamSpec = ParamSpecObject

type SetValue = AspectFrame

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for AspectFrame

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 AspectFrame

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 AspectFrame

type Parent = Widget

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

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 AspectFrame

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 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