Class representing a QNX window. More...

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

Inheritance diagram for kanzi::qnx::QnxWindow:

Public Types
using	NativeHandleType
	Alias for underlying native handle type.

Public Member Functions
bool	createBuffers (int bufferCount) noexcept
	Creates buffers for this window.

KZ_NO_DISCARD optional< windowing::Size >	getBufferSize () const noexcept
	Tries to get the buffer size for this window.

KZ_NO_DISCARD NativeHandleType	getNativeHandle () const noexcept
	Gets underlying native handle.

optional< int >	getUsageFlags () noexcept
	Gets usage flags for this window.

bool	hide () noexcept
	Hides this window.

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

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

	QnxWindow () noexcept
	Constructor.

	QnxWindow (const NativeHandleType nativeHandle) noexcept
	Constructor.

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

	QnxWindow (QnxWindow &&other) noexcept
	Move constructor.

bool	setBufferSize (windowing::Size bufferSize) noexcept
	Sets buffer size for this window.

bool	setPipelineID (int id) noexcept
	Sets screen pipeline ID for this window.

bool	setPosition (windowing::Position windowPosition) noexcept
	Sets position for this window.

bool	setSelfLayout (int selfLayout) noexcept
	Sets self layout for this window.

bool	setSize (windowing::Size windowSize) noexcept
	Sets size for this window.

bool	setSwapInterval (int interval) noexcept
	Sets minimum number of displayed video frames before a buffer swap for this window.

bool	setTransparency (int level) noexcept
	Sets transparency level for this window.

bool	setUsageFlags (int usageFlags) noexcept
	Sets usage flags for this window.

bool	setZOrder (int zorder) noexcept
	Sets z-order for this window.

bool	show () noexcept
	Shows this window.

void	swap (QnxWindow &other) noexcept
	Swap function.

KZ_NO_DISCARD optional< windowing::Position >	tryGetPosition () const noexcept
	Tries to get the x and y screen coordinates for this window.

KZ_NO_DISCARD optional< string >	tryGetPropertyIDString (unsigned int bufferSize) const noexcept
	Tries to get the current ID string for this window.

KZ_NO_DISCARD optional< void * >	tryGetPropertyUserHandle () const noexcept
	Gets user data for this window.

KZ_NO_DISCARD optional< windowing::Size >	tryGetSize () const noexcept
	Tries to get the size for this window.

bool	trySetPropertyDisplay (const QnxDisplay &qnxDisplay) noexcept
	Sets display property for this window.

bool	trySetPropertyIDString (string_view propertyString) noexcept
	Sets a property ID string for this window.

bool	trySetPropertyUserHandle (void *userHandle) noexcept
	Sets user data for this window.

	~QnxWindow ()
	Destructor.

Public Member Functions inherited from kanzi::qnx::QnxPropertyHost< QnxWindow >
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 QnxWindow	tryCreate (const QnxContext &qnxContext) noexcept
	Tries to create a QNX window.

static KZ_NO_DISCARD QnxWindow	tryCreate (QnxContext &qnxContext, const QnxDisplay &qnxDisplay, windowing::Size windowSize, unsigned int bufferCount, int usageFlags, optional< int > pipelineID, optional< int > selfLayout) noexcept
	Tries to create a QNX window.

Detailed Description

Class representing a QNX window.

Since: Kanzi 3.9.10 changed to use QnxPropertyHost interface.

Member Typedef Documentation

◆ NativeHandleType

using kanzi::qnx::QnxWindow::NativeHandleType

Alias for underlying native handle type.

Since: Kanzi 3.9.10

Constructor & Destructor Documentation

◆ QnxWindow() [1/4]

kanzi::qnx::QnxWindow::QnxWindow ( )

explicitnoexcept

Constructor.

◆ QnxWindow() [2/4]

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

explicitnoexcept

Constructor.

Parameters

nativeHandle Native handle.

Since: Kanzi 3.9.10 marked as noexcept.

◆ ~QnxWindow()

kanzi::qnx::QnxWindow::~QnxWindow ( )

Destructor.

◆ QnxWindow() [3/4]

kanzi::qnx::QnxWindow::QnxWindow ( const QnxWindow & other )

delete

Copy constructor.

◆ QnxWindow() [4/4]

kanzi::qnx::QnxWindow::QnxWindow ( QnxWindow && other )

noexcept

Move constructor.

