NAME

       wayland::server::zwp_idle_inhibitor_v1_t - context object for inhibiting idle behavior

SYNOPSIS

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

       Inherits wayland::server::resource_t.

   Public Member Functions
       std::function< void()> & on_destroy ()
           destroy the idle 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 ()

Detailed Description

       context object for inhibiting idle behavior

       An idle inhibitor prevents the output that the associated surface is visible on from being
       set to a state where it is not visually usable due to lack of user interaction (e.g.
       blanked, dimmed, locked, set to power save, etc.) Any screensaver processes are also
       blocked from displaying.

       If the surface is destroyed, unmapped, becomes occluded, loses visibility, or otherwise
       becomes not visually relevant for the user, the idle inhibitor will not be honored by the
       compositor; if the surface subsequently regains visibility the inhibitor takes effect once
       again. Likewise, the inhibitor isn't honored if the system was already idled at the time
       the inhibitor was established, although if the system later de-idles and re-idles the
       inhibitor will take effect.

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

Member Function Documentation

   std::string wayland::server::resource_t::get_class () [inherited]
       Retrieve the interface name (class) of a resource object.

       Returns
           Interface name of the resource object.

   client_t wayland::server::resource_t::get_client () const [inherited]
       Get the associated client

       Returns
           the client that owns the resource.

   uint32_t wayland::server::resource_t::get_id () const [inherited]
       Get the internal ID of the resource

       Returns
           the internal ID of the resource

   unsigned int wayland::server::resource_t::get_version () const [inherited]
       Get interface version

       Returns
           Interface version this resource has been constructed with.

   std::function< void()> & zwp_idle_inhibitor_v1_t::on_destroy ()
       destroy the idle inhibitor object Remove the inhibitor effect from the associated
       wl_surface.

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

   void wayland::server::resource_t::post_no_memory () const [inherited]
       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.

   bool wayland::server::resource_t::proxy_has_object () const [inherited]
       Check whether this wrapper actually wraps an object.

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

Author

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

Version 1.0.0                            Tue May 17 20wayland::server::zwp_idle_inhibitor_v1_t(3)