Kanzi  3.9.7
Kanzi Engine API
kanzi::qnx::QnxDisplay Class Reference

Class representing a Qnx display. More...

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

Public Member Functions

KZ_NO_DISCARD QnxScreenDisplayHandleType getNativeHandle () const noexcept
 Gets Qnx display handle. More...
 
KZ_NO_DISCARD bool isAttached () const noexcept
 Checks whether the display is attached. More...
 
KZ_NO_DISCARD bool isDetachable () const noexcept
 Checks whether the display is detachable. More...
 
 QnxDisplay (const QnxContext &qnxContext)
 Constructor. More...
 
 QnxDisplay (const QnxScreenDisplayHandleType displayHandle)
 Constructor. More...
 
KZ_NO_DISCARD int tryGetId () const noexcept
 Tries to get a display ID for a display handle. More...
 
KZ_NO_DISCARD optional< windowing::SizetryGetSize () const noexcept
 Tries to get the size of this display. More...
 

Detailed Description

Class representing a Qnx display.

Constructor & Destructor Documentation

kanzi::qnx::QnxDisplay::QnxDisplay ( const QnxContext qnxContext)
explicit

Constructor.

Parameters
qnxContextQnx context.
kanzi::qnx::QnxDisplay::QnxDisplay ( const QnxScreenDisplayHandleType  displayHandle)
explicit

Constructor.

Parameters
displayHandleQnx display handle.
Precondition
displayHandle must be a valid display handle.

Member Function Documentation

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

Tries to get the size of this display.

Return values
nulloptGetting the size has failed.
Returns
Display size in pixels.
KZ_NO_DISCARD QnxScreenDisplayHandleType kanzi::qnx::QnxDisplay::getNativeHandle ( ) const
noexcept

Gets Qnx display handle.

Returns
Qnx display handle.
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.
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.
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.

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