Struct wayland_client::wayland::shell::WlShellSurface
[−]
[src]
pub struct WlShellSurface {
// some fields omitted
}desktop-style metadata interface
An interface that may be implemented by a wl_surface, for implementations that provide a desktop-style user interface.
It provides requests to treat surfaces like toplevel, fullscreen or popup windows, move, resize or maximize them, associate metadata like title and class, etc.
On the server side the object is automatically destroyed when the related wl_surface is destroyed. On client side, wl_shell_surface_destroy() must be called before destroying the wl_surface object.
Methods
impl WlShellSurface[src]
fn pong(&self, serial: u32)
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)
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: WlShellSurfaceResize)
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)
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: WlShellSurfaceTransient)
make the surface a transient surface
Map the surface relative to an existing surface.
The x and y arguments specify the locations 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: WlShellSurfaceFullscreenMethod, framerate: u32, output: Option<&WlOutput>)
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 app 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: WlShellSurfaceTransient)
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 clients window. A click in any of the clients 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 locations 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>)
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 element 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)
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)
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 Sync for WlShellSurface[src]
impl Send for WlShellSurface[src]
impl Proxy for WlShellSurface[src]
fn ptr(&self) -> *mut wl_proxy
fn interface() -> *mut wl_interface
fn interface_name() -> &'static str
The internal name of this interface, as advertized by the registry if it is a global.
fn version() -> u32
The maximum version of this interface handled by the library.
fn id(&self) -> ProxyId
Get the id of this proxy
unsafe fn from_ptr(ptr: *mut wl_proxy) -> WlShellSurface
Creates a proxy from a fresh ptr
unsafe fn from_ptr_no_own(ptr: *mut wl_proxy) -> WlShellSurface
Creates a proxy from a ptr that is managed elsewhere Read more
fn set_evt_iterator(&mut self, evt: &EventIterator)
Set the event iterator associated to this proxy
impl Debug for WlShellSurface[src]
fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter.