Struct wayland_server::protocol::wl_shell_surface::WlShellSurface

pub struct WlShellSurface { /* fields omitted */ }

Methods

impl WlShellSurface

fn ping(&self, serial: u32) -> EventResult<()>

ping client

Ping a client to check if it is receiving events and sending requests. A client is expected to reply with a pong request.

fn configure(&self, edges: Resize, width: i32, height: i32) -> EventResult<()>

suggest resize

The configure event asks the client to resize its surface.

The size is a hint, in the sense that the client is free to ignore it if it doesn't resize, pick a smaller size (to satisfy aspect ratio or resize in steps of NxM pixels).

The edges parameter provides a hint about how the surface was resized. The client may use this information to decide how to adjust its content to the new size (e.g. a scrolling area might adjust its content position to leave the viewable content unmoved).

The client is free to dismiss all but the last configure event it received.

The width and height arguments specify the size of the window in surface-local coordinates.

fn popup_done(&self) -> EventResult<()>

popup interaction is done

The popup_done event is sent out when a popup grab is broken, that is, when the user clicks a surface that doesn't belong to the client owning the popup surface.

Trait Implementations

impl Send for WlShellSurface

impl Sync for WlShellSurface

impl Resource for WlShellSurface

fn ptr(&self) -> *mut wl_resource

Pointer to the underlying wayland proxy object

unsafe fn from_ptr_new(ptr: *mut wl_resource) -> WlShellSurface

Create an instance from a wayland pointer

unsafe fn from_ptr_initialized(ptr: *mut wl_resource) -> WlShellSurface

Create an instance from a wayland pointer

fn interface_ptr() -> *const wl_interface

Pointer to the interface representation

fn interface_name() -> &'static str

Internal wayland name of this interface

fn supported_version() -> u32

Max version of this interface supported

fn version(&self) -> i32

Current version of the interface this resource is instantiated with

fn status(&self) -> Liveness

Check if the resource behind this handle is actually still alive

fn equals(&self, other: &WlShellSurface) -> bool

Check of two handles are actually the same wayland object

fn set_user_data(&self, ptr: *mut ())

Set a pointer associated as user data on this resource

fn get_user_data(&self) -> *mut ()

Get the pointer associated as user data on this resource

unsafe fn clone_unchecked(&self) -> WlShellSurface

Unsafely clone this resource handle

fn post_error(&self, error_code: u32, msg: String)

Posts a protocol error to this resource

fn clone(&self) -> Option<Self> where
    Self: Sized, 

Clone this resource handle

fn same_client_as<R: Resource>(&self, other: &R) -> bool

Checks wether this resource and the other are from the same client

impl<ID: 'static> Implementable<ID> for WlShellSurface

type Implementation = Implementation<ID>

The type containing the implementation for the event callbacks

unsafe fn __dispatch_msg(
    &self,
    client: &Client,
    opcode: u32,
    args: *const wl_argument
) -> Result<(), ()>