Struct wayland_protocols_plasma::output_management::v1::client::org_kde_kwin_outputmanagement::OrgKdeKwinOutputmanagement

pub struct OrgKdeKwinOutputmanagement { /* private fields */ }

configuration of server outputs through clients

This interface enables clients to set properties of output devices for screen configuration purposes via the server. To this end output devices are referenced by global org_kde_kwin_outputdevice objects.

outputmanagement (wl_global)

request:

• create_configuration -> outputconfiguration (wl_resource)

outputconfiguration (wl_resource)

requests:

• enable(outputdevice, bool)
• mode(outputdevice, mode_id)
• transformation(outputdevice, flag)
• position(outputdevice, x, y)
• apply

events:

• applied
• failed

The server registers one outputmanagement object as a global object. In order to configure outputs a client requests create_configuration, which provides a resource referencing an outputconfiguration for one-time configuration. That way the server knows which requests belong together and can group them by that.

On the outputconfiguration object the client calls for each output whether the output should be enabled, which mode should be set (by referencing the mode from the list of announced modes) and the output’s global position. Once all outputs are configured that way, the client calls apply. At that point and not earlier the server should try to apply the configuration. If this succeeds the server emits the applied signal, otherwise the failed signal, such that the configuring client is noticed about the success of its configuration request.

Through this design the interface enables atomic output configuration changes if internally supported by the server.

This interface has no events.

Implementations

impl OrgKdeKwinOutputmanagement

pub fn create_configuration<U: Send + Sync + 'static, D: Dispatch<OrgKdeKwinOutputconfiguration, U> + 'static>( &self, qh: &QueueHandle<D>, udata: U ) -> OrgKdeKwinOutputconfiguration

provide outputconfiguration object for configuring outputs

Request an outputconfiguration object through which the client can configure output devices.

Trait Implementations

impl Borrow<ObjectId> for OrgKdeKwinOutputmanagement

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for OrgKdeKwinOutputmanagement

fn clone(&self) -> OrgKdeKwinOutputmanagement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OrgKdeKwinOutputmanagement

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

Formats the value using the given formatter.

impl Hash for OrgKdeKwinOutputmanagement

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

fn eq(&self, other: &Weak<OrgKdeKwinOutputmanagement>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for OrgKdeKwinOutputmanagement

fn eq(&self, other: &OrgKdeKwinOutputmanagement) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Proxy for OrgKdeKwinOutputmanagement

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 OrgKdeKwinOutputmanagement