Struct wayland_protocols_plasma::plasma_window_management::client::org_kde_plasma_window::OrgKdePlasmaWindow

pub struct OrgKdePlasmaWindow {
    id: ObjectId,
    version: u32,
    data: Option<Arc<dyn ObjectData>>,
    backend: WeakBackend,
}

interface to control application windows

Manages and control an application window.

Only one client can bind this interface at a time.

See also the Event enum for this interface.

Fields

id: ObjectId

version: u32

data: Option<Arc<dyn ObjectData>>

backend: WeakBackend

Implementations

impl OrgKdePlasmaWindow

pub fn set_state(&self, flags: u32, state: u32)

set window state

Set window state.

Values for state argument are described by org_kde_plasma_window_management.state and can be used together in a bitfield. The flags bitfield describes which flags are supposed to be set, the state bitfield the value for the set flags

pub fn set_virtual_desktop(&self, number: u32)

map window on a virtual desktop

Deprecated: use enter_virtual_desktop Maps the window to a different virtual desktop.

To show the window on all virtual desktops, call the org_kde_plasma_window.set_state request and specify a on_all_desktops state in the bitfield.

pub fn set_minimized_geometry( &self, panel: &WlSurface, x: u32, y: u32, width: u32, height: u32, )

set the geometry for a taskbar entry

Sets the geometry of the taskbar entry for this window. The geometry is relative to a panel in particular.

pub fn unset_minimized_geometry(&self, panel: &WlSurface)

set the geometry for a taskbar entry

Remove the task geometry information for a particular panel.

pub fn close(&self)

close window

Close this window.

pub fn request_move(&self)

request move

Request an interactive move for this window.

pub fn request_resize(&self)

request resize

Request an interactive resize for this window.

pub fn destroy(&self)

remove resource for the org_kde_plasma_window

Removes the resource bound for this org_kde_plasma_window.

pub fn get_icon(&self, fd: BorrowedFd<'_>)

Requests to get the window icon

The compositor will write the window icon into the provided file descriptor. The data is a serialized QIcon with QDataStream.

pub fn request_enter_virtual_desktop(&self, id: String)

map window on a virtual desktop

Make the window enter a virtual desktop. A window can enter more than one virtual desktop. if the id is empty or invalid, no action will be performed.

pub fn request_enter_new_virtual_desktop(&self)

map window on a virtual desktop

RFC: do this with an empty id to request_enter_virtual_desktop? Make the window enter a new virtual desktop. If the server consents the request, it will create a new virtual desktop and assign the window to it.

pub fn request_leave_virtual_desktop(&self, id: String)

remove a window from a virtual desktop

Make the window exit a virtual desktop. If it exits all desktops it will be considered on all of them.

pub fn request_enter_activity(&self, id: String)

map window on an activity

Make the window enter an activity. A window can enter more activity. If the id is empty or invalid, no action will be performed.

pub fn request_leave_activity(&self, id: String)

remove a window from an activity

Make the window exit a an activity. If it exits all activities it will be considered on all of them.

pub fn send_to_output(&self, output: &WlOutput)

send window to specified output

Requests this window to be displayed in a specific output.

Trait Implementations

impl Borrow<ObjectId> for OrgKdePlasmaWindow

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for OrgKdePlasmaWindow

fn clone(&self) -> OrgKdePlasmaWindow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OrgKdePlasmaWindow

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

Formats the value using the given formatter.

impl Hash for OrgKdePlasmaWindow

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

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 PartialEq<Weak<OrgKdePlasmaWindow>> for OrgKdePlasmaWindow

fn eq(&self, other: &Weak<OrgKdePlasmaWindow>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for OrgKdePlasmaWindow

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Proxy for OrgKdePlasmaWindow

type Request<'request> = Request<'request>

The request enum for this interface

type Event = Event

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U: Send + Sync + 'static>(&self) -> Option<&U>

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn ObjectData>>

Access the raw data associated with this object.

fn backend(&self) -> &WeakBackend

Access the backend associated with this object

fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I: Proxy>( &self, req: Self::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>

Send a request for this object that creates another object.

fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> Self

Create an inert object proxy

fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(Self, Self::Event), DispatchError>

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: Self::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>

Serialize a request for this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for OrgKdePlasmaWindow