DMCP interface  03.15_020
Dialog functions

Keyboard handling for dialogs. More...

Functions

int runner_get_key (int *repeat)
 Wait for key event or timeout. More...
 
int runner_get_key_delay (int *repeat, uint timeout, uint rep0, uint rep1, uint rep1tout)
 Wait for key event or timeout with more autorepeat and timeout control. More...
 
int runner_key_tout_value (const int first)
 Returns key repeat timeout value. More...
 

Detailed Description

Keyboard handling for dialogs.

Function Documentation

◆ runner_get_key()

int runner_get_key ( int *  repeat)

Wait for key event or timeout.

Parameters
[out]repeatPointer to auto-repeat indicator (can be NULL). Returns 1 if key is repeated, 0 otherwise.
Returns
Key code or 0 on timeout.

Autorepeat times depend on values returned by runner_key_tout_value().

Timeout occurs every second.

◆ runner_get_key_delay()

int runner_get_key_delay ( int *  repeat,
uint  timeout,
uint  rep0,
uint  rep1,
uint  rep1tout 
)

Wait for key event or timeout with more autorepeat and timeout control.

Parameters
[out]repeatPointer to auto-repeat indicator (can be NULL). Returns 1 if key is repeated, 0 otherwise.
timeout[ms] Function returns after this timeout
rep0[ms] Repeat rate after key press
rep1[ms] Repeat rate after rep1tout
rep1tout[ms] Repeat rate is changed from rep0 to rep1 after this time
Returns
Key code or 0 on timeout.

◆ runner_key_tout_value()

int runner_key_tout_value ( const int  first)

Returns key repeat timeout value.

Parameters
first1 = timeout after first key press, 0 = consequent timeout
Returns
Timeout value in ms.

Autorepeat times depend on slow autorepeat flag in system

where first time corresponds to first repeat timeout after key press and second time to all consequent.