Trait x11rb_async::protocol::composite::ConnectionExt

source ·
pub trait ConnectionExt: RequestConnection {
    // Provided methods
    fn composite_query_version(
        &self,
        client_major_version: u32,
        client_minor_version: u32
    ) -> Pin<Box<dyn Future<Output = Result<Cookie<'_, Self, QueryVersionReply>, ConnectionError>> + Send + '_>> { ... }
    fn composite_redirect_window(
        &self,
        window: Window,
        update: Redirect
    ) -> Pin<Box<dyn Future<Output = Result<VoidCookie<'_, Self>, ConnectionError>> + Send + '_>> { ... }
    fn composite_redirect_subwindows(
        &self,
        window: Window,
        update: Redirect
    ) -> Pin<Box<dyn Future<Output = Result<VoidCookie<'_, Self>, ConnectionError>> + Send + '_>> { ... }
    fn composite_unredirect_window(
        &self,
        window: Window,
        update: Redirect
    ) -> Pin<Box<dyn Future<Output = Result<VoidCookie<'_, Self>, ConnectionError>> + Send + '_>> { ... }
    fn composite_unredirect_subwindows(
        &self,
        window: Window,
        update: Redirect
    ) -> Pin<Box<dyn Future<Output = Result<VoidCookie<'_, Self>, ConnectionError>> + Send + '_>> { ... }
    fn composite_create_region_from_border_clip(
        &self,
        region: Region,
        window: Window
    ) -> Pin<Box<dyn Future<Output = Result<VoidCookie<'_, Self>, ConnectionError>> + Send + '_>> { ... }
    fn composite_name_window_pixmap(
        &self,
        window: Window,
        pixmap: Pixmap
    ) -> Pin<Box<dyn Future<Output = Result<VoidCookie<'_, Self>, ConnectionError>> + Send + '_>> { ... }
    fn composite_get_overlay_window(
        &self,
        window: Window
    ) -> Pin<Box<dyn Future<Output = Result<Cookie<'_, Self, GetOverlayWindowReply>, ConnectionError>> + Send + '_>> { ... }
    fn composite_release_overlay_window(
        &self,
        window: Window
    ) -> Pin<Box<dyn Future<Output = Result<VoidCookie<'_, Self>, ConnectionError>> + Send + '_>> { ... }
}
Expand description

Extension trait defining the requests of this extension.

Provided Methods§

source

fn composite_query_version( &self, client_major_version: u32, client_minor_version: u32 ) -> Pin<Box<dyn Future<Output = Result<Cookie<'_, Self, QueryVersionReply>, ConnectionError>> + Send + '_>>

Negotiate the version of Composite.

This negotiates the version of the Composite extension. It must be precede all other requests using Composite. Failure to do so will cause a BadRequest error.

§Fields
  • client_major_version - The major version supported by the client.
  • client_minor_version - The minor version supported by the client.
source

fn composite_redirect_window( &self, window: Window, update: Redirect ) -> Pin<Box<dyn Future<Output = Result<VoidCookie<'_, Self>, ConnectionError>> + Send + '_>>

Redirect the hierarchy starting at “window” to off-screen storage..

The hierarchy starting at ‘window’ is directed to off-screen storage. When all clients enabling redirection terminate, the redirection will automatically be disabled.

The root window may not be redirected. Doing so results in a Match error.

§Fields
  • window - The root of the hierarchy to redirect to off-screen storage.
  • update - Whether contents are automatically mirrored to the parent window. If one client already specifies an update type of Manual, any attempt by another to specify a mode of Manual so will result in an Access error.
source

fn composite_redirect_subwindows( &self, window: Window, update: Redirect ) -> Pin<Box<dyn Future<Output = Result<VoidCookie<'_, Self>, ConnectionError>> + Send + '_>>

Redirect all current and future children of ‘window’.

Hierarchies starting at all current and future children of window will be redirected as in RedirectWindow. If update is Manual, then painting of the window background during window manipulation and ClearArea requests is inhibited.

§Fields
  • window - The root of the hierarchy to redirect to off-screen storage.
  • update - Whether contents are automatically mirrored to the parent window. If one client already specifies an update type of Manual, any attempt by another to specify a mode of Manual so will result in an Access error.
source

fn composite_unredirect_window( &self, window: Window, update: Redirect ) -> Pin<Box<dyn Future<Output = Result<VoidCookie<'_, Self>, ConnectionError>> + Send + '_>>

Terminate redirection of the specified window..

Redirection of the specified window will be terminated. This cannot be used if the window was redirected with RedirectSubwindows.

§Fields
  • window - The window to terminate redirection of. Must be redirected by the current client, or a Value error results.
  • update - The update type passed to RedirectWindows. If this does not match the previously requested update type, a Value error results.
source

fn composite_unredirect_subwindows( &self, window: Window, update: Redirect ) -> Pin<Box<dyn Future<Output = Result<VoidCookie<'_, Self>, ConnectionError>> + Send + '_>>

Terminate redirection of the specified window’s children.

Redirection of all children of window will be terminated.

§Fields
  • window - The window to terminate redirection of. Must have previously been selected for sub-redirection by the current client, or a Value error results.
  • update - The update type passed to RedirectSubWindows. If this does not match the previously requested update type, a Value error results.
source

fn composite_create_region_from_border_clip( &self, region: Region, window: Window ) -> Pin<Box<dyn Future<Output = Result<VoidCookie<'_, Self>, ConnectionError>> + Send + '_>>

source

fn composite_name_window_pixmap( &self, window: Window, pixmap: Pixmap ) -> Pin<Box<dyn Future<Output = Result<VoidCookie<'_, Self>, ConnectionError>> + Send + '_>>

source

fn composite_get_overlay_window( &self, window: Window ) -> Pin<Box<dyn Future<Output = Result<Cookie<'_, Self, GetOverlayWindowReply>, ConnectionError>> + Send + '_>>

source

fn composite_release_overlay_window( &self, window: Window ) -> Pin<Box<dyn Future<Output = Result<VoidCookie<'_, Self>, ConnectionError>> + Send + '_>>

Object Safety§

This trait is not object safe.

Implementors§