Trait runa_wayland_protocols::unstable::xdg_shell_unstable_v5::xdg_surface::v1::RequestDispatch

pub trait RequestDispatch<Ctx> {
    type Error;
    type DestroyFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type SetParentFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type SetTitleFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type SetAppIdFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type ShowWindowMenuFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type MoveFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type ResizeFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type AckConfigureFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type SetWindowGeometryFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type SetMaximizedFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type UnsetMaximizedFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type SetFullscreenFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type UnsetFullscreenFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type SetMinimizedFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;

    // Required methods
    fn destroy<'a>(ctx: &'a mut Ctx, object_id: u32) -> Self::DestroyFut<'a>;
    fn set_parent<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        parent: Object
    ) -> Self::SetParentFut<'a>;
    fn set_title<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        title: Str<'a>
    ) -> Self::SetTitleFut<'a>;
    fn set_app_id<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        app_id: Str<'a>
    ) -> Self::SetAppIdFut<'a>;
    fn show_window_menu<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        seat: Object,
        serial: u32,
        x: i32,
        y: i32
    ) -> Self::ShowWindowMenuFut<'a>;
    fn move_<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        seat: Object,
        serial: u32
    ) -> Self::MoveFut<'a>;
    fn resize<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        seat: Object,
        serial: u32,
        edges: u32
    ) -> Self::ResizeFut<'a>;
    fn ack_configure<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        serial: u32
    ) -> Self::AckConfigureFut<'a>;
    fn set_window_geometry<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        x: i32,
        y: i32,
        width: i32,
        height: i32
    ) -> Self::SetWindowGeometryFut<'a>;
    fn set_maximized<'a>(
        ctx: &'a mut Ctx,
        object_id: u32
    ) -> Self::SetMaximizedFut<'a>;
    fn unset_maximized<'a>(
        ctx: &'a mut Ctx,
        object_id: u32
    ) -> Self::UnsetMaximizedFut<'a>;
    fn set_fullscreen<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        output: Object
    ) -> Self::SetFullscreenFut<'a>;
    fn unset_fullscreen<'a>(
        ctx: &'a mut Ctx,
        object_id: u32
    ) -> Self::UnsetFullscreenFut<'a>;
    fn set_minimized<'a>(
        ctx: &'a mut Ctx,
        object_id: u32
    ) -> Self::SetMinimizedFut<'a>;
}

Required Associated Types

type Error

type DestroyFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by destroy

type SetParentFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by set_parent

type SetTitleFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by set_title

type SetAppIdFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by set_app_id

type ShowWindowMenuFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by show_window_menu

type MoveFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by move_

type ResizeFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by resize

type AckConfigureFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by ack_configure

type SetWindowGeometryFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by set_window_geometry

type SetMaximizedFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by set_maximized

type UnsetMaximizedFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by unset_maximized

type SetFullscreenFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by set_fullscreen

type UnsetFullscreenFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by unset_fullscreen

type SetMinimizedFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by set_minimized

Required Methods

fn destroy<'a>(ctx: &'a mut Ctx, object_id: u32) -> Self::DestroyFut<'a>

Destroy the xdg_surface

Unmap and destroy the window. The window will be effectively hidden from the user’s point of view, and all state like maximization, fullscreen, and so on, will be lost.

fn set_parent<'a>( ctx: &'a mut Ctx, object_id: u32, parent: Object ) -> Self::SetParentFut<'a>

set the parent of this surface

Set the “parent” of this surface. This window should be stacked above a parent. The parent surface must be mapped as long as this surface is mapped.

Parent windows should be set on dialogs, toolboxes, or other “auxiliary” surfaces, so that the parent is raised when the dialog is raised.

fn set_title<'a>( ctx: &'a mut Ctx, object_id: u32, title: Str<'a> ) -> Self::SetTitleFut<'a>

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_app_id<'a>( ctx: &'a mut Ctx, object_id: u32, app_id: Str<'a> ) -> Self::SetAppIdFut<'a>

set application ID

Set an application identifier for the surface.

The app ID identifies the general class of applications to which the surface belongs. The compositor can use this to group multiple surfaces together, or to determine how to launch a new application.

For D-Bus activatable applications, the app ID is used as the D-Bus service name.

The compositor shell will try to group application surfaces together by their app ID. As a best practice, it is suggested to select app ID’s that match the basename of the application’s .desktop file. For example, “org.freedesktop.FooViewer” where the .desktop file is “org.freedesktop.FooViewer.desktop”.

See the desktop-entry specification 0 for more details on application identifiers and how they relate to well-known D-Bus names and .desktop files.

fn show_window_menu<'a>( ctx: &'a mut Ctx, object_id: u32, seat: Object, serial: u32, x: i32, y: i32 ) -> Self::ShowWindowMenuFut<'a>

show the window menu

Clients implementing client-side decorations might want to show a context menu when right-clicking on the decorations, giving the user a menu that they can use to maximize or minimize the window.

This request asks the compositor to pop up such a window menu at the given position, relative to the local surface coordinates of the parent surface. There are no guarantees as to what menu items the window menu contains.

This request must be used in response to some sort of user action like a button press, key press, or touch down event.

fn move_<'a>( ctx: &'a mut Ctx, object_id: u32, seat: Object, serial: u32 ) -> Self::MoveFut<'a>

start an interactive move

Start an interactive, user-driven move of the surface.

This request must be used in response to some sort of user action like a button press, key press, or touch down event. The passed serial is used to determine the type of interactive move (touch, pointer, etc).

The server may ignore move requests depending on the state of the surface (e.g. fullscreen or maximized), or if the passed serial is no longer valid.

