Struct gtk4::Overlay

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

Overlay is a container which contains a single main child, on top of which it can place “overlay” widgets.

The position of each overlay widget is determined by its property::Widget::halign and property::Widget::valign properties. E.g. a widget with both alignments set to Align::Start will be placed at the top left corner of the Overlay container, whereas an overlay with halign set to Align::Center and valign set to Align::End will be placed a the bottom edge of the Overlay, horizontally centered. The position can be adjusted by setting the margin properties of the child to non-zero values.

More complicated placement of overlays is possible by connecting to the signal::Overlay::get-child-position signal.

An overlay’s minimum and natural sizes are those of its main child. The sizes of overlay children are not considered when measuring these preferred sizes.

GtkOverlay as GtkBuildable

The Overlay implementation of the Buildable interface supports placing a child as an overlay by specifying “overlay” as the “type” attribute of a <child> element.

CSS nodes

Overlay has a single CSS node with the name “overlay”. Overlay children whose alignments cause them to be positioned at an edge get the style classes “.left”, “.right”, “.top”, and/or “.bottom” according to their position.

Implements

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

Implementations

impl Overlay

pub fn new() -> Overlay

Creates a new Overlay.

Returns

a new Overlay object.

pub fn builder() -> OverlayBuilder

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

This method returns an instance of OverlayBuilder which can be used to create Overlay objects.

pub fn add_overlay(&self, widget: &impl IsA<Widget>)

Adds @widget to @self.

The widget will be stacked on top of the main widget added with set_child().

The position at which @widget is placed is determined from its property::Widget::halign and property::Widget::valign properties.

widget

a Widget to be added to the container

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

Gets the child widget of @self.

Returns

the child widget of @self

pub fn is_clip_overlay(&self, widget: &impl IsA<Widget>) -> bool

Gets whether @widget should be clipped within the parent.

widget

an overlay child of Overlay

Returns

whether the widget is clipped within the parent.

pub fn is_measure_overlay(&self, widget: &impl IsA<Widget>) -> bool

Gets whether @widget’s size is included in the measurement of @self.

widget

an overlay child of Overlay

Returns

whether the widget is measured

pub fn remove_overlay(&self, widget: &impl IsA<Widget>)

Removes an overlay that was added with gtk_overlay_add_overlay().

widget

a Widget to be removed

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

Sets the child widget of @self.

child

the child widget

pub fn set_clip_overlay(&self, widget: &impl IsA<Widget>, clip_overlay: bool)

Sets whether @widget should be clipped within the parent.

widget

an overlay child of Overlay

clip_overlay

whether the child should be clipped

pub fn set_measure_overlay(&self, widget: &impl IsA<Widget>, measure: bool)

Sets whether @widget is included in the measured size of @self.

The overlay will request the size of the largest child that has this property set to true. Children who are not included may be drawn outside of @self’s allocation if they are too large.

widget

an overlay child of Overlay

measure

whether the child should be measured

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

impl Overlay

pub fn connect_get_child_position<F>(&self, f: F) -> SignalHandlerIdwhere F: Fn(&Self, &Widget) -> Option<Rectangle> + 'static,

Emitted to determine the position and size of any overlay child widgets.

A handler for this signal should fill @allocation with the desired position and size for @widget, relative to the ‘main’ child of @overlay.

The default handler for this signal uses the @widget’s halign and valign properties to determine the position and gives the widget its natural size (except that an alignment of Align::Fill will cause the overlay to be full-width/height). If the main child is a ScrolledWindow, the overlays are placed relative to its contents.

widget

the child widget to position

Returns

true if the @allocation has been filled

allocation

return location for the allocation

Trait Implementations

impl Clone for Overlay

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 Overlay

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

Formats the value using the given formatter.

impl Default for Overlay

fn default() -> Self

Returns the “default value” for a type.

impl Display for Overlay

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

Formats the value using the given formatter.

impl Hash for Overlay

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 Overlay

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 Overlay

type Parent = Widget

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

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 Overlay

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 Overlay

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Overlay

impl IsA<Accessible> for Overlay

impl IsA<Buildable> for Overlay

impl IsA<ConstraintTarget> for Overlay

impl IsA<Widget> for Overlay