Class (GI Struct)

Gdk-4.0GdkPopupLayout

Contains information that is necessary position a Gdk.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.

Popup anchors

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.

Flipping popups

Sliding popups

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 Gdk.Popup.get_position_x, Gdk.Popup.get_position_y, Gdk.Popup.get_rect_anchor and Gdk.Popup.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.

Index

Constructors

Properties

Methods

  • Check whether layout and other has identical layout properties.

    Parameters

    Returns boolean

    true if layout and other have identical layout properties, otherwise false.

  • Retrieves the offset for the anchor rectangle.

    Returns [number, number]

  • Obtains the shadow widths of this layout.

    Returns [number, number, number, number]

  • 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, GDK_ANCHOR_FLIP_X will replace GDK_GRAVITY_NORTH_WEST with GDK_GRAVITY_NORTH_EAST and vice versa if surface extends beyond the left or right edges of the monitor.

    Parameters

    Returns void

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

    Parameters

    • dx: number

      x delta to offset the anchor rectangle with

    • dy: number

      y delta to offset the anchor rectangle with

    Returns void

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

    Parameters

    • left: number

      width of the left part of the shadow

    • right: number

      width of the right part of the shadow

    • top: number

      height of the top part of the shadow

    • bottom: number

      height of the bottom part of the shadow

    Returns void