Struct ExtWorkspaceGroupHandleV1

pub struct ExtWorkspaceGroupHandleV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

a workspace group assigned to a set of outputs

A ext_workspace_group_handle_v1 object represents a workspace group that is assigned a set of outputs and contains a number of workspaces.

The set of outputs assigned to the workspace group is conveyed to the client via output_enter and output_leave events, and its workspaces are conveyed with workspace events.

For example, a compositor which has a set of workspaces for each output may advertise a workspace group (and its workspaces) per output, whereas a compositor where a workspace spans all outputs may advertise a single workspace group for all outputs.

See also the Event enum for this interface.

Implementations

impl ExtWorkspaceGroupHandleV1

pub fn create_workspace(&self, workspace: String)

create a new workspace

Request that the compositor create a new workspace with the given name and assign it to this group.

There is no guarantee that the compositor will create a new workspace, or that the created workspace will have the provided name.

pub fn destroy(&self)

destroy the ext_workspace_group_handle_v1 object

Destroys the ext_workspace_group_handle_v1 object.

This request should be send either when the client does not want to use the workspace group object any more or after the removed event to finalize the destruction of the object.

Trait Implementations

impl Borrow<ObjectId> for ExtWorkspaceGroupHandleV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ExtWorkspaceGroupHandleV1

fn clone(&self) -> ExtWorkspaceGroupHandleV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtWorkspaceGroupHandleV1

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

Formats the value using the given formatter.

impl Hash for ExtWorkspaceGroupHandleV1

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

fn eq(&self, other: &Weak<ExtWorkspaceGroupHandleV1>) -> 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 ExtWorkspaceGroupHandleV1

fn eq(&self, other: &ExtWorkspaceGroupHandleV1) -> 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 ExtWorkspaceGroupHandleV1

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>(&self) -> Option<&U>

where U: Send + Sync + 'static,

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: <ExtWorkspaceGroupHandleV1 as Proxy>::Request<'_>, ) -> Result<(), InvalidId>

Send a request for this object.

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

where I: Proxy,

Send a request for this object that creates another object.

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

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> ExtWorkspaceGroupHandleV1

Create an inert object proxy

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

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: <ExtWorkspaceGroupHandleV1 as Proxy>::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 ExtWorkspaceGroupHandleV1