Member Function Documentation

◆ tryCreate() [1/2]

static KZ_NO_DISCARD QnxWindow kanzi::qnx::QnxWindow::tryCreate	(	QnxContext &	qnxContext,
		const QnxDisplay &	qnxDisplay,
		windowing::Size	windowSize,
		unsigned int	bufferCount,
		int	usageFlags,
		optional< int >	pipelineID,
		optional< int >	selfLayout )

staticnoexcept

Tries to create a QNX window.

Parameters

qnxContext	QNX context.
qnxDisplay	QNX display.
windowSize	Size of the window and the window buffer.
bufferCount	Amount of buffers to create for a window.
usageFlags	Usage flag bit mask to use for a window.
pipelineID	QNX Screen pipeline ID.
selfLayout	QNX window self layout option.

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

Since: Kanzi 3.9.10 returns a QnxWindow.; Kanzi 3.9.14 Added selfLayout parameter.

◆ tryCreate() [2/2]

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

staticnoexcept

Tries to create a QNX window.

Parameters

qnxContext QNX context.

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

Since: Kanzi 3.9.10.

◆ operator=() [1/2]

QnxWindow & kanzi::qnx::QnxWindow::operator= ( const QnxWindow & other )

delete

Copy assignment operator.

◆ operator=() [2/2]

QnxWindow & kanzi::qnx::QnxWindow::operator= ( QnxWindow && other )

noexcept

Move assignment operator.

◆ swap()

void kanzi::qnx::QnxWindow::swap ( QnxWindow & other )

noexcept

Swap function.

Parameters

other The object with which to swap.

Since: Kanzi 3.9.10

◆ getNativeHandle()

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

noexcept

Gets underlying native handle.

Returns: Native handle.

◆ createBuffers()

bool kanzi::qnx::QnxWindow::createBuffers ( int bufferCount )

noexcept

Creates buffers for this window.

Parameters

bufferCount Amount of buffers to create.

Returns: True on success, false on failure.

◆ setBufferSize()

bool kanzi::qnx::QnxWindow::setBufferSize ( windowing::Size bufferSize )

noexcept

Sets buffer size for this window.

Parameters

bufferSize Buffer size to set in pixels.

Returns: True on success, false on failure.

◆ getBufferSize()

KZ_NO_DISCARD optional< windowing::Size > kanzi::qnx::QnxWindow::getBufferSize ( ) const

noexcept

Tries to get the buffer size for this window.

Return values

nullopt Getting the buffer size failed.

Returns: Buffer size in pixels.

◆ setSelfLayout()

bool kanzi::qnx::QnxWindow::setSelfLayout ( int selfLayout )

noexcept

Sets self layout for this window.

This property should be set to true (1) before calling setZOrder(), setSize(), setPosition(), setPipelineID(), trySetPropertyDisplay().

Parameters

selfLayout Self layout option. When set to 1, the owner of the window can set properties that could otherwise only be changed by its manager.

Returns: True on success, false on failure.

Since: Kanzi 3.9.14

◆ setUsageFlags()

bool kanzi::qnx::QnxWindow::setUsageFlags ( int usageFlags )

noexcept

Sets usage flags for this window.

Parameters

usageFlags Usage flag bit mask to use.

Returns: True on success, false on failure.

◆ getUsageFlags()

optional< int > kanzi::qnx::QnxWindow::getUsageFlags ( )

noexcept

Gets usage flags for this window.

Return values

nullopt Failed to get usage flags.

Returns: Usage flags.

Since: Kanzi 3.9.10 changed to return the value instead of using an out parameter.

◆ setZOrder()

bool kanzi::qnx::QnxWindow::setZOrder ( int zorder )

noexcept

Sets z-order for this window.

Parameters

zorder Z order to set.

Returns: True on success, false on failure.

◆ show()

bool kanzi::qnx::QnxWindow::show ( )

noexcept

Shows this window.

Returns: True on success, false on failure.

◆ hide()

bool kanzi::qnx::QnxWindow::hide ( )

noexcept

Hides this window.

Returns: True on success, false on failure.

◆ setSize()

bool kanzi::qnx::QnxWindow::setSize ( windowing::Size windowSize )

noexcept

Sets size for this window.

Parameters

windowSize Window size to set in pixels.

Returns: True on success, false on failure.

◆ setPosition()

bool kanzi::qnx::QnxWindow::setPosition ( windowing::Position windowPosition )

