Kanzi  3.9.8
Kanzi Engine C++ API
kanzi::qnx::QnxEvent Class Reference

Class representing a Qnx event. More...

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

Public Member Functions

KZ_NO_DISCARD QnxScreenEventHandleType getNativeHandle () const noexcept
 Gets Qnx event handle. More...
 
QnxEventoperator= (QnxEvent &&qnxEvent) noexcept
 Move assignment. More...
 
 QnxEvent ()
 Default constructor, creates an empty event. More...
 
 QnxEvent (const QnxScreenEventHandleType windowHandle)
 Constructor. More...
 
 QnxEvent (QnxEvent &&qnxEvent) noexcept
 Move constructor. More...
 
template<typename T >
KZ_NO_DISCARD optional< T > tryGetEventProperty (int propertyName) const noexcept
 Tries to get a property value for a generic property. More...
 
 ~QnxEvent ()
 Destructor. More...
 

Detailed Description

Class representing a Qnx event.

Constructor & Destructor Documentation

kanzi::qnx::QnxEvent::QnxEvent ( )
explicit

Default constructor, creates an empty event.

kanzi::qnx::QnxEvent::QnxEvent ( const QnxScreenEventHandleType  windowHandle)
explicit

Constructor.

Parameters
windowHandleQnx event handle.
Precondition
windowHandle must be a valid event handle.
kanzi::qnx::QnxEvent::~QnxEvent ( )

Destructor.

kanzi::qnx::QnxEvent::QnxEvent ( QnxEvent &&  qnxEvent)
noexcept

Move constructor.

Member Function Documentation

QnxEvent& kanzi::qnx::QnxEvent::operator= ( QnxEvent &&  qnxEvent)
noexcept

Move assignment.

template<typename T >
KZ_NO_DISCARD optional<T> kanzi::qnx::QnxEvent::tryGetEventProperty ( int  propertyName) const
noexcept

Tries to get a property value for a generic property.

Make sure the property value fits into the type of T.

Parameters
propertyNameThe name of the property to query for.
See also
Use the non-member functions to access property values a in type safe manner.
Return values
nulloptTrying to get the value for the property name has failed.
Returns
Event property value.
KZ_NO_DISCARD QnxScreenEventHandleType kanzi::qnx::QnxEvent::getNativeHandle ( ) const
noexcept

Gets Qnx event handle.

Returns
Qnx event handle.

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