If triggered, the surface will lose the focus of the device (wl_pointer, wl_touch, etc) used for the move. It is up to the compositor to visually indicate that the move is taking place, such as updating a pointer cursor, during the move. There is no guarantee that the device focus will return when the move is completed.

fn resize<'a>( ctx: &'a mut Ctx, object_id: u32, seat: Object, serial: u32, edges: u32 ) -> Self::ResizeFut<'a>

start an interactive resize

Start a user-driven, interactive resize of the surface.

This request must be used in response to some sort of user action like a button press, key press, or touch down event. The passed serial is used to determine the type of interactive resize (touch, pointer, etc).

The server may ignore resize requests depending on the state of the surface (e.g. fullscreen or maximized).

If triggered, the client will receive configure events with the “resize” state enum value and the expected sizes. See the “resize” enum value for more details about what is required. The client must also acknowledge configure events using “ack_configure”. After the resize is completed, the client will receive another “configure” event without the resize state.

If triggered, the surface also will lose the focus of the device (wl_pointer, wl_touch, etc) used for the resize. It is up to the compositor to visually indicate that the resize is taking place, such as updating a pointer cursor, during the resize. There is no guarantee that the device focus will return when the resize is completed.

The edges parameter specifies how the surface should be resized, and is one of the values of the resize_edge enum. The compositor may use this information to update the surface position for example when dragging the top left corner. The compositor may also use this information to adapt its behavior, e.g. choose an appropriate cursor image.

fn ack_configure<'a>( ctx: &'a mut Ctx, object_id: u32, serial: u32 ) -> Self::AckConfigureFut<'a>

ack a configure event

When a configure event is received, if a client commits the surface in response to the configure event, then the client must make an ack_configure request sometime before the commit request, passing along the serial of the configure event.

For instance, the compositor might use this information to move a surface to the top left only when the client has drawn itself for the maximized or fullscreen state.

If the client receives multiple configure events before it can respond to one, it only has to ack the last configure event.

A client is not required to commit immediately after sending an ack_configure request - it may even ack_configure several times before its next surface commit.

The compositor expects that the most recently received ack_configure request at the time of a commit indicates which configure event the client is responding to.

fn set_window_geometry<'a>( ctx: &'a mut Ctx, object_id: u32, x: i32, y: i32, width: i32, height: i32 ) -> Self::SetWindowGeometryFut<'a>

set the new window geometry

The window geometry of a window is its “visible bounds” from the user’s perspective. Client-side decorations often have invisible portions like drop-shadows which should be ignored for the purposes of aligning, placing and constraining windows.

The window geometry is double buffered, and will be applied at the time wl_surface.commit of the corresponding wl_surface is called.

Once the window geometry of the surface is set once, it is not possible to unset it, and it will remain the same until set_window_geometry is called again, even if a new subsurface or buffer is attached.

If never set, the value is the full bounds of the surface, including any subsurfaces. This updates dynamically on every commit. This unset mode is meant for extremely simple clients.

If responding to a configure event, the window geometry in here must respect the sizing negotiations specified by the states in the configure event.

The arguments are given in the surface local coordinate space of the wl_surface associated with this xdg_surface.

The width and height must be greater than zero.

fn set_maximized<'a>( ctx: &'a mut Ctx, object_id: u32 ) -> Self::SetMaximizedFut<'a>

maximize the window

Maximize the surface.

After requesting that the surface should be maximized, the compositor will respond by emitting a configure event with the “maximized” state and the required window geometry. The client should then update its content, drawing it in a maximized state, i.e. without shadow or other decoration outside of the window geometry. The client must also acknowledge the configure when committing the new content (see ack_configure).

It is up to the compositor to decide how and where to maximize the surface, for example which output and what region of the screen should be used.

If the surface was already maximized, the compositor will still emit a configure event with the “maximized” state.

fn unset_maximized<'a>( ctx: &'a mut Ctx, object_id: u32 ) -> Self::UnsetMaximizedFut<'a>

unmaximize the window

Unmaximize the surface.

After requesting that the surface should be unmaximized, the compositor will respond by emitting a configure event without the “maximized” state. If available, the compositor will include the window geometry dimensions the window had prior to being maximized in the configure request. The client must then update its content, drawing it in a regular state, i.e. potentially with shadow, etc. The client must also acknowledge the configure when committing the new content (see ack_configure).

It is up to the compositor to position the surface after it was unmaximized; usually the position the surface had before maximizing, if applicable.

If the surface was already not maximized, the compositor will still emit a configure event without the “maximized” state.

fn set_fullscreen<'a>( ctx: &'a mut Ctx, object_id: u32, output: Object ) -> Self::SetFullscreenFut<'a>

set the window as fullscreen on a monitor

Make the surface fullscreen.

You can specify an output that you would prefer to be fullscreen. If this value is NULL, it’s up to the compositor to choose which display will be used to map this surface.

If the surface doesn’t cover the whole output, the compositor will position the surface in the center of the output and compensate with black borders filling the rest of the output.

fn unset_fullscreen<'a>( ctx: &'a mut Ctx, object_id: u32 ) -> Self::UnsetFullscreenFut<'a>

fn set_minimized<'a>( ctx: &'a mut Ctx, object_id: u32 ) -> Self::SetMinimizedFut<'a>

set the window as minimized

Request that the compositor minimize your surface. There is no way to know if the surface is currently minimized, nor is there any way to unset minimization on this surface.

If you are looking to throttle redrawing when minimized, please instead use the wl_surface.frame event for this, as this will also work with live previews on windows in Alt-Tab, Expose or similar compositor features.

Implementors