noexcept

Sets position for this window.

Child window and embedded window positions are relative to their parent window positions.

Parameters

windowPosition Window position to set in pixels.

Returns: True on success, false on failure.

◆ setTransparency()

bool kanzi::qnx::QnxWindow::setTransparency ( int level )

noexcept

Sets transparency level for this window.

Parameters

level Screen transparency level to set.

Returns: True on success, false on failure.

◆ tryGetSize()

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

noexcept

Tries to get the size for this window.

Return values

nullopt Getting the size failed.

Returns: Window size in pixels.

◆ tryGetPosition()

KZ_NO_DISCARD optional< windowing::Position > kanzi::qnx::QnxWindow::tryGetPosition ( ) const

noexcept

Tries to get the x and y screen coordinates for this window.

Return values

nullopt Getting the position failed.

Returns: Window position.

◆ trySetPropertyUserHandle()

bool kanzi::qnx::QnxWindow::trySetPropertyUserHandle ( void * userHandle )

noexcept

Sets user data for this window.

Parameters

userHandle User data to set.

Returns: True on success, false on failure.

◆ tryGetPropertyUserHandle()

KZ_NO_DISCARD optional< void * > kanzi::qnx::QnxWindow::tryGetPropertyUserHandle ( ) const

noexcept

Gets user data for this window.

Return values

nullopt Getting user data failed.

Returns: User data pointer.

◆ tryGetPropertyIDString()

KZ_NO_DISCARD optional< string > kanzi::qnx::QnxWindow::tryGetPropertyIDString ( unsigned int bufferSize ) const

noexcept

Tries to get the current ID string for this window.

Parameters

bufferSize Maximum buffer size for property ID string.

Return values

nullopt Getting the property ID string failed.

Returns: ID string, clamped to bufferSize.

◆ trySetPropertyIDString()

bool kanzi::qnx::QnxWindow::trySetPropertyIDString ( string_view propertyString )

noexcept

Sets a property ID string for this window.

Parameters

propertyString Property name to set.

Returns: True on success, false on failure.

◆ trySetPropertyDisplay()

bool kanzi::qnx::QnxWindow::trySetPropertyDisplay ( const QnxDisplay & qnxDisplay )

noexcept

Sets display property for this window.

Parameters

qnxDisplay QNX display to use.

Returns: True on success, false on failure.

◆ setPipelineID()

bool kanzi::qnx::QnxWindow::setPipelineID ( int id )

noexcept

Sets screen pipeline ID for this window.

Note: Whenever pipeline ID is set manually, SCREEN_USAGE_OVERLAY flag must also be set in SCREEN_PROPERTY_USAGE. Non-member function setWindowPipelineID does this in addition to setting the pipeline ID. Use it instead if unsure.

Parameters

id	Screen pipeline id to set.

Returns: True on success, false on failure.

◆ setSwapInterval()

bool kanzi::qnx::QnxWindow::setSwapInterval ( int interval )

noexcept

Sets minimum number of displayed video frames before a buffer swap for this window.

Parameters

interval Minimum number of video frames to wait before buffer swap.

Returns: True on success, false on failure.

◆ getQnxPropertyFunctions()

static KZ_NO_DISCARD constexpr QnxPropertyFunctions< NativeHandleType > kanzi::qnx::QnxWindow::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_window.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ NativeHandleType

Constructor & Destructor Documentation

◆ QnxWindow() [1/4]

◆ QnxWindow() [2/4]

◆ ~QnxWindow()

◆ QnxWindow() [3/4]

◆ QnxWindow() [4/4]

Member Function Documentation

◆ tryCreate() [1/2]

◆ tryCreate() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ swap()

◆ getNativeHandle()

◆ createBuffers()

◆ setBufferSize()

◆ getBufferSize()

◆ setSelfLayout()

◆ setUsageFlags()

◆ getUsageFlags()

◆ setZOrder()

◆ show()

◆ hide()

◆ setSize()

◆ setPosition()

◆ setTransparency()

◆ tryGetSize()

◆ tryGetPosition()

◆ trySetPropertyUserHandle()

◆ tryGetPropertyUserHandle()

◆ tryGetPropertyIDString()

◆ trySetPropertyIDString()

◆ trySetPropertyDisplay()

◆ setPipelineID()

◆ setSwapInterval()

◆ getQnxPropertyFunctions()