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 Request enum for this interface.

Implementations

impl ExtWorkspaceGroupHandleV1

pub fn capabilities(&self, capabilities: GroupCapabilities)

compositor capabilities

This event advertises the capabilities supported by the compositor. If a capability isn’t supported, clients should hide or disable the UI elements that expose this functionality. For instance, if the compositor doesn’t advertise support for creating workspaces, a button triggering the create_workspace request should not be displayed.

The compositor will ignore requests it doesn’t support. For instance, a compositor which doesn’t advertise support for creating workspaces will ignore create_workspace requests.

Compositors must send this event once after creation of an ext_workspace_group_handle_v1. When the capabilities change, compositors must send this event again.

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

output assigned to workspace group

This event is emitted whenever an output is assigned to the workspace group or a new wl_output object is bound by the client, which was already assigned to this workspace_group.

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

output removed from workspace group

This event is emitted whenever an output is removed from the workspace group.

pub fn workspace_enter(&self, workspace: &ExtWorkspaceHandleV1)

workspace added to workspace group

This event is emitted whenever a workspace is assigned to this group. A workspace may only ever be assigned to a single group at a single point in time, but can be re-assigned during it’s lifetime.

pub fn workspace_leave(&self, workspace: &ExtWorkspaceHandleV1)

workspace removed from workspace group

This event is emitted whenever a workspace is removed from this group.

pub fn removed(&self)

this workspace group has been removed

This event is send when the group associated with the ext_workspace_group_handle_v1 has been removed. After sending this request the compositor will immediately consider the object inert. Any requests will be ignored except the destroy request. It is guaranteed there won’t be any more events referencing this ext_workspace_group_handle_v1.

The compositor must remove all workspaces belonging to a workspace group via a workspace_leave event before removing the workspace group.

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 Resource for ExtWorkspaceGroupHandleV1

type Request = Request

The request enum for this interface

type Event<'event> = 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: 'static,

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn Any + Sync + Send>>

Access the raw data associated with this object.

fn handle(&self) -> &WeakHandle

Access the backend handle associated with this object

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

Create an object resource from its ID

fn send_event( &self, evt: <ExtWorkspaceGroupHandleV1 as Resource>::Event<'_>, ) -> Result<(), InvalidId>

Send an event to this object

fn parse_request( conn: &DisplayHandle, msg: Message<ObjectId, OwnedFd>, ) -> Result<(ExtWorkspaceGroupHandleV1, <ExtWorkspaceGroupHandleV1 as Resource>::Request), DispatchError>

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: <ExtWorkspaceGroupHandleV1 as Resource>::Event<'a>, ) -> Result<Message<ObjectId, BorrowedFd<'a>>, InvalidId>

Serialize an event for this object

fn client(&self) -> Option<Client>

The client owning this object

fn is_alive(&self) -> bool

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

fn post_error(&self, code: impl Into<u32>, error: impl Into<String>)

Trigger a protocol error on this object

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

Creates a weak handle to this object

impl Eq for ExtWorkspaceGroupHandleV1