Struct ZcosmicWorkspaceHandleV1

pub struct ZcosmicWorkspaceHandleV1 { /* private fields */ }

a workspace handing a group of surfaces

A zcosmic_workspace_handle_v1 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 ZcosmicWorkspaceHandleV1

pub fn destroy(&self)

destroy the zcosmic_workspace_handle_v1 object

Destroys the zcosmic_workspace_handle_v1 object.

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

pub fn activate(&self)

activate the workspace

Request that this workspace be activated.

There is no guarantee the workspace will be actually activated, and behaviour may be compositor-dependent. For example, activating a workspace may or may not deactivate all other workspaces in the same group.

pub fn deactivate(&self)

activate the workspace

Request that this workspace be deactivated.

There is no guarantee the workspace will be actually deactivated.

pub fn remove(&self)

remove the workspace

Request that this workspace be removed.

There is no guarantee the workspace will be actually removed.

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.

Trait Implementations

impl Borrow<ObjectId> for ZcosmicWorkspaceHandleV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZcosmicWorkspaceHandleV1

fn clone(&self) -> ZcosmicWorkspaceHandleV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZcosmicWorkspaceHandleV1

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

Formats the value using the given formatter.

impl Hash for ZcosmicWorkspaceHandleV1

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

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

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

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 ZcosmicWorkspaceHandleV1