Struct gdk4_wayland::WaylandToplevel [−][src]
pub struct WaylandToplevel(_);
Expand description
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
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()
.
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.
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.
Destroys the handle that was obtained with
export_handle()
.
It is an error to call this function on a surface that does not have a handle.
Note that this API depends on an unstable Wayland protocol, and thus may require changes in the future.
Trait Implementations
type Parent = WaylandSurface
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Returns the type identifier of Self
.
Auto Trait Implementations
impl RefUnwindSafe for WaylandToplevel
impl !Send for WaylandToplevel
impl !Sync for WaylandToplevel
impl Unpin for WaylandToplevel
impl UnwindSafe for WaylandToplevel
Blanket Implementations
Mutably borrows from an owned value. Read more
Upcasts an object to a superclass or interface T
. Read more
Upcasts an object to a reference of its superclass or interface T
. Read more
Tries to downcast to a subclass or interface implementor T
. Read more
Tries to downcast to a reference of its subclass or interface implementor T
. Read more
Tries to cast to an object of type T
. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast
and upcast
will do many checks at compile-time already. Read more
Tries to cast to reference to an object of type T
. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast
and upcast
will do many checks at compile-time already. Read more
Casts to T
unconditionally. Read more
Casts to &T
unconditionally. Read more
Returns true
if the object is an instance of (can be cast to) T
.
pub fn set_property<'a, N, V>(
&self,
property_name: N,
value: V
) -> Result<(), BoolError> where
N: Into<&'a str>,
V: ToValue,
pub fn set_property_from_value<'a, N>(
&self,
property_name: N,
value: &Value
) -> Result<(), BoolError> where
N: Into<&'a str>,
pub fn set_properties_from_value(
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>
pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
N: Into<&'a str>,
pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
N: Into<&'a str>,
Safety Read more
Safety Read more
Safety Read more
Safety Read more
pub fn connect<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
N: Into<&'a str>,
F: 'static + Fn(&[Value]) -> Option<Value> + Send + Sync,
Same as connect
but takes a SignalId
instead of a signal name.
pub fn connect_local<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
N: Into<&'a str>,
F: 'static + Fn(&[Value]) -> Option<Value>,
Same as connect_local
but takes a SignalId
instead of a signal name.
pub unsafe fn connect_unsafe<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
N: Into<&'a str>,
F: Fn(&[Value]) -> Option<Value>,
Same as connect_unsafe
but takes a SignalId
instead of a signal name.
Emit signal by signal id.
Same as emit
but takes Value
for the arguments.
Emit signal by its name.
Same as emit_by_name
but takes Value
for the arguments.
Emit signal with details by signal id.
Same as emit_with_details
but takes Value
for the arguments.
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,
pub fn connect_notify_local<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec),
pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
pub fn bind_property<'a, O, N, M>(
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
O: ObjectType,
N: Into<&'a str>,
M: Into<&'a str>,
Creates a new CairoContext
for rendering on self
. Read more
Creates a new VulkanContext
for rendering on self
. Read more
Destroys the window system resources associated with self
and
decrements self
’s reference count. Read more
Obtains the current device position and modifier state. Read more
Gets the frame clock for the surface. Read more
Returns the internal scale factor that maps from surface coordinates to the actual device pixels. Read more
Check to see if a surface is destroyed. Read more
Forces a signal::Surface::render
signal emission for self
to be scheduled. Read more
Request a layout phase from the surface’s frame clock. Read more
Apply the region to the surface for the purpose of event handling. Read more
pub fn connect_enter_monitor<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Monitor),
pub fn connect_enter_monitor<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Monitor),
Emitted when surface
starts being present on the monitor. Read more
pub fn connect_event<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Event) -> bool,
pub fn connect_event<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Event) -> bool,
Emitted when GDK receives an input event for surface
. Read more
Emitted when the size of surface
is changed, or when relayout should
be performed. Read more
pub fn connect_leave_monitor<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Monitor),
pub fn connect_leave_monitor<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Monitor),
Emitted when surface
stops being present on the monitor. Read more
pub fn connect_render<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Region) -> bool,
pub fn connect_render<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Region) -> bool,
Emitted when part of the surface needs to be redrawn. Read more
pub fn connect_scale_factor_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O),
Create a new Cairo surface that is as compatible as possible with the
given self
. Read more
Returns a SendValue
clone of self
.
Begins an interactive move operation. Read more
Begins an interactive resize operation. Read more
Gets the bitwise or of the currently active surface state flags,
from the ToplevelState
enumeration. Read more
Present self
after having processed the ToplevelLayout
rules. Read more
Restore default system keyboard shortcuts which were previously inhibited. Read more
Sets the toplevel to be decorated. Read more
Sets the toplevel to be deletable. Read more
Sets a list of icons for the surface. Read more
Sets the startup notification ID. Read more
Sets a transient-for parent. Read more
Returns whether the desktop environment supports tiled window states. Read more
Whether the window manager should add decorations.
Whether the window manager should allow to close the surface.
The fullscreen mode of the surface.
The fullscreen mode of the surface.
Whether the surface should inhibit keyboard shortcuts.
The startup ID of the surface. Read more
The transient parent of the surface.
pub fn connect_fullscreen_mode_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O),
pub fn connect_shortcuts_inhibited_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O),
pub fn connect_transient_for_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O),
pub fn connect_compute_size<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&Toplevel, &mut ToplevelSize),
pub fn connect_compute_size<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&Toplevel, &mut ToplevelSize),
Emitted when the size for the surface needs to be computed, when it is present. Read more
Requests that the self
inhibit the system shortcuts. Read more
Asks the windowing system to show the window menu. Read more