Struct ZcosmicWorkspaceHandleV2

pub struct ZcosmicWorkspaceHandleV2 { /* private fields */ }

Available on crate feature wayland and Linux only.

a workspace handing a group of surfaces

A zcosmic_workspace_handle_v2 object represents a a workspace that handles a group of surfaces.

Each workspace has a name, conveyed to the client with the name event; a list of states, conveyed to the client with the state event; and optionally a set of coordinates, conveyed to the client with the coordinates event. The client may request that the compositor activate or deactivate the workspace.

Each workspace can belong to only a single workspace group. Depepending on the compositor policy, there might be workspaces with the same name in different workspace groups, but these workspaces are still separate (e.g. one of them might be active while the other is not).

See also the Event enum for this interface.

Implementations

impl ZcosmicWorkspaceHandleV2

pub fn destroy(&self)

destroy the zcosmic_workspace_handle_v1 object

This request should be called either when the client will no longer use the zcosmic_workspace_handle_v1.

pub fn rename(&self, name: String)

rename this workspace

Request that this workspace is renamed.

There is no guarantee the workspace will actually be renamed.

pub fn set_tiling_state(&self, state: TilingState)

change the tiling state of this workspace

Request that this workspace’s tiling state is changed.

There is no guarantee the workspace will actually change it’s tiling state.

pub fn move_before(&self, other_workspace: &ExtWorkspaceHandleV1, axis: u32)

move before a different workspace

Move a workspace to be before another workspace along a given axis.

other_workspace may be on the same workspace group, or on a different group. If it’s a different set, the workspace will also be moved to that group.

axis should be a valid index in the coordinates on the workspace group other_workspace is on. The workspace will be positioned on the target group to have a coordinate with this component less than the value of the component for other_workspace. The exact coordinate values, or how other workspaces are moved to accommodate the workspace, is unspecified.

The request will be ignored if axis is invalid or the compositor is otherwise unable to move the workspace.

There is no guarantee the workspace will actually be moved.

pub fn move_after(&self, other_workspace: &ExtWorkspaceHandleV1, axis: u32)

move after a different workspace

Move a workspace to be after another workspace along a given axis.

See move_before.

pub fn pin(&self)

pin the workspace

Request that this workspace be pinned.

There is no guarantee the workspace will be actually pinned.

pub fn unpin(&self)

pin the workspace

Request that this workspace be unpinned.

There is no guarantee the workspace will be actually unpinned.

Trait Implementations

impl Borrow<ObjectId> for ZcosmicWorkspaceHandleV2

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZcosmicWorkspaceHandleV2

fn clone(&self) -> ZcosmicWorkspaceHandleV2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZcosmicWorkspaceHandleV2

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

Formats the value using the given formatter.

impl Hash for ZcosmicWorkspaceHandleV2

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<ZcosmicWorkspaceHandleV2>> for ZcosmicWorkspaceHandleV2

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

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

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

Send a request for this object.

fn send_constructor<I>( &self, req: <ZcosmicWorkspaceHandleV2 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<ZcosmicWorkspaceHandleV2, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> ZcosmicWorkspaceHandleV2

Create an inert object proxy

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

Parse a event for this object

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