#[repr(transparent)]
pub struct WaylandToplevel { /* private fields */ }
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.

Sets the application id on a gdk::Toplevel.

application_id

the application id for the @self

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 gdk_wayland_toplevel_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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Formats the value using the given formatter. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

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

This method tests for !=.

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

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

Returns the type identifier of Self.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

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 the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Returns true if the object is an instance of (can be cast to) T.

Returns the type of the object.

Returns the ObjectClass of the object. Read more

Returns the class of the object.

Returns the class of the object in the given type T. Read more

Returns the interface T of the object. Read more

Similar to Self::set_property but fails instead of panicking.

Sets the property property_name of the object to value value. Read more

Similar to Self::set_property but fails instead of panicking.

Sets the property property_name of the object to value value. Read more

Similar to Self::set_properties but fails instead of panicking.

Sets multiple properties of the object at once. Read more

Similar to Self::set_properties_from_value but fails instead of panicking.

Sets multiple properties of the object at once. Read more

Similar to Self::property but fails instead of panicking.

Gets the property property_name of the object and cast it to the type V. Read more

Similar to Self::property_value but fails instead of panicking.

Gets the property property_name of the object. Read more

Check if the object has a property property_name of the given type_. Read more

Get the type of the property property_name of this object. Read more

Get the ParamSpec of the property property_name of this object.

Return all ParamSpec of the properties of this object.

Freeze all property notifications until the return guard object is dropped. Read more

Set arbitrary data on this object with the given key. Read more

Return previously set arbitrary data of this object with the given key. Read more

Retrieve previously set arbitrary data of this object with the given key. Read more

Set arbitrary data on this object with the given key. Read more

Return previously set arbitrary data of this object with the given key. Read more

Retrieve previously set arbitrary data of this object with the given key. Read more

Block a given signal handler. Read more

Unblock a given signal handler.

Stop emission of the currently emitted signal.

Stop emission of the currently emitted signal by the (possibly detailed) signal name.

Similar to Self::connect but fails instead of panicking.

Connect to the signal signal_name on this object. Read more

Similar to Self::connect_id but fails instead of panicking.

Connect to the signal signal_id on this object. Read more

Similar to Self::connect_local but fails instead of panicking.

Connect to the signal signal_name on this object. Read more

Similar to Self::connect_local_id but fails instead of panicking.

Connect to the signal signal_id on this object. Read more

Similar to Self::connect_unsafe but fails instead of panicking.

Connect to the signal signal_name on this object. Read more

Similar to Self::connect_unsafe_id but fails instead of panicking.

Similar to Self::connect_closure but fails instead of panicking.

Connect a closure to the signal signal_name on this object. Read more

Similar to Self::connect_closure_id but fails instead of panicking.

Connect a closure to the signal signal_id on this object. Read more

Limits the lifetime of closure to the lifetime of the object. When the object’s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to Closure::invoke. Read more

Connect to the signal signal_id on this object. Read more

Similar to Self::emit but fails instead of panicking.

Emit signal by signal id. Read more

Similar to Self::emit_with_values but fails instead of panicking.

Same as Self::emit but takes Value for the arguments.

Similar to Self::emit_by_name but fails instead of panicking.

Emit signal by its name. Read more

Similar to Self::emit_by_name_with_values but fails instead of panicking.

Emit signal by its name. Read more

Similar to Self::emit_with_details but fails instead of panicking.

Emit signal by signal id with details. Read more

Similar to Self::emit_with_details_and_values but fails instead of panicking.

Emit signal by signal id with details. Read more

Disconnect a previously connected signal handler.

Connect to the notify signal of the object. Read more

Connect to the notify signal of the object. Read more

Connect to the notify signal of the object. Read more

Notify that the given property has changed its value. Read more

Notify that the given property has changed its value. Read more

Downgrade this object to a weak reference.

Bind property source_property on this object to the target_property on the target object. Read more

Returns the strong reference count of this object.

Ensures that the type has been registered with the type system.

Emits a short beep associated to @self. Read more

Creates a new CairoContext for rendering on @self. Read more

Creates a new GLContext for the Surface. Read more

Creates a new VulkanContext for rendering on @self. Read more

Retrieves a Cursor pointer for the cursor currently set on the Surface. Read more

Retrieves a Cursor pointer for the @device currently set on the specified Surface. Read more

Obtains the current device position and modifier state. Read more

Gets the Display associated with a Surface. Read more

Gets the frame clock for the surface. Read more

Returns the height of the given @self. Read more

Checks whether the surface has been mapped. Read more

Returns the internal scale factor that maps from surface coordinates to the actual device pixels. Read more

Returns the width of the given @self. Read more

Hide the surface. 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

Sets the default mouse pointer for a Surface. Read more

Sets a specific Cursor for a given device when it gets inside @self. Read more

Apply the region to the surface for the purpose of event handling. Read more

Marks a region of the Surface as opaque. Read more

Emitted when @surface starts being present on the monitor. Read more

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

Emitted when @surface stops being present on the monitor. Read more

Emitted when part of the surface needs to be redrawn. Read more

Create a new Cairo surface that is as compatible as possible with the given @self. Read more

Translates coordinates between two surfaces. Read more

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

Converts the given value to a String. Read more

Begins an interactive move operation. Read more

Begins an interactive resize operation. Read more

Sets keyboard focus to @surface. Read more

Gets the bitwise or of the currently active surface state flags, from the ToplevelState enumeration. Read more

Requests that the @self inhibit the system shortcuts. Read more

Asks to lower the @self below other windows. Read more

Asks to minimize the @self. 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 toplevel to be modal. Read more

Sets the startup notification ID. Read more

Sets the title of a toplevel surface. Read more

Sets a transient-for parent. Read more

Asks the windowing system to show the window menu. Read more

Available on crate feature v4_4 only.

Emitted when the size for the surface needs to be computed, when it is present. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.