PopupLayout

class PopupLayout(**kwargs)

The GdkPopupLayout 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 get_position_x, get_position_y, get_rect_anchor and get_surface_anchor after the popup has been presented. This can be used to adjust the rendering. For example, GtkPopover 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.

Constructors

class PopupLayout

classmethod new(anchor_rect: Rectangle, rect_anchor: Gravity, surface_anchor: Gravity) → PopupLayout

Create a popup layout description.

Used together with 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.

Parameters:

• anchor_rect – the anchor GdkRectangle 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

Methods

class PopupLayout

equal(other: PopupLayout) → bool

Check whether layout and other has identical layout properties.

Parameters:

other – another GdkPopupLayout

get_anchor_hints() → AnchorHints

Get the GdkAnchorHints.

get_anchor_rect() → Rectangle

Get the anchor rectangle.

get_offset() → tuple[int, int]

Retrieves the offset for the anchor rectangle.

get_rect_anchor() → Gravity

Returns the anchor position on the anchor rectangle.

get_shadow_width() → tuple[int, int, int, int]

Obtains the shadow widths of this layout.

Added in version 4.2.

get_surface_anchor() → Gravity

Returns the anchor position on the popup surface.

set_anchor_hints(anchor_hints: AnchorHints) → None

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, FLIP_X will replace NORTH_WEST with NORTH_EAST and vice versa if surface extends beyond the left or right edges of the monitor.

Parameters:

anchor_hints – the new GdkAnchorHints

set_anchor_rect(anchor_rect: Rectangle) → None

Set the anchor rectangle.

Parameters:

anchor_rect – the new anchor rectangle

set_offset(dx: int, dy: int) → None

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

Parameters:

• dx – x delta to offset the anchor rectangle with

• dy – y delta to offset the anchor rectangle with

set_rect_anchor(anchor: Gravity) → None

Set the anchor on the anchor rectangle.

Parameters:

anchor – the new rect anchor

set_shadow_width(left: int, right: int, top: int, bottom: int) → None

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.

Added in version 4.2.

Parameters:

• 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

set_surface_anchor(anchor: Gravity) → None

Set the anchor on the popup surface.

Parameters:

anchor – the new popup surface anchor