Struct gdk4::PopupLayout

pub struct PopupLayout(_);

The PopupLayout struct contains information that is necessary position a Popup relative to its parent.

The positioning requires a negotiation with the windowing system, since it depends on external constraints, such as the position of the parent surface, and the screen dimensions.

The basic ingredients are a rectangle on the parent surface, and the anchor on both that rectangle and the popup. The anchors specify a side or corner to place next to each other.

For cases where placing the anchors next to each other would make the popup extend offscreen, the layout includes some hints for how to resolve this problem. The hints may suggest to flip the anchor position to the other side, or to ‘slide’ the popup along a side, or to resize it.

These hints may be combined.

Ultimatively, it is up to the windowing system to determine the position and size of the popup. You can learn about the result by calling PopupExt::position_x(), PopupExt::position_y(), PopupExt::rect_anchor() and PopupExt::surface_anchor() after the popup has been presented. This can be used to adjust the rendering. For example, Gtk::Popover changes its arrow position accordingly. But you have to be careful avoid changing the size of the popover, or it has to be presented again.

Implementations

impl PopupLayout

pub fn new(
    anchor_rect: &Rectangle,
    rect_anchor: Gravity,
    surface_anchor: Gravity
) -> PopupLayout

Create a popup layout description.

Used together with PopupExt::present() to describe how a popup surface should be placed and behave on-screen.

anchor_rect is relative to the top-left corner of the surface’s parent. rect_anchor and surface_anchor determine anchor points on anchor_rect and surface to pin together.

The position of anchor_rect’s anchor point can optionally be offset using set_offset(), which is equivalent to offsetting the position of surface.

anchor_rect

the anchor Rectangle to align surface with

rect_anchor

the point on anchor_rect to align with surface’s anchor point

surface_anchor

the point on surface to align with rect’s anchor point

Returns

newly created instance of PopupLayout

pub fn copy(&self) -> Option<PopupLayout>

Makes a copy of self.

Returns

a copy of self.

pub fn anchor_hints(&self) -> AnchorHints

Get the AnchorHints.

Returns

the AnchorHints

pub fn anchor_rect(&self) -> Option<Rectangle>

Get the anchor rectangle.

Returns

The anchor rectangle

pub fn rect_anchor(&self) -> Gravity

Returns the anchor position on the anchor rectangle.

Returns

the anchor on the anchor rectangle.

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

This is supported on crate feature v4_2 only.

Obtains the shadow widths of this layout.

Returns

left

return location for the left shadow width

right

return location for the right shadow width

top

return location for the top shadow width

bottom

return location for the bottom shadow width

pub fn surface_anchor(&self) -> Gravity

Returns the anchor position on the popup surface.

Returns

the anchor on the popup surface.

pub fn set_anchor_hints(&self, anchor_hints: AnchorHints)

Set new anchor hints.

The set anchor_hints determines how surface will be moved if the anchor points cause it to move off-screen. For example, AnchorHints::FLIP_X will replace Gravity::NorthWest with Gravity::NorthEast and vice versa if surface extends beyond the left or right edges of the monitor.

anchor_hints

the new AnchorHints

pub fn set_anchor_rect(&self, anchor_rect: &Rectangle)

Set the anchor rectangle.

anchor_rect

the new anchor rectangle

pub fn set_offset(&self, dx: i32, dy: i32)

Offset the position of the anchor rectangle with the given delta.

dx

x delta to offset the anchor rectangle with

dy

y delta to offset the anchor rectangle with

pub fn set_rect_anchor(&self, anchor: Gravity)

Set the anchor on the anchor rectangle.

anchor

the new rect anchor

pub fn set_shadow_width(&self, left: i32, right: i32, top: i32, bottom: i32)

This is supported on crate feature v4_2 only.

Sets the shadow width of the popup.

The shadow width corresponds to the part of the computed surface size that would consist of the shadow margin surrounding the window, would there be any.

left

width of the left part of the shadow

right

width of the right part of the shadow

top

height of the top part of the shadow

bottom

height of the bottom part of the shadow

pub fn set_surface_anchor(&self, anchor: Gravity)

Set the anchor on the popup surface.

anchor

the new popup surface anchor

impl PopupLayout

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

Retrieves the offset for the anchor rectangle.

Returns

dx

return location for the delta X coordinate

dy

return location for the delta Y coordinate

Trait Implementations

impl Clone for PopupLayout

fn clone(&self) -> PopupLayout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PopupLayout

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

Formats the value using the given formatter.

impl Hash for PopupLayout

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for PopupLayout

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<PopupLayout> for PopupLayout

fn eq(&self, other: &Self) -> 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 !=.

impl PartialOrd<PopupLayout> for PopupLayout

fn partial_cmp(&self, other: &PopupLayout) -> 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 PopupLayout

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PopupLayout