Struct wayland_protocols::xdg_shell::client::xdg_surface::XdgSurface

pub struct XdgSurface(_);

Implementations

impl XdgSurface

pub fn destroy(&self)

destroy the xdg_surface

Destroy the xdg_surface object. An xdg_surface must only be destroyed after its role object has been destroyed.

This is a destructor, you cannot send requests to this object any longer once this method is called.

pub fn get_toplevel<F>(&self, implementor: F) -> Result<XdgToplevel, ()> where
    F: FnOnce(NewProxy<XdgToplevel>) -> XdgToplevel, 

assign the xdg_toplevel surface role

This creates an xdg_toplevel object for the given xdg_surface and gives the associated wl_surface the xdg_toplevel role.

See the documentation of xdg_toplevel for more details about what an xdg_toplevel is and how it is used.

pub fn get_popup<F>(
    &self,
    parent: Option<&XdgSurface>,
    positioner: &XdgPositioner,
    implementor: F
) -> Result<XdgPopup, ()> where
    F: FnOnce(NewProxy<XdgPopup>) -> XdgPopup, 

assign the xdg_popup surface role

This creates an xdg_popup object for the given xdg_surface and gives the associated wl_surface the xdg_popup role.

If null is passed as a parent, a parent surface must be specified using some other protocol, before committing the initial state.

See the documentation of xdg_popup for more details about what an xdg_popup is and how it is used.

pub fn set_window_geometry(&self, x: i32, y: i32, width: i32, height: i32)

set the new window geometry

The window geometry of a surface is its "visible bounds" from the user's perspective. Client-side decorations often have invisible portions like drop-shadows which should be ignored for the purposes of aligning, placing and constraining windows.

The window geometry is double buffered, and will be applied at the time wl_surface.commit of the corresponding wl_surface is called.

When maintaining a position, the compositor should treat the (x, y) coordinate of the window geometry as the top left corner of the window. A client changing the (x, y) window geometry coordinate should in general not alter the position of the window.

Once the window geometry of the surface is set, it is not possible to unset it, and it will remain the same until set_window_geometry is called again, even if a new subsurface or buffer is attached.

If never set, the value is the full bounds of the surface, including any subsurfaces. This updates dynamically on every commit. This unset is meant for extremely simple clients.

The arguments are given in the surface-local coordinate space of the wl_surface associated with this xdg_surface.

The width and height must be greater than zero. Setting an invalid size will raise an error. When applied, the effective window geometry will be the set window geometry clamped to the bounding rectangle of the combined geometry of the surface of the xdg_surface and the associated subsurfaces.

pub fn ack_configure(&self, serial: u32)

ack a configure event

When a configure event is received, if a client commits the surface in response to the configure event, then the client must make an ack_configure request sometime before the commit request, passing along the serial of the configure event.

For instance, for toplevel surfaces the compositor might use this information to move a surface to the top left only when the client has drawn itself for the maximized or fullscreen state.

If the client receives multiple configure events before it can respond to one, it only has to ack the last configure event.

A client is not required to commit immediately after sending an ack_configure request - it may even ack_configure several times before its next surface commit.

A client may send multiple ack_configure requests before committing, but only the last request sent before a commit indicates which configure event the client really is responding to.

Trait Implementations

impl AsRef<Proxy<XdgSurface>> for XdgSurface

fn as_ref(&self) -> &Proxy<Self>

Performs the conversion.

impl Clone for XdgSurface

fn clone(&self) -> XdgSurface

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for XdgSurface

impl From<Proxy<XdgSurface>> for XdgSurface

fn from(value: Proxy<Self>) -> Self

Performs the conversion.

impl From<XdgSurface> for Proxy<XdgSurface>

fn from(value: XdgSurface) -> Self

Performs the conversion.

impl<T: EventHandler> HandledBy<T> for XdgSurface

fn handle(__handler: &mut T, event: Event, __object: Self)

Handles an event.

impl Interface for XdgSurface

type Request = Request

Set of requests associated to this interface

type Event = Event

Set of events associated to this interface

const NAME: &'static str

Name of this interface

const VERSION: u32

Maximum supported version of this interface

fn c_interface() -> *const wl_interface

Pointer to the C representation of this interface

impl PartialEq<XdgSurface> for XdgSurface

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for XdgSurface

impl StructuralPartialEq for XdgSurface