kanzi::EventSource Class Reference

EventSource class. More...

#include <kanzi/core.ui/input/event_source.hpp>

Inheritance diagram for kanzi::EventSource:

Public Member Functions
virtual void	gatherEvents (EventQueue &queue)=0
	Amends the given event queue with events received so far. More...
virtual KZ_NO_DISCARD optional< NativeEventHandle >	getNativeEventHandle () const noexcept=0
	Returns a waitable event handle for this event source, if available. More...
virtual	~EventSource ()=default
	Destructor. More...

Detailed Description

EventSource class.

Interface for event sources.

Constructor & Destructor Documentation

~EventSource()

virtual kanzi::EventSource::~EventSource ( )

virtualdefault

Destructor.

Member Function Documentation

gatherEvents()

virtual void kanzi::EventSource::gatherEvents ( EventQueue &  queue )

pure virtual

Amends the given event queue with events received so far.

Parameters

queue

Event queue to be amended. Do not clear nor assume to be empty.

Implemented in kanzi::KeyRepeatGenerator, kanzi::KeyMapEventFilter, and kanzi::LegacyEventSource.

getNativeEventHandle()

virtual KZ_NO_DISCARD optional<NativeEventHandle> kanzi::EventSource::getNativeEventHandle ( ) const

pure virtualnoexcept

Returns a waitable event handle for this event source, if available.

Returns

The native event handle, or nullopt if not available.

Implemented in kanzi::KeyRepeatGenerator, kanzi::KeyMapEventFilter, and kanzi::LegacyEventSource.

---

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

• kanzi/core.ui/input/event_source.hpp