Struct gdk4_wayland::WaylandToplevel

#[repr(transparent)]
pub struct WaylandToplevel { /* private fields */ }

The Wayland implementation of gdk::Toplevel.

Beyond the gdk::Toplevel API, the Wayland implementation has API to set up cross-process parent-child relationships between surfaces with export_handle() and set_transient_for_exported().

Implements

[WaylandSurfaceExt][trait@crate::prelude::WaylandSurfaceExt], gdk::prelude::SurfaceExt, gdk::prelude::ToplevelExt, WaylandSurfaceExtManual

Implementations

impl WaylandToplevel

pub fn drop_exported_handle(&self, handle: &str)

Available on crate feature v4_12 only.

Destroy a handle that was obtained with gdk_wayland_toplevel_export_handle().

Note that this API depends on an unstable Wayland protocol, and thus may require changes in the future.

handle

the handle to drop

pub fn export_handle<P: Fn(&WaylandToplevel, &str) + 'static>( &self, callback: P ) -> bool

Asynchronously obtains a handle for a surface that can be passed to other processes.

When the handle has been obtained, @callback will be called.

It is an error to call this function on a surface that is already exported.

When the handle is no longer needed, unexport_handle() should be called to clean up resources.

The main purpose for obtaining a handle is to mark a surface from another surface as transient for this one, see set_transient_for_exported().

Before 4.12, this API could not safely be used multiple times, since there was no reference counting for handles. Starting with 4.12, every call to this function obtains a new handle, and every call to drop_exported_handle() drops just the handle that it is given.

Note that this API depends on an unstable Wayland protocol, and thus may require changes in the future.

callback

callback to call with the handle

Returns

true if the handle has been requested, false if an error occurred.

pub fn set_application_id(&self, application_id: &str)

Sets the application id on a gdk::Toplevel.

application_id

the application id for the @self

pub fn set_transient_for_exported(&self, parent_handle_str: &str) -> bool

Marks @self as transient for the surface to which the given @parent_handle_str refers.

Typically, the handle will originate from a export_handle() call in another process.

Note that this API depends on an unstable Wayland protocol, and thus may require changes in the future.

parent_handle_str

an exported handle for a surface

Returns

true if the surface has been marked as transient, false if an error occurred.

pub fn unexport_handle(&self)

👎Deprecated: Since 4.12

Destroys the handle that was obtained with gdk_wayland_toplevel_export_handle().

It is an error to call this function on a surface that does not have a handle.

Since 4.12, this function does nothing. Use drop_exported_handle() instead to drop a handle that was obtained with export_handle().

Note that this API depends on an unstable Wayland protocol, and thus may require changes in the future.

Deprecated since 4.12

Use drop_exported_handle() instead, this function does nothing

Trait Implementations

impl Clone for WaylandToplevel

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WaylandToplevel

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for WaylandToplevel

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for WaylandToplevel

type ParamSpec = ParamSpecObject

type SetValue = WaylandToplevel

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, WaylandToplevel>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for WaylandToplevel

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for WaylandToplevel

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for WaylandToplevel

type Parent = WaylandSurface

impl<OT: ObjectType> PartialEq<OT> for WaylandToplevel

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for WaylandToplevel

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for WaylandToplevel

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for WaylandToplevel

impl IsA<Surface> for WaylandToplevel

impl IsA<Toplevel> for WaylandToplevel

impl IsA<WaylandSurface> for WaylandToplevel