An interface to access and set QNX properties. More...

#include <kanzi/core.ui/platform/windowing_ng/qnx_screen/qnx_screen_property_host.hpp>

Public Member Functions
KZ_NO_DISCARD optional< string >	tryGetPropertyCv (size_t stringBufferSize, int propertyName) const noexcept
	Gets QNX property consisting of a string.

KZ_NO_DISCARD optional< vector< int > >	tryGetPropertyIv (size_t returnValueCount, int propertyName) const noexcept
	Gets QNX property consisting of ints.

KZ_NO_DISCARD optional< int >	tryGetPropertyIvSingle (int propertyName) const noexcept
	Gets a QNX property consisting of a single int.

KZ_NO_DISCARD optional< vector< long long > >	tryGetPropertyLlv (size_t returnValueCount, int propertyName) const noexcept
	Gets QNX property consisting of long longs.

KZ_NO_DISCARD optional< long long >	tryGetPropertyLlvSingle (int propertyName) const noexcept
	Gets a QNX property consisting of a single long long.

template<typename T >
KZ_NO_DISCARD optional< vector< T > >	tryGetPropertyPv (size_t returnValueCount, int propertyName) const noexcept
	Gets QNX property consisting of pointers.

template<typename T >
KZ_NO_DISCARD optional< T >	tryGetPropertyPvSingle (int propertyName) const noexcept
	Gets a QNX property consisting of a single pointer.

bool	trySetPropertyCv (int propertyName, string_view propertyValue) noexcept
	Sets QNX property consisting of a string.

bool	trySetPropertyIv (int propertyName, int propertyValue) noexcept
	Sets QNX property consisting of a single int.

bool	trySetPropertyIv (int propertyName, span< int > propertyValue) noexcept
	Sets QNX property consisting of ints.

bool	trySetPropertyLlv (int propertyName, long long propertyValue) noexcept
	Sets QNX property consisting of a single long long.

bool	trySetPropertyLlv (int propertyName, span< long long > propertyValue) noexcept
	Sets QNX property consisting of long longs.

bool	trySetPropertyPv (int propertyName, span< void * > propertyValue) noexcept
	Sets QNX property consisting of pointers.

bool	trySetPropertyPv (int propertyName, void *propertyValue) noexcept
	Sets QNX property consisting of a single pointer.

Detailed Description

template<typename Derived>
class kanzi::qnx::QnxPropertyHost< Derived >

An interface to access and set QNX properties.

Uses CRTP pattern. It is encouraged to derive from it and pass itself as a template parameter.

Template Parameters

Derived CRTP derived class.

Since: Kanzi 3.9.10

Member Function Documentation

◆ tryGetPropertyIv()

template<typename Derived >

KZ_NO_DISCARD optional< vector< int > > kanzi::qnx::QnxPropertyHost< Derived >::tryGetPropertyIv	(	size_t	returnValueCount,
		int	propertyName ) const

noexcept

Gets QNX property consisting of ints.

Parameters

returnValueCount	Number of values to recieve.
propertyName	QNX property name.

Return values

nullopt Getting the property failed.

Returns: Vector of requested property values.

◆ tryGetPropertyIvSingle()

template<typename Derived >

KZ_NO_DISCARD optional< int > kanzi::qnx::QnxPropertyHost< Derived >::tryGetPropertyIvSingle ( int propertyName ) const

noexcept

Gets a QNX property consisting of a single int.

Parameters

propertyName QNX property name.

Return values

nullopt Getting the property failed.

Returns: Requested property.

◆ trySetPropertyIv() [1/2]

template<typename Derived >

bool kanzi::qnx::QnxPropertyHost< Derived >::trySetPropertyIv	(	int	propertyName,
		span< int >	propertyValue )

noexcept

Sets QNX property consisting of ints.

Parameters

propertyName	QNX property name.
propertyValue	Span of values to set property to.

Returns: On success, true, otherwise false.

◆ trySetPropertyIv() [2/2]

template<typename Derived >

bool kanzi::qnx::QnxPropertyHost< Derived >::trySetPropertyIv	(	int	propertyName,
		int	propertyValue )

noexcept

Sets QNX property consisting of a single int.

Parameters

propertyName	QNX property name.
propertyValue	Value to set property to.

Returns: On success, true, otherwise false.

◆ tryGetPropertyPv()

template<typename Derived >

template<typename T >

KZ_NO_DISCARD optional< vector< T > > kanzi::qnx::QnxPropertyHost< Derived >::tryGetPropertyPv	(	size_t	returnValueCount,
		int	propertyName ) const

noexcept

Gets QNX property consisting of pointers.

Template Parameters

T	Pointer type to receive.

Parameters

