kanzi::qnx::QnxDisplay Class Reference

Class representing a QNX display. More...

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

Inheritance diagram for kanzi::qnx::QnxDisplay:

Public Types
using	NativeHandleType
	Alias for underlying native handle type.

Public Member Functions
KZ_NO_DISCARD NativeHandleType	getNativeHandle () const noexcept
	Gets underlying native handle.
KZ_NO_DISCARD bool	isAttached () const noexcept
	Checks whether the display is attached.
KZ_NO_DISCARD bool	isDetachable () const noexcept
	Checks whether the display is detachable.
	QnxDisplay () noexcept
	Constructor.
	QnxDisplay (const NativeHandleType nativeHandle) noexcept
	Constructor.
KZ_NO_DISCARD int	tryGetId () const noexcept
	Tries to get a display ID for a display handle.
KZ_NO_DISCARD optional< windowing::Size >	tryGetSize () const noexcept
	Tries to get the size of this display.
Public Member Functions inherited from kanzi::qnx::QnxPropertyHost< QnxDisplay >
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.
KZ_NO_DISCARD optional< vector< T > >	tryGetPropertyPv (size_t returnValueCount, int propertyName) const noexcept
	Gets QNX property consisting of pointers.
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.

Static Public Member Functions
static KZ_NO_DISCARD constexpr QnxPropertyFunctions< NativeHandleType >	getQnxPropertyFunctions () noexcept
	Creates QNX property functions for this resource.
static KZ_NO_DISCARD QnxDisplay	tryCreate (const QnxContext &qnxContext) noexcept
	Tries to create a QNX display.

Detailed Description

Class representing a QNX display.

Since

Kanzi 3.9.10 changed to use QnxPropertyHost interface.

Member Typedef Documentation

NativeHandleType

using kanzi::qnx::QnxDisplay::NativeHandleType

Alias for underlying native handle type.

Since

Kanzi 3.9.10

Constructor & Destructor Documentation

QnxDisplay() [1/2]

kanzi::qnx::QnxDisplay::QnxDisplay ( )

explicitnoexcept

Constructor.

Since

Kanzi 3.9.10

QnxDisplay() [2/2]

kanzi::qnx::QnxDisplay::QnxDisplay ( const NativeHandleType nativeHandle )

explicitnoexcept

Constructor.

Parameters

nativeHandle

Native handle.

Since

Kanzi 3.9.10 marked as noexcept.

Member Function Documentation

tryCreate()

static KZ_NO_DISCARD QnxDisplay kanzi::qnx::QnxDisplay::tryCreate ( const QnxContext & qnxContext )

staticnoexcept

Tries to create a QNX display.

Parameters

qnxContext

QNX context.

Returns

The created object. If error occurred, empty.

Since

Kanzi 3.9.10

getNativeHandle()

KZ_NO_DISCARD NativeHandleType kanzi::qnx::QnxDisplay::getNativeHandle ( ) const

noexcept

Gets underlying native handle.

Returns

Native handle.

tryGetSize()

KZ_NO_DISCARD optional< windowing::Size > kanzi::qnx::QnxDisplay::tryGetSize ( ) const

noexcept

Tries to get the size of this display.

Return values

nullopt

Getting the size has failed.

Returns

Display size in pixels.

tryGetId()

KZ_NO_DISCARD int kanzi::qnx::QnxDisplay::tryGetId ( ) const

noexcept

Tries to get a display ID for a display handle.

Returns

The display ID as natural number on success. Zero on failure.

isAttached()

KZ_NO_DISCARD bool kanzi::qnx::QnxDisplay::isAttached ( ) const

noexcept

Checks whether the display is attached.

Returns

True when the display is attached, false otherwise.

isDetachable()

KZ_NO_DISCARD bool kanzi::qnx::QnxDisplay::isDetachable ( ) const

noexcept

Checks whether the display is detachable.

Returns

True when the display is detachable, false otherwise.

getQnxPropertyFunctions()

static KZ_NO_DISCARD constexpr QnxPropertyFunctions< NativeHandleType > kanzi::qnx::QnxDisplay::getQnxPropertyFunctions ( )

inlinestaticconstexprnoexcept

Creates QNX property functions for this resource.

Returns

The QnxPropertyFunctions struct for this resource.

Since

Kanzi 3.9.10

---

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

• kanzi/core.ui/platform/windowing_ng/qnx_screen/qnx_screen_display.hpp