Represents a Wayland seat and abstracts the underlying capabilities. More...

#include <kanzi/core.ui/platform/input_ng/wayland/wayland_seat.hpp>

Inheritance diagram for kanzi::wayland::WaylandSeatMethods:

Public Member Functions
template<typename T >
bool	addCapability (typename T::Listener &&listener, void *data) noexcept
	Adds a capability.

template<typename T >
const T &	getCapability () const noexcept

template<typename T >
T &	getCapability () noexcept

template<typename T >
bool	hasCapability () const noexcept
	Checks whether the capability is supported by the current environment.

template<typename T >
bool	isCapabilityAddedByCompositor (uint32_t capabilityMask) const noexcept
	Checks whether a capability was added by the provided capabilityMask.

template<typename T >
bool	isCapabilityRemovedByCompositor (uint32_t capabilityMask) const noexcept
	Checks whether a capability was removed by the provided capabilityMask.

template<typename T >
void	removeCapability () noexcept
	Removes capability.

Static Public Attributes
static const uint32_t	s_maxVersion
	Represents maximum interface version supported by the Wayland implementation that Kanzi libraries were compiled against.

static const wl_interface	s_nativeInterface
	Represents the underlying native interface.

Protected Member Functions
	WaylandSeatMethods () noexcept=default
	Constructor.

	WaylandSeatMethods (const NativeHandleType &handle) noexcept
	Constructor.

Protected Member Functions inherited from kanzi::OptionalHandle< T, sentinel, deleter, typename >
KZ_NO_DISCARD optional< T >	createOptional () const noexcept
	Creates a kanzi::optional copy of the native handle.

KZ_NO_DISCARD const T	get () const noexcept
	Provides access to stored handle.

KZ_NO_DISCARD T	get () noexcept
	Provides access to stored handle.

KZ_NO_DISCARD const T	getNativeHandle () const noexcept
	Provides access to stored handle.

KZ_NO_DISCARD T	getNativeHandle () noexcept
	Provides access to stored handle.

KZ_NO_DISCARD bool	hasValue () const noexcept
	Checks if a handle is stored.

KZ_NO_DISCARD	operator bool () const noexcept
	Conversion operator to bool.

KZ_NO_DISCARD T &&	operator* () &&noexcept
	Provides access to stored handle via rvalue reference.

KZ_NO_DISCARD T &	operator* () &noexcept
	Provides access to stored handle via reference.

KZ_NO_DISCARD const T &&	operator* () const &&noexcept
	Provides access to stored handle via const rvalue reference.

KZ_NO_DISCARD const T &	operator* () const &noexcept
	Provides access to stored handle via const reference.

OptionalHandle &	operator= (const OptionalHandle &other)=delete
	Copy assignment operator.

OptionalHandle &	operator= (const T &value)
	Copy assignment operator.

OptionalHandle &	operator= (OptionalHandle &&other) noexcept
	Move assignment operator.

OptionalHandle &	operator= (T &&value) noexcept
	Move assignment operator.

	OptionalHandle () noexcept
	Constructor.

	OptionalHandle (const OptionalHandle &other)=delete
	Copy constructor.

	OptionalHandle (const T &nativeHandle) noexcept
	Constructor.

	OptionalHandle (OptionalHandle &&other) noexcept
	Move constructor.

T	release () noexcept
	Releases ownership of a native handle without destroying the resource.

void	reset () noexcept
	Replaces stored handle with sentinel value.

template<typename U , typename = enable_if_t<is_same_v<T, decay_t<U>>>>
void	reset (U &&newHandle) noexcept
	Stores a new handle inside.

void	swap (OptionalHandle &other)
	Swap function.

KZ_NO_DISCARD optional< T >	toOptional () &&noexcept
	Converts OptionalHandle to kanzi::optional.

	~OptionalHandle ()
	Destructor.

Additional Inherited Members
Protected Types inherited from kanzi::OptionalHandle< T, sentinel, deleter, typename >
using	HandleType
	Alias for this handle type.

using	NativeHandleType
	Alias for the underlying native handle type.

Static Protected Member Functions inherited from kanzi::OptionalHandle< T, sentinel, deleter, typename >
static constexpr auto	getDeleter () noexcept
	Gets deleter function.

