The KeyRepeatGenerator is an event source decorator that scans the event queue of the EventSource it extends for key-press events and generates from them key-press repetitions. More...

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

Inheritance diagram for kanzi::KeyRepeatGenerator:

[legend]

Public Member Functions
void	gatherEvents (EventQueue &queue) override
	Overrides EventSource::gatherEvents().

optional< NativeEventHandle >	getNativeEventHandle () const noexcept override
	Overrides EventSource::getNativeEventHandle().

EventSourceSharedPtr	getWrappedEventSource () const override
	Overrides EventSourceDecorator::getWrappedEventSource().

bool	hasQueuedEvents () const
	Checks whether the key repeat decorator has events that were not yet dispatched.

	KeyRepeatGenerator (Domain *domain, EventSourceSharedPtr eventSource)
	Constructor.

	~KeyRepeatGenerator () override
	Destructor.

Public Member Functions inherited from kanzi::EventSource
virtual	~EventSource ()=default
	Destructor.

Public Member Functions inherited from kanzi::EventSourceDecorator
virtual	~EventSourceDecorator ()=default
	Destructor.

Detailed Description

The KeyRepeatGenerator is an event source decorator that scans the event queue of the EventSource it extends for key-press events and generates from them key-press repetitions.

You can use this in combination with other event source decorators, and event sources that are not capable of providing key-press repetitions to an Application. When combined with KeyMapEventFilter, it is recommended to use the KeyRepeatGenerator as the event source for the KeyMapEventFilter.

The key-press repetition algorithm works as follows:

When a key-press event consists of only a modifier key, Kanzi does not repeat that key-press event but instead adds it to the already repeated key-press event as a modifier key.
The last-pressed key replaces a previously repeated key-press event and resets the key repetition timers.
Kanzi emits the first key-press repetition after the timeout specified by kanzi::c_keyRepeatDelay, after which the subsequent key-press repetitions occur at the rate specified by kanzi::c_keyRepeatInterval.
A key-release event stops the key-press repetitions only when the released key is not a modifier key. When a modifier key is released, Kanzi removes that modifier key from the repeated key-press event and continues to repeat the key-press event with the remaining modifier keys.