Struct wayland_client::protocol::wl_shell_surface::WlShellSurface

pub struct WlShellSurface { /* fields omitted */ }

Methods

impl WlShellSurface

fn pong(&self, serial: u32) -> RequestResult<()>

respond to a ping event

A client must respond to a ping event with a pong request or the client may be deemed unresponsive.

fn _move(&self, seat: &WlSeat, serial: u32) -> RequestResult<()>

start an interactive move

Start a pointer-driven move of the surface.

This request must be used in response to a button press event. The server may ignore move requests depending on the state of the surface (e.g. fullscreen or maximized).

fn resize(&self, seat: &WlSeat, serial: u32, edges: Resize) -> RequestResult<()>

start an interactive resize

Start a pointer-driven resizing of the surface.

This request must be used in response to a button press event. The server may ignore resize requests depending on the state of the surface (e.g. fullscreen or maximized).

fn set_toplevel(&self) -> RequestResult<()>

make the surface a toplevel surface

Map the surface as a toplevel surface.

A toplevel surface is not fullscreen, maximized or transient.

fn set_transient(&self,
                 parent: &WlSurface,
                 x: i32,
                 y: i32,
                 flags: Transient)
                 -> RequestResult<()>

make the surface a transient surface

Map the surface relative to an existing surface.

The x and y arguments specify the location of the upper left corner of the surface relative to the upper left corner of the parent surface, in surface-local coordinates.

The flags argument controls details of the transient behaviour.

fn set_fullscreen(&self,
                  method: FullscreenMethod,
                  framerate: u32,
                  output: Option<&WlOutput>)
                  -> RequestResult<()>

make the surface a fullscreen surface

Map the surface as a fullscreen surface.

If an output parameter is given then the surface will be made fullscreen on that output. If the client does not specify the output then the compositor will apply its policy - usually choosing the output on which the surface has the biggest surface area.

The client may specify a method to resolve a size conflict between the output size and the surface size - this is provided through the method parameter.

The framerate parameter is used only when the method is set to "driver", to indicate the preferred framerate. A value of 0 indicates that the client does not care about framerate. The framerate is specified in mHz, that is framerate of 60000 is 60Hz.

A method of "scale" or "driver" implies a scaling operation of the surface, either via a direct scaling operation or a change of the output mode. This will override any kind of output scaling, so that mapping a surface with a buffer size equal to the mode can fill the screen independent of buffer_scale.

A method of "fill" means we don't scale up the buffer, however any output scale is applied. This means that you may run into an edge case where the application maps a buffer with the same size of the output mode but buffer_scale 1 (thus making a surface larger than the output). In this case it is allowed to downscale the results to fit the screen.

The compositor must reply to this request with a configure event with the dimensions for the output on which the surface will be made fullscreen.

fn set_popup(&self,
             seat: &WlSeat,
             serial: u32,
             parent: &WlSurface,
             x: i32,
             y: i32,
             flags: Transient)
             -> RequestResult<()>

make the surface a popup surface

Map the surface as a popup.

A popup surface is a transient surface with an added pointer grab.

An existing implicit grab will be changed to owner-events mode, and the popup grab will continue after the implicit grab ends (i.e. releasing the mouse button does not cause the popup to be unmapped).

The popup grab continues until the window is destroyed or a mouse button is pressed in any other client's window. A click in any of the client's surfaces is reported as normal, however, clicks in other clients' surfaces will be discarded and trigger the callback.

The x and y arguments specify the location of the upper left corner of the surface relative to the upper left corner of the parent surface, in surface-local coordinates.

fn set_maximized(&self, output: Option<&WlOutput>) -> RequestResult<()>

make the surface a maximized surface

Map the surface as a maximized surface.

If an output parameter is given then the surface will be maximized on that output. If the client does not specify the output then the compositor will apply its policy - usually choosing the output on which the surface has the biggest surface area.

The compositor will reply with a configure event telling the expected new surface size. The operation is completed on the next buffer attach to this surface.

A maximized surface typically fills the entire output it is bound to, except for desktop elements such as panels. This is the main difference between a maximized shell surface and a fullscreen shell surface.

The details depend on the compositor implementation.

fn set_title(&self, title: String) -> RequestResult<()>

set surface title

Set a short title for the surface.

This string may be used to identify the surface in a task bar, window list, or other user interface elements provided by the compositor.

The string must be encoded in UTF-8.

fn set_class(&self, class_: String) -> RequestResult<()>

set surface class

Set a class for the surface.

The surface class identifies the general class of applications to which the surface belongs. A common convention is to use the file name (or the full path if it is a non-standard location) of the application's .desktop file as the class.

Trait Implementations

impl Send for WlShellSurface

impl Sync for WlShellSurface

impl Proxy for WlShellSurface

fn ptr(&self) -> *mut wl_proxy

Pointer to the underlying wayland proxy object

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

Create an instance from a wayland pointer

unsafe fn from_ptr_initialized(ptr: *mut wl_proxy) -> 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) -> u32

Current version of the interface this proxy is instanciated with

fn is_alive(&self) -> bool

Check if the proxt 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 proxy

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

Get the pointer associated as user data on this proxy