wayland::server::zwp_idle_inhibit_manager_v1_t(3) Wayland++ wayland::server::zwp_idle_inhibit_manager_v1_t(3)

wayland::server::zwp_idle_inhibit_manager_v1_t - control behavior when display idles

#include <wayland-server-protocol-unstable.hpp>

Inherits wayland::server::resource_t.


std::function< void()> & on_destroy ()
destroy the idle inhibitor object std::function< void(zwp_idle_inhibitor_v1_t, surface_t)> & on_create_inhibitor ()
create a new inhibitor object bool proxy_has_object () const
Check whether this wrapper actually wraps an object. void post_no_memory () const
uint32_t get_id () const
client_t get_client () const
unsigned int get_version () const
std::string get_class ()

control behavior when display idles

This interface permits inhibiting the idle behavior such as screen blanking, locking, and screensaving. The client binds the idle manager globally, then creates idle-inhibitor objects for each surface.

Warning! The protocol described in this file is experimental and backward incompatible changes may be made. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes are done by bumping the version number in the protocol and interface names and resetting the interface version. Once the protocol is to be declared stable, the 'z' prefix and the version number in the protocol and interface names are removed and the interface version number is reset.

Definition at line 623 of file wayland-server-protocol-unstable.hpp.

Retrieve the interface name (class) of a resource object.

Returns

Interface name of the resource object.

Get the associated client

Returns

the client that owns the resource.

Get the internal ID of the resource

Returns

the internal ID of the resource

Get interface version

Returns

Interface version this resource has been constructed with.

create a new inhibitor object

Parameters

id
surface the surface that inhibits the idle behavior

Create a new inhibitor object associated with the given surface.

Definition at line 4342 of file wayland-server-protocol-unstable.cpp.

destroy the idle inhibitor object Destroy the inhibit manager.

Definition at line 4336 of file wayland-server-protocol-unstable.cpp.

Post 'not enough memory' error to the client

If the compositor has not enough memory to fulfill a certail request of the client, this function can be called to notify the client of this circumstance.

Check whether this wrapper actually wraps an object.

Returns

true if there is an underlying object, false if this wrapper is empty

Generated automatically by Doxygen for Wayland++ from the source code.

Mon Apr 22 2024 09:52:15 Version 1.0.0