/*******************************************************************************
FILE NAME    :keyBoardEvents.js
DEPENDENCIES :browser.js
********************************************************************************
____________________________ API DOCUMENTATION BEGIN ___________________________
````````````````````````````````````````````````````````````````````````````````
Functionality for keyboard event capture.

````````````````````````````````````````````````````````````````````````````````
_____________________________ API DOCUMENTATION END ____________________________
*******************************************************************************/

//-- global variables begin ----------------------------------------------------

//set event references to functions
document.onkeydown = keyDown;

//-- global variables end ------------------------------------------------------

//FUNCTION-- returns keycode or false
function getKeyCode(e) {
 var theKey = null;
 if((gBrowser.ns && gBrowser.majorVersion >= 4) || gBrowser.firefox || gBrowser.safari) {theKey = e.which;}
 if(gBrowser.ie && gBrowser.majorVersion >= 4) {theKey = event.keyCode;}
 if(theKey != null) {return theKey;} //if key was captured
 else return false; //if key was not captured
}

//FUNCTION-- validates if the enter key was pressed
function isEnterKey(theKey) {
 if(theKey == 13) return true;
 else return false;
}

//---END