Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::KeyMapEventFilter Class Reference

The KeyMapEventFilter provides key translation in Kanzi. More...

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

Inheritance diagram for kanzi::KeyMapEventFilter:
[legend]

Public Member Functions

void gatherEvents (EventQueue &queue) override
 Overrides EventSource::gatherEvents(). More...
 
optional< NativeEventHandlegetNativeEventHandle () const noexcept override
 Overrides EventSource::getNativeEventHandle(). More...
 
EventSourceSharedPtr getWrappedEventSource () const override
 Overrides EventSourceDecorator::getWrappedEventSource(). More...
 
 KeyMapEventFilter (EventSourceProperties::KeyMapCollection keyMap, EventSourceSharedPtr eventSource)
 Constructor. More...
 
- Public Member Functions inherited from kanzi::EventSource
virtual ~EventSource ()=default
 Destructor. More...
 
- Public Member Functions inherited from kanzi::EventSourceDecorator
virtual ~EventSourceDecorator ()=default
 Destructor. More...
 

Detailed Description

The KeyMapEventFilter provides key translation in Kanzi.

It scans the events gathered from the event source it extends, and translates them using a key translation set. You can use this in combination with event sources that provide key events.

To create an application that is based on key messages with LogicalKey argument only, when creating the key map event filter, pass the key conversion map as argument, followed by the event source to extend.

See also
EventSourceProperties
Since
Kanzi 3.9.0

Constructor & Destructor Documentation

◆ KeyMapEventFilter()

kanzi::KeyMapEventFilter::KeyMapEventFilter ( EventSourceProperties::KeyMapCollection  keyMap,
EventSourceSharedPtr  eventSource 
)
inlineexplicit

Constructor.

Member Function Documentation

◆ gatherEvents()

void kanzi::KeyMapEventFilter::gatherEvents ( EventQueue queue)
overridevirtual

◆ getNativeEventHandle()

optional<NativeEventHandle> kanzi::KeyMapEventFilter::getNativeEventHandle ( ) const
inlineoverridevirtualnoexcept

◆ getWrappedEventSource()

EventSourceSharedPtr kanzi::KeyMapEventFilter::getWrappedEventSource ( ) const
inlineoverridevirtual

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