Struct XxInputPopupPositionerV1

pub struct XxInputPopupPositionerV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

input method popup positioner

The input_popup_positioner provides a collection of rules for the placement of an input method popup surface relative to the cursor. Rules can be defined to ensure the text input area remains within the visible area’s borders, and to specify how the popup changes its position, such as sliding along an axis, or flipping around a rectangle. These positioner-created rules are constrained by the requirement that a popup must intersect with or be at least partially adjacent to the surface containing the text input.

See the various requests for details about possible rules.

A newly created positioner has the following state:

• 0 surface width
• 0 surface height
• anchor at the center (“none”)
• gravity towards the center (“none”)
• constraints adjustment set to none
• offset at x = 0, y = 0
• not reactive

Upon receiving a request taking the positioner as an argument, the compositor makes a copy of the rules specified by the input_popup_positioner. Thus, after the request is complete the input_popup_positioner object can be destroyed or reused; further changes to the object will have no effect on previous usages.

For an input_popup_positioner object to be considered complete, its state must contain a non-zero width and height. Passing an incomplete input_popup_positioner object when positioning a surface raises an invalid_positioner error.

This interface has no events.

Implementations

impl 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 Borrow<ObjectId> for XxInputPopupPositionerV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for XxInputPopupPositionerV1

fn clone(&self) -> XxInputPopupPositionerV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XxInputPopupPositionerV1

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

Formats the value using the given formatter.

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 Hash for XxInputPopupPositionerV1

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Weak<XxInputPopupPositionerV1>> for XxInputPopupPositionerV1

fn eq(&self, other: &Weak<XxInputPopupPositionerV1>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for XxInputPopupPositionerV1

fn eq(&self, other: &XxInputPopupPositionerV1) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Proxy for XxInputPopupPositionerV1

type Request<'request> = Request<'request>

The request enum for this interface

type Event = Event

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U>(&self) -> Option<&U>

where U: Send + Sync + 'static,

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn ObjectData>>

Access the raw data associated with this object.

fn backend(&self) -> &WeakBackend

Access the backend associated with this object

fn send_request( &self, req: <XxInputPopupPositionerV1 as Proxy>::Request<'_>, ) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I>( &self, req: <XxInputPopupPositionerV1 as Proxy>::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>

where I: Proxy,

Send a request for this object that creates another object.

fn from_id( conn: &Connection, id: ObjectId, ) -> Result<XxInputPopupPositionerV1, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> XxInputPopupPositionerV1

Create an inert object proxy

fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(XxInputPopupPositionerV1, <XxInputPopupPositionerV1 as Proxy>::Event), DispatchError>

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: <XxInputPopupPositionerV1 as Proxy>::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>

Serialize a request for this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for XxInputPopupPositionerV1