%META:TOPICPARENT{name="OATDOCIndex"}%
---+ keyboard.js

Keyboard events and shortcut handling.

%TOC%

---++ Functions

---+++ OAT.Keyboard.add(key, downCallback, upCallback, group, id, obj)

Listens for pressing a given <tt>key</tt>. 

 <tt>downCallback</tt> and <tt>upCallback</tt> are executed during onkeydown and onkeyup events. 

 <tt>obji</tt> is the element which should handle these events; defaults to document. 

 <tt>group</tt> is a arbitrary string - one can then enable/disable groups of keyboard shortcuts. 

 <tt>id</tt> is not used yet.

---+++ OAT.Keyboard.disable(group)

Disables all shortcuts contained in <tt>group</tt>.

---+++ OAT.Keyboard.enable(group)

Enables all shortcuts contained in <tt>group</tt>.

---++ Example

<verbatim>
var key = "ctrl-alt-7";
var callback = function() { alert('Pressed!'); }
OAT.Keyboard.add(key, callback, false, "mygroup", false, false);
</verbatim>

CategoryDocumentation CategoryOAT CategoryOpenSource