Struct ZcosmicToplevelManagerV1

pub struct ZcosmicToplevelManagerV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

control open apps

This protocol allows clients such as a taskbar to request the compositor to preform typical actions on open toplevels. The compositor is in all cases free to ignore the request.

See also the Event enum for this interface.

Implementations

impl ZcosmicToplevelManagerV1

pub fn destroy(&self)

destroy the zcosmic_toplevel_manager_v1

This request indicates that the client has finished using the zcosmic_toplevel_manager_v1 object and that it can be safely destroyed.

pub fn close(&self, toplevel: &ZcosmicToplevelHandleV1)

request that a toplevel be closed

If the compositor honors this request, the zcosmic_toplevel_handle_v1.closed event will be sent.

pub fn activate(&self, toplevel: &ZcosmicToplevelHandleV1, seat: &WlSeat)

request that a toplevel be activated

If the compositor honors this request, the zcosmic_toplevel_handle_v1.state event will be sent.

pub fn set_maximized(&self, toplevel: &ZcosmicToplevelHandleV1)

request that a toplevel be maximized

If the compositor honors this request, the zcosmic_toplevel_handle_v1.state event will be sent.

pub fn unset_maximized(&self, toplevel: &ZcosmicToplevelHandleV1)

request that a toplevel be unmaximized

If the compositor honors this request, the zcosmic_toplevel_handle_v1.state event will be sent.

pub fn set_minimized(&self, toplevel: &ZcosmicToplevelHandleV1)

request that a toplevel be minimized

If the compositor honors this request, the zcosmic_toplevel_handle_v1.state event will be sent.

pub fn unset_minimized(&self, toplevel: &ZcosmicToplevelHandleV1)

request that a toplevel be unminimized

If the compositor honors this request, the zcosmic_toplevel_handle_v1.state event will be sent.

pub fn set_fullscreen( &self, toplevel: &ZcosmicToplevelHandleV1, output: Option<&WlOutput>, )

request that a toplevel be fullscreened

If the compositor honors this request, the zcosmic_toplevel_handle_v1.state and potentially the zcosmic_toplevel_handle_v1.output_enter/output_leave events will be sent.

The output parameter a hint to the compositor and may be ignored. A value of NULL indicates that the compositor should choose the target output, if it honors the fullscreen request.

pub fn unset_fullscreen(&self, toplevel: &ZcosmicToplevelHandleV1)

request that a toplevel be unfullscreened

If the compositor honors this request, the zcosmic_toplevel_handle_v1.state event will be sent.

pub fn set_rectangle( &self, toplevel: &ZcosmicToplevelHandleV1, surface: &WlSurface, x: i32, y: i32, width: i32, height: i32, )

designate a rectangle to represent a toplevel

If a client using this protocol displays UI elements corresponding to toplevels, it may use this request to inform the server about such a relation. This information may be used by the server, for example as the target for a minimize animation.

If the client sets more than one rectangle, only the most recently set rectangle is considered.

The dimensions are given in surface-local coordinates.

Setting width=height=0 removes the current rectangle if one was set.

pub fn move_to_workspace( &self, toplevel: &ZcosmicToplevelHandleV1, workspace: &ZcosmicWorkspaceHandleV1, output: &WlOutput, )

move toplevel to workspace

Move window to workspace, on given output.

pub fn set_sticky(&self, toplevel: &ZcosmicToplevelHandleV1)

request that a toplevel be made sticky

If the compositor honors this request, the zcosmic_toplevel_handle_v1.state event will be sent.

pub fn unset_sticky(&self, toplevel: &ZcosmicToplevelHandleV1)

request that a toplevel be removed of the sticky status

If the compositor honors this request, the zcosmic_toplevel_handle_v1.state event will be sent.

pub fn move_to_ext_workspace( &self, toplevel: &ZcosmicToplevelHandleV1, workspace: &ExtWorkspaceHandleV1, output: &WlOutput, )

move toplevel to workspace

Move window to workspace, on given output.

Trait Implementations

impl Borrow<ObjectId> for ZcosmicToplevelManagerV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZcosmicToplevelManagerV1

fn clone(&self) -> ZcosmicToplevelManagerV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZcosmicToplevelManagerV1

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

Formats the value using the given formatter.

impl Hash for ZcosmicToplevelManagerV1

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

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

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

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

Send a request for this object.

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

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> ZcosmicToplevelManagerV1

Create an inert object proxy

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

Parse a event for this object

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