static constexpr T	getSentinel () noexcept
	Gets sentinel value that can be used to represent invalid handle.

Protected Attributes inherited from kanzi::OptionalHandle< T, sentinel, deleter, typename >
FlatOptional< T, sentinel >	m_handle
	Native handle that is managed by this class.

Detailed Description

Represents a Wayland seat and abstracts the underlying capabilities.

Note: Do not use this class directly. Use WaylandSeat instead.

See also: WaylandSeat

Since: Kanzi 3.9.8; Kanzi 4.0.0 WaylandSeat is now a safe wrapper around WaylandSeatMethods.

Constructor & Destructor Documentation

◆ WaylandSeatMethods() [1/2]

kanzi::wayland::WaylandSeatMethods::WaylandSeatMethods ( )

explicitprotecteddefaultnoexcept

Constructor.

◆ WaylandSeatMethods() [2/2]

kanzi::wayland::WaylandSeatMethods::WaylandSeatMethods ( const NativeHandleType & handle )

explicitprotectednoexcept

Constructor.

Parameters

handle Native handle.

Member Function Documentation

◆ hasCapability()

template<typename T >

bool WaylandSeatMethods::hasCapability ( ) const

noexcept

Checks whether the capability is supported by the current environment.

Template Parameters

T	Capability type to check.

Returns: If capability is supported, true, otherwise false.

◆ addCapability()

template<typename T >

bool WaylandSeatMethods::addCapability	(	typename T::Listener &&	listener,
		void *	data )

noexcept

Adds a capability.

Template Parameters

T	Capability type.

Parameters

listener	Listener to attach.
data	Data pointer to receive when the listener is called.

Returns: On success, true, otherwise false.

Since: Kanzi 4.0.0

◆ removeCapability()

template<typename T >

void WaylandSeatMethods::removeCapability ( )

noexcept

Removes capability.

Template Parameters

T	Capability to remove.

Since: Kanzi 4.0.0

◆ isCapabilityAddedByCompositor()

template<typename T >

bool WaylandSeatMethods::isCapabilityAddedByCompositor ( uint32_t capabilityMask ) const

noexcept

Checks whether a capability was added by the provided capabilityMask.

Template Parameters

T	Capability type.

Parameters

capabilityMask Capability mask provided by Wayland.

Returns: If the capability is added, true, otherwise false.

Since: Kanzi 4.0.0

◆ isCapabilityRemovedByCompositor()

template<typename T >

bool WaylandSeatMethods::isCapabilityRemovedByCompositor ( uint32_t capabilityMask ) const

noexcept

Checks whether a capability was removed by the provided capabilityMask.

Template Parameters

T	Capability type.

Parameters

capabilityMask Capability mask provided by Wayland.

Returns: If the capability is removed, true, otherwise false.

Since: Kanzi 4.0.0

◆ getCapability() [1/2]

template<typename T >

const T & kanzi::wayland::WaylandSeatMethods::getCapability ( ) const

noexcept

◆ getCapability() [2/2]

template<typename T >

T & kanzi::wayland::WaylandSeatMethods::getCapability ( )

noexcept

Member Data Documentation

◆ s_nativeInterface

const wl_interface kanzi::wayland::WaylandSeatMethods::s_nativeInterface

static

Represents the underlying native interface.

◆ s_maxVersion

const uint32_t kanzi::wayland::WaylandSeatMethods::s_maxVersion

static

Represents maximum interface version supported by the Wayland implementation that Kanzi libraries were compiled against.

Defines correct maximum possible interface version based on available events and requests.

Since: Kanzi 4.0.0

The documentation for this class was generated from the following file:

kanzi/core.ui/platform/input_ng/wayland/wayland_seat.hpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WaylandSeatMethods() [1/2]

◆ WaylandSeatMethods() [2/2]

Member Function Documentation

◆ hasCapability()

◆ addCapability()

◆ removeCapability()

◆ isCapabilityAddedByCompositor()

◆ isCapabilityRemovedByCompositor()

◆ getCapability() [1/2]

◆ getCapability() [2/2]

Member Data Documentation

◆ s_nativeInterface

◆ s_maxVersion