returnValueCount	Number of values to recieve.
propertyName	QNX property name.

Return values

nullopt Getting the property failed.

Returns: Vector of requested property values.

◆ tryGetPropertyPvSingle()

template<typename Derived >

template<typename T >

KZ_NO_DISCARD optional< T > kanzi::qnx::QnxPropertyHost< Derived >::tryGetPropertyPvSingle ( int propertyName ) const

noexcept

Gets a QNX property consisting of a single pointer.

Template Parameters

T	Pointer type to receive.

Parameters

propertyName QNX property name.

Return values

nullopt Getting the property failed.

Returns: Requested property.

◆ trySetPropertyPv() [1/2]

template<typename Derived >

bool kanzi::qnx::QnxPropertyHost< Derived >::trySetPropertyPv	(	int	propertyName,
		span< void * >	propertyValue )

noexcept

Sets QNX property consisting of pointers.

Parameters

propertyName	QNX property name.
propertyValue	Span of values to set property to.

Returns: On success, true, otherwise false.

◆ trySetPropertyPv() [2/2]

template<typename Derived >

bool kanzi::qnx::QnxPropertyHost< Derived >::trySetPropertyPv	(	int	propertyName,
		void *	propertyValue )

noexcept

Sets QNX property consisting of a single pointer.

Parameters

propertyName	QNX property name.
propertyValue	Value to set property to.

Returns: On success, true, otherwise false.

◆ tryGetPropertyCv()

template<typename Derived >

KZ_NO_DISCARD optional< string > kanzi::qnx::QnxPropertyHost< Derived >::tryGetPropertyCv	(	size_t	stringBufferSize,
		int	propertyName ) const

noexcept

Gets QNX property consisting of a string.

Note: If stringBufferSize is smaller than the requested string, the function truncates it.

Parameters

stringBufferSize	Size of the string to receive.
propertyName	QNX property name.

Return values

nullopt Getting the property failed.

Returns: Requested property.

◆ trySetPropertyCv()

template<typename Derived >

bool kanzi::qnx::QnxPropertyHost< Derived >::trySetPropertyCv	(	int	propertyName,
		string_view	propertyValue )

noexcept

Sets QNX property consisting of a string.

Parameters

propertyName	QNX property name.
propertyValue	Value to set property to.

Returns: On success, true, otherwise false.

◆ tryGetPropertyLlv()

template<typename Derived >

KZ_NO_DISCARD optional< vector< long long > > kanzi::qnx::QnxPropertyHost< Derived >::tryGetPropertyLlv	(	size_t	returnValueCount,
		int	propertyName ) const

noexcept

Gets QNX property consisting of long longs.

Parameters

returnValueCount	Number of values to recieve.
propertyName	QNX property name.

Return values

nullopt Getting the property failed.

Returns: Vector of requested property values.

◆ tryGetPropertyLlvSingle()

template<typename Derived >

KZ_NO_DISCARD optional< long long > kanzi::qnx::QnxPropertyHost< Derived >::tryGetPropertyLlvSingle ( int propertyName ) const

noexcept

Gets a QNX property consisting of a single long long.

Parameters

propertyName QNX property name.

Return values

nullopt Getting the property failed.

Returns: Requested property.

◆ trySetPropertyLlv() [1/2]

template<typename Derived >

bool kanzi::qnx::QnxPropertyHost< Derived >::trySetPropertyLlv	(	int	propertyName,
		span< long long >	propertyValue )

noexcept

Sets QNX property consisting of long longs.

Parameters

propertyName	QNX property name.
propertyValue	Span of values to set property to.

Returns: On success, true, otherwise false.

◆ trySetPropertyLlv() [2/2]

template<typename Derived >

bool kanzi::qnx::QnxPropertyHost< Derived >::trySetPropertyLlv	(	int	propertyName,
		long long	propertyValue )

noexcept

Sets QNX property consisting of a single long long.

Parameters

propertyName	QNX property name.
propertyValue	Value to set property to.

Returns: On success, true, otherwise false.

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

kanzi/core.ui/platform/windowing_ng/qnx_screen/qnx_screen_property_host.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ tryGetPropertyIv()

◆ tryGetPropertyIvSingle()

◆ trySetPropertyIv() [1/2]

◆ trySetPropertyIv() [2/2]

◆ tryGetPropertyPv()

◆ tryGetPropertyPvSingle()

◆ trySetPropertyPv() [1/2]

◆ trySetPropertyPv() [2/2]

◆ tryGetPropertyCv()

◆ trySetPropertyCv()

◆ tryGetPropertyLlv()

◆ tryGetPropertyLlvSingle()

◆ trySetPropertyLlv() [1/2]

◆ trySetPropertyLlv() [2/2]