Class representing QNX display methods. More...

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

Inheritance diagram for kanzi::qnx::QnxDisplayMethods:

Public Member Functions
KZ_NO_DISCARD int	getId () const noexcept
	Tries to get a display ID for a display handle.

KZ_NO_DISCARD optional< windowing::Size >	getSize () const noexcept
	Tries to get the size of this display.

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.

Public Member Functions inherited from kanzi::qnx::QnxPropertyHost< QnxDisplayMethods, KANZI_GENERATE_QNX_PROPERTY_HOST_SIGNATURE(display)>
KZ_NO_DISCARD optional< string >	getPropertyCv (size_t stringBufferSize, int propertyName) const noexcept
	Gets QNX property consisting of a string.

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Member Functions
	QnxDisplayMethods () noexcept=default
	Constructor.

	QnxDisplayMethods (const NativeHandleType &handle) noexcept
	Constructor.

Protected Member Functions inherited from kanzi::OptionalHandle< screen_display_t, nullptr, trivialDeleteFunc< screen_display_t > >
KZ_NO_DISCARD optional< screen_display_t >	createOptional () const noexcept
	Creates a kanzi::optional copy of the native handle.

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

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

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

KZ_NO_DISCARD screen_display_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 screen_display_t &&	operator* () &&noexcept
	Provides access to stored handle via rvalue reference.

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

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

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

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

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

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

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

	OptionalHandle () noexcept
	Constructor.

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

	OptionalHandle (const screen_display_t &nativeHandle) noexcept
	Constructor.

	OptionalHandle (OptionalHandle &&other) noexcept
	Move constructor.

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

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

void	reset (U &&newHandle) noexcept
	Stores a new handle inside.

void	swap (OptionalHandle &other)
	Swap function.

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

	~OptionalHandle ()
	Destructor.

Protected Member Functions inherited from kanzi::qnx::QnxPropertyHost< QnxDisplayMethods, KANZI_GENERATE_QNX_PROPERTY_HOST_SIGNATURE(display)>
KZ_NO_DISCARD optional< string >	getPropertyCv (size_t stringBufferSize, int propertyName) const noexcept
	Gets QNX property consisting of a string.

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

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

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

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

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

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

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

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

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

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

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

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

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

Static Protected Member Functions
static KZ_NO_DISCARD QnxDisplayMethods	create (const QnxContext &qnxContext, optional< unsigned int > displayIndex) noexcept
	Tries to create a QNX display.

Static Protected Member Functions inherited from kanzi::OptionalHandle< screen_display_t, nullptr, trivialDeleteFunc< screen_display_t > >
static constexpr auto	getDeleter () noexcept
	Gets deleter function.

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

Additional Inherited Members
Protected Types inherited from kanzi::OptionalHandle< screen_display_t, nullptr, trivialDeleteFunc< screen_display_t > >
using	HandleType
	Alias for this handle type.

using	NativeHandleType
	Alias for the underlying native handle type.

Protected Attributes inherited from kanzi::OptionalHandle< screen_display_t, nullptr, trivialDeleteFunc< screen_display_t > >
FlatOptional< screen_display_t, sentinel >	m_handle
	Native handle that is managed by this class.

Detailed Description

Class representing QNX display methods.

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

See also: QnxDisplay

Since: Kanzi 4.0.0 changed to use QnxPropertyHost interface.; Kanzi 4.0.0 inherits from OptionalHandle.; Kanzi 4.0.0 QnxDisplay is now a safe wrapper around QnxDisplayMethods.

Constructor & Destructor Documentation

◆ QnxDisplayMethods() [1/2]

kanzi::qnx::QnxDisplayMethods::QnxDisplayMethods ( )

explicitprotecteddefaultnoexcept

Constructor.

◆ QnxDisplayMethods() [2/2]

kanzi::qnx::QnxDisplayMethods::QnxDisplayMethods ( const NativeHandleType & handle )

explicitprotectednoexcept

Constructor.

Parameters

handle Native handle.

Member Function Documentation

◆ getSize()

KZ_NO_DISCARD optional< windowing::Size > kanzi::qnx::QnxDisplayMethods::getSize ( ) const

noexcept

Tries to get the size of this display.

Return values

nullopt Getting the size has failed.

Returns: Display size in pixels.

Since: Kanzi 4.0.0 renamed from tryGetSize.

◆ getId()

KZ_NO_DISCARD int kanzi::qnx::QnxDisplayMethods::getId ( ) const

noexcept

Tries to get a display ID for a display handle.

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

Since: Kanzi 4.0.0 renamed from tryGetId.

◆ isAttached()

KZ_NO_DISCARD bool kanzi::qnx::QnxDisplayMethods::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::QnxDisplayMethods::isDetachable ( ) const

noexcept

Checks whether the display is detachable.

Returns: True when the display is detachable, false otherwise.

◆ create()

static KZ_NO_DISCARD QnxDisplayMethods kanzi::qnx::QnxDisplayMethods::create	(	const QnxContext &	qnxContext,
		optional< unsigned int >	displayIndex )

staticprotectednoexcept

Tries to create a QNX display.

Parameters

qnxContext	QNX context.
displayIndex	Target display index.

Returns: The created object. If error occurred, empty.

Since: Kanzi 4.0.0

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

kanzi/platform/platform/windowing_ng/qnx_screen/qnx_screen_display.hpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QnxDisplayMethods() [1/2]

◆ QnxDisplayMethods() [2/2]

Member Function Documentation

◆ getSize()

◆ getId()

◆ isAttached()

◆ isDetachable()

◆ create()