gdk4/org.gtkkn.bindings.gdk/PopupLayout

PopupLayout

class PopupLayout(val gdkPopupLayoutPointer: <Error class: unknown class><<Error class: unknown class>>)(source)

The GdkPopupLayout struct contains information that is necessary position a iface@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 method@Gdk.Popup.get_position_x, method@Gdk.Popup.get_position_y, method@Gdk.Popup.get_rect_anchor and method@Gdk.Popup.get_surface_anchor after the popup has been presented. This can be used to adjust the rendering. For example, ../gtk4/class.Popover.html 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.

Skipped during bindings generation

  • parameter dx: dx: Out parameter is not supported

  • parameter left: left: Out parameter is not supported

Constructors

Link copied to clipboard
constructor(anchorRect: Rectangle, rectAnchor: Gravity, surfaceAnchor: Gravity)

Create a popup layout description.

constructor(gdkPopupLayoutPointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val gdkPopupLayoutPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

Link copied to clipboard
fun copy(): PopupLayout

Makes a copy of @layout.

Link copied to clipboard
fun equal(other: PopupLayout): Boolean

Check whether @layout and @other has identical layout properties.

Link copied to clipboard
fun getAnchorHints(): AnchorHints

Get the GdkAnchorHints.

Link copied to clipboard
fun getAnchorRect(): Rectangle

Get the anchor rectangle.

Link copied to clipboard
fun getRectAnchor(): Gravity

Returns the anchor position on the anchor rectangle.

Link copied to clipboard
fun getSurfaceAnchor(): Gravity

Returns the anchor position on the popup surface.

Link copied to clipboard
fun ref(): PopupLayout

Increases the reference count of @value.

Link copied to clipboard
fun setAnchorHints(anchorHints: AnchorHints)

Set new anchor hints.

Link copied to clipboard
fun setAnchorRect(anchorRect: Rectangle)

Set the anchor rectangle.

Link copied to clipboard
fun setOffset(dx: <Error class: unknown class>, dy: <Error class: unknown class>)

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

Link copied to clipboard
fun setRectAnchor(anchor: Gravity)

Set the anchor on the anchor rectangle.

Link copied to clipboard
fun setShadowWidth(    left: <Error class: unknown class>,     right: <Error class: unknown class>,     top: <Error class: unknown class>,     bottom: <Error class: unknown class>)

Sets the shadow width of the popup.

Link copied to clipboard
fun setSurfaceAnchor(anchor: Gravity)

Set the anchor on the popup surface.

Link copied to clipboard
fun unref()

Decreases the reference count of @value.