Trait WlShellSurfaceHandler 

pub trait WlShellSurfaceHandler: Any {
    // Provided methods
    fn delete_id(&mut self, slf: &Rc<WlShellSurface>) { ... }
    fn handle_pong(&mut self, slf: &Rc<WlShellSurface>, serial: u32) { ... }
    fn handle_move(
        &mut self,
        slf: &Rc<WlShellSurface>,
        seat: &Rc<WlSeat>,
        serial: u32,
    ) { ... }
    fn handle_resize(
        &mut self,
        slf: &Rc<WlShellSurface>,
        seat: &Rc<WlSeat>,
        serial: u32,
        edges: WlShellSurfaceResize,
    ) { ... }
    fn handle_set_toplevel(&mut self, slf: &Rc<WlShellSurface>) { ... }
    fn handle_set_transient(
        &mut self,
        slf: &Rc<WlShellSurface>,
        parent: &Rc<WlSurface>,
        x: i32,
        y: i32,
        flags: WlShellSurfaceTransient,
    ) { ... }
    fn handle_set_fullscreen(
        &mut self,
        slf: &Rc<WlShellSurface>,
        method: WlShellSurfaceFullscreenMethod,
        framerate: u32,
        output: Option<&Rc<WlOutput>>,
    ) { ... }
    fn handle_set_popup(
        &mut self,
        slf: &Rc<WlShellSurface>,
        seat: &Rc<WlSeat>,
        serial: u32,
        parent: &Rc<WlSurface>,
        x: i32,
        y: i32,
        flags: WlShellSurfaceTransient,
    ) { ... }
    fn handle_set_maximized(
        &mut self,
        slf: &Rc<WlShellSurface>,
        output: Option<&Rc<WlOutput>>,
    ) { ... }
    fn handle_set_title(&mut self, slf: &Rc<WlShellSurface>, title: &str) { ... }
    fn handle_set_class(&mut self, slf: &Rc<WlShellSurface>, class_: &str) { ... }
    fn handle_ping(&mut self, slf: &Rc<WlShellSurface>, serial: u32) { ... }
    fn handle_configure(
        &mut self,
        slf: &Rc<WlShellSurface>,
        edges: WlShellSurfaceResize,
        width: i32,
        height: i32,
    ) { ... }
    fn handle_popup_done(&mut self, slf: &Rc<WlShellSurface>) { ... }
}

A message handler for WlShellSurface proxies.

Provided Methods

fn delete_id(&mut self, slf: &Rc<WlShellSurface>)

Event handler for wl_display.delete_id messages deleting the ID of this object.

The default handler forwards the event to the client, if any.

fn handle_pong(&mut self, slf: &Rc<WlShellSurface>, 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.

Arguments

• serial: serial number of the ping event

fn handle_move( &mut self, slf: &Rc<WlShellSurface>, seat: &Rc<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).

Arguments

• seat: seat whose pointer is used
• serial: serial number of the implicit grab on the pointer

All borrowed proxies passed to this function are guaranteed to be immutable and non-null.

fn handle_resize( &mut self, slf: &Rc<WlShellSurface>, seat: &Rc<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).

Arguments

• seat: seat whose pointer is used
• serial: serial number of the implicit grab on the pointer
• edges: which edge or corner is being dragged

All borrowed proxies passed to this function are guaranteed to be immutable and non-null.

fn handle_set_toplevel(&mut self, slf: &Rc<WlShellSurface>)

make the surface a toplevel surface

Map the surface as a toplevel surface.

A toplevel surface is not fullscreen, maximized or transient.

fn handle_set_transient( &mut self, slf: &Rc<WlShellSurface>, parent: &Rc<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 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.

Arguments

• parent: parent surface
• x: surface-local x coordinate
• y: surface-local y coordinate
• flags: transient surface behavior

All borrowed proxies passed to this function are guaranteed to be immutable and non-null.

fn handle_set_fullscreen( &mut self, slf: &Rc<WlShellSurface>, method: WlShellSurfaceFullscreenMethod, framerate: u32, output: Option<&Rc<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 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.

Arguments

• method: method for resolving size conflict
• framerate: framerate in mHz
• output: output on which the surface is to be fullscreen

All borrowed proxies passed to this function are guaranteed to be immutable and non-null.

fn handle_set_popup( &mut self, slf: &Rc<WlShellSurface>, seat: &Rc<WlSeat>, serial: u32, parent: &Rc<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 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.

Arguments

• seat: seat whose pointer is used
• serial: serial number of the implicit grab on the pointer
• parent: parent surface
• x: surface-local x coordinate
• y: surface-local y coordinate
• flags: transient surface behavior

All borrowed proxies passed to this function are guaranteed to be immutable and non-null.

fn handle_set_maximized( &mut self, slf: &Rc<WlShellSurface>, output: Option<&Rc<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 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.

Arguments

• output: output on which the surface is to be maximized

All borrowed proxies passed to this function are guaranteed to be immutable and non-null.

fn handle_set_title(&mut self, slf: &Rc<WlShellSurface>, title: &str)

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.

Arguments

• title: surface title

fn handle_set_class(&mut self, slf: &Rc<WlShellSurface>, class_: &str)

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.

Arguments

• class_: surface class

fn handle_ping(&mut self, slf: &Rc<WlShellSurface>, serial: u32)

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.

Arguments

• serial: serial number of the ping

fn handle_configure( &mut self, slf: &Rc<WlShellSurface>, edges: WlShellSurfaceResize, width: i32, height: i32, )

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.

Arguments

• edges: how the surface was resized
• width: new width of the surface
• height: new height of the surface

fn handle_popup_done(&mut self, slf: &Rc<WlShellSurface>)

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.

Implementors