Struct XdgSurface

pub struct XdgSurface { /* private fields */ }

An XdgSurface is the common base to the different surfaces in the XdgShell (ex: XdgToplevel, XdgPopup).

Implementations

impl XdgSurface

pub fn new(id: ObjectId) -> Self

Creates a new XdgSurface.

pub fn surface_ref(&self) -> ObjectRef<Surface>

Returns a reference to the underlying Surface for this XdgSurface.

pub fn root_surface_ref(&self) -> ObjectRef<Surface>

Returns a reference to the root Surface for this XdgSurface.

pub fn set_xdg_role(&mut self, xdg_role: XdgSurfaceRole) -> Result<(), Error>

Sets the concrete role for this XdgSurface.

Similar to Surface, an XdgSurface isn’t of much use until a role has been assigned.

pub fn configure( this: ObjectRef<Self>, client: &mut Client, ) -> Result<(), Error>

Performs a surface configuration sequence.

Each concrete XdgSurface role configuration sequence is concluded and committed by a xdg_surface::configure event.

pub fn finalize_commit( this: ObjectRef<Self>, client: &mut Client, ) -> Result<bool, Error>

Handle a commit request to this XdgSurface.

This will be triggered by a wl_surface::commit request to the backing wl_surface object for this xdg_surface, and simply delegates the request to the concrete surface.

pub fn shutdown(&self, client: &Client)

Trait Implementations

impl RequestReceiver<XdgSurface> for XdgSurface

fn receive( this: ObjectRef<Self>, request: XdgSurfaceRequest, client: &mut Client, ) -> Result<(), Error>

Handle a decoded message for the associated |Interface|.