Struct PopupPositioner

pub struct PopupPositioner(/* private fields */);

Available on crate feature wayland and Linux only.

A trivial wrapper for an XxInputPopupPositionerV1.

This wrapper calls destroy on the contained positioner when it is dropped.

Methods from Deref<Target = XxInputPopupPositionerV1>

pub fn destroy(&self)

destroy the input_popup_positioner object

Notify the compositor that the positioner will no longer be used.

pub fn set_size(&self, width: u32, height: u32)

set the size of the to-be positioned rectangle

Set the size of the surface that is to be positioned with the positioner object. The size is in surface-local coordinates and corresponds to the window geometry. See xdg_surface.set_window_geometry.

If any dimension is set to zero, the invalid_input error is raised.

pub fn set_anchor(&self, anchor: Anchor)

set anchor rectangle anchor

Defines the anchor point for the anchor rectangle. The specified anchor is used to derive an anchor point that the popup surface will be positioned relative to. If a corner anchor is set (e.g. ‘top_left’ or ‘bottom_right’), the anchor point will be at the specified corner; otherwise, the derived anchor point will be centered on the specified edge, or in the center of the anchor rectangle if no edge is specified.

pub fn set_gravity(&self, gravity: Gravity)

set surface gravity

Defines in what direction the surface should be positioned, relative to the anchor point of the anchor rectangle. If a corner gravity is specified (e.g. ‘bottom_right’ or ‘top_left’), then the surface will be placed towards the specified gravity; otherwise, the child surface will be centered over the anchor point on any axis that had no gravity specified. If the gravity is not in the ‘gravity’ enum, an invalid_input error is raised.

pub fn set_constraint_adjustment( &self, constraint_adjustment: ConstraintAdjustment, )

set the adjustment to be done when constrained

Specify how the popup should be positioned if the originally intended position caused the surface to be constrained, meaning at least partially outside positioning boundaries set by the compositor. The adjustment is set by constructing a bitmask describing the adjustment to be made when the surface is constrained on that axis.

If no bit for one axis is set, the compositor will assume that the child surface should not change its position on that axis when constrained.

If more than one bit for one axis is set, the order of how adjustments are applied is specified in the corresponding adjustment descriptions.

The default adjustment is none.

pub fn set_offset(&self, x: i32, y: i32)

set surface position offset

Specify the surface position offset relative to the position of the anchor on the anchor rectangle and the anchor on the surface. For example if the anchor of the anchor rectangle is at (x, y), the surface has the gravity bottom|right, and the offset is (ox, oy), the calculated surface position will be (x + ox, y + oy). The offset position of the surface is the one used for constraint testing. See set_constraint_adjustment.

An example use case is placing a popup menu on top of a user interface element, while aligning the user interface element of the parent surface with some user interface element placed somewhere in the popup surface.

pub fn set_reactive(&self)

continuously reconstrain the surface

When set reactive, the surface is reconstrained if the conditions used for constraining changed, e.g. the window containing the text input moved.

Whenever the conditions change and the popup gets reconstrained, a configure sequence is sent with updated geometry.

Trait Implementations

impl Debug for PopupPositioner

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

Formats the value using the given formatter.

impl Deref for PopupPositioner

type Target = XxInputPopupPositionerV1

The resulting type after dereferencing.

fn deref(&self) -> &<PopupPositioner as Deref>::Target

Dereferences the value.

impl<D> Dispatch<XxInputPopupPositionerV1, PositionerData, D> for PopupPositioner

where D: Dispatch<XxInputPopupPositionerV1, PositionerData> + InputMethodHandler,

fn event( _data: &mut D, _manager: &XxInputPopupPositionerV1, _event: Event, _: &PositionerData, _conn: &Connection, _qh: &QueueHandle<D>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, _qhandle: &QueueHandle<State>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Drop for PopupPositioner

fn drop(&mut self)

Executes the destructor for this type.