Struct XxInputPopupSurfaceV2

pub struct XxInputPopupSurfaceV2 { /* private fields */ }

Available on crate feature wayland and Linux only.

popup surface

An input method popup surface is a short-lived, temporary surface. It is meant as an area to show suggestions, candidates, or for other input-related uses.

The compositor should anchor it at the active text input cursor area.

The client must call wl_surface.commit on the corresponding wl_surface for input_popup_surface state updates to take effect, unless otherwise noted.

After the initial wl_surface.commit, the compositor must reply with a configure sequence (see .start_configure) initializing all the compositor-provided state of the popup. That means providing values for:

• width
• height
• anchor_x
• anchor_y
• anchor_width
• anchor_height
• serial

using the appropriate events.

The popup will only be presented to the user after the client receives the configure sequence and replies with .ack_configure.

An example init sequence could look like this:

1. client (Cl): popup = input_method.get_popup(wl_surface, positioner)
2. Cl: wl_surface.commit()
3. compositor (Co): popup.start_configure(150, 150, 10, -2, 5, 30)
4. Co: input_method.done()
5. Cl: ack_configure()
6. Cl: wl_surface.commit()

A newly created input_popup_surface will be stacked on top of all previously created input_popup_surfaces associated with the same text input.

A typical sequence resulting from the user selecting a new text field and typing some text:

1. compositor (Co): input_method.enable()
2. Co: input_method.done()
3. [init sequence]
4. Co: input_method.set_surrounding_text(“new text”)
5. Co: popup.start_configure(150, 150, -60, -2, 55, 30)
6. Co: input_method.done()
7. client (Cl): ack_configure()
8. Cl: wl_surface.commit()

When the corresponding input_method receives a commited .disable event, the popup gets destroyed and becomes invalid and its surface gets unmapped.

The client must not destroy the underlying wl_surface while the xx_input_popup_surface_v2 object exists.

See also the Event enum for this interface.

Implementations

impl XxInputPopupSurfaceV2

pub fn ack_configure(&self, serial: u32)

acknowledge a configure sequence

This request notifies the compositor that the client updated its surface in response to a configure sequence.

The purpose of this request is to synchronize the updates of the surface geometry with the surface contents. For example, when the compositor assigns a size larger than prevously, the client must fill the additional space before the popup gets displayed to the user with the new size. When the compositor receives .ack_configure, it can proceed to draw the new size.

.ack_configure should be sent after every submitted configure sequence, passing along the serial received in it.

An .ack_configure request is conceptually double-buffered. Every request overrides the previous one. The request takes effect once the .commit request is sent on the corresponding surface.

If the client receives multiple configure sequences before it can respond to one, it may acknowledge only the last configure sequence by using its serial in the .ack_configure request.

Committing an .ack_configure request consumes the serial number sent with the request, as well as serial numbers sent by all configure sequences submitted on this input_popup_surface prior to the configure sequence referenced by the committed serial.

Committing this request with a serial that, for this surface, never appeared in a submitted configure sequence, or one that was already committed before, raises an invalid_serial error.

pub fn reposition(&self, positioner: &XxInputPopupPositionerV1, token: u32)

recalculate the popup’s location

Reposition an already-mapped popup. The popup will be placed given the details in the passed input_popup_positioner object.

The request is processed immediately, without the need to issue wl_surface.commit, but the actual repositioning takes place later, after .ack_configure.

The compositor should reply with a configure sequence including:

• input_popup_surface.start_configure,
• input_popup_surface.repositioned, including the token passed in this request.

This will discard any parameters set by the previous positioner.

If multiple .reposition requests are sent before the .repositioned event is submitted as part of a configure sequence, the compositor may ignore all but the last one.

The new popup position will not take effect until the corresponding configure sequence is acknowledged by the client. See input_popup_surface.repositioned for details.

The token itself is opaque, and has no other special meaning.

pub fn destroy(&self)

remove the popup

This destroys the popup. Explicitly destroying the input_popup_surface object will also dismiss the popup, and unmap the surface.

Trait Implementations

impl Borrow<ObjectId> for XxInputPopupSurfaceV2

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for XxInputPopupSurfaceV2

fn clone(&self) -> XxInputPopupSurfaceV2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XxInputPopupSurfaceV2

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

Formats the value using the given formatter.

impl<D> Dispatch<XxInputPopupSurfaceV2, PopupData, D> for Popup

where D: Dispatch<XxInputPopupSurfaceV2, PopupData> + InputMethodHandler,

fn event( _data: &mut D, popup: &XxInputPopupSurfaceV2, event: Event, udata: &PopupData, _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 XxInputPopupSurfaceV2

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<XxInputPopupSurfaceV2>> for XxInputPopupSurfaceV2

fn eq(&self, other: &Weak<XxInputPopupSurfaceV2>) -> 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 XxInputPopupSurfaceV2

fn eq(&self, other: &XxInputPopupSurfaceV2) -> 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 XxInputPopupSurfaceV2

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: <XxInputPopupSurfaceV2 as Proxy>::Request<'_>, ) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I>( &self, req: <XxInputPopupSurfaceV2 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<XxInputPopupSurfaceV2, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> XxInputPopupSurfaceV2

Create an inert object proxy

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

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: <XxInputPopupSurfaceV2 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 XxInputPopupSurfaceV2