Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

Keyboard Emulator
[Applications]


Detailed Description

keyboard emulator

The keyboard emulator is a special application. It is always the top application in the event manager (first child of evt_root_app).

There is only one keyboard application running (ke_app).

Hisorical note : this is the very first lua application that has been developped in dcplaya :)

Author:
vincent penne


emulator global active mode rule.

#define ke_active_rules_never   "never"
 Keyboard emulator is never active.

#define ke_active_rules_always   "always"
 Keyboard emulator is always active.

#define ke_active_rules_nokbd   "nokbd"
 Keyboard emulator is active only if ke_active is set and no keyboard controller has been detected.

#define ke_active_rules_normal   "normal"
 Keyboard emulator is active only if ke_active is set.

string ke_active_rule
 Current keyboard emulator active rule.

table ke_active_rules
 Table of keyboard active rule functions.


Functions

 ke_addkeypos (var x, var y)
 dl_draw_box (var dl,...)
 ke_addsinglekey (var text, var code, var dl, var list, var spacing)
 ke_addkey (var down, var downcode, var up, var upcode, var spacing)
 ke_shutdown ()
 ke_shutdown_all ()
 ke_set_keynum (var n)
 ke_closest_key (var array, var box, var coef)
 ke_set_active_array (var n)
 ke_framecounter ()
 ke_handle (var app, var evt)
 ke_set_active_rule (var rule)
 Set/get keyboard emulator active stat rule.

 ke_set_active (var s)
 Set keyboard emulator active stat.

 ke_update (var app, var frametime)
 ke_draw ()
 ke_set_theme (var theme)
 Set/Get active theme.

 ke_init ()
 keyboard_emu ()

Variables

boolean ke_active
 Keyboard active status.

boolean ke_shadow_active
 Keyboard active status without applying active rules.


Function Documentation

ke_set_active_rule var  rule  ) 
 

Set/get keyboard emulator active stat rule.

Parameters:
rule new rule or nil for getting current rule.
Returns:
previous rule
See also:
ke_active_rule

ke_active_rules

ke_active_rules_never

ke_active_rules_always

ke_active_rules_normal

ke_active_rules_nokbd

ke_set_active var  s  ) 
 

Set keyboard emulator active stat.

Parameters:
s new state (nil:desactivate KE)

ke_set_theme var  theme  ) 
 

Set/Get active theme.

Parameters:
theme new theme number [1..getn(ke_themes)] or nil for get current.
Returns:
old theme.


dcplaya documentation version 2.0 Generated on November 2004 by doxygen 1.3.6