The KeyInput Object
===================

INTRODUCTION

     The KeyInput Object is an Object which you may use in your applications
for the purpose of responding to keyboard activity.
     Three types of events are associated with KeyInput Objects: Pressed,
Repeated and Released.  A script written for the Pressed event will execute
when the designated key is pressed down.  A script written for the Repeated
event will execute regularly as the designated key is held down.  And a
script written for the Released event will execute when the designated key is
finally released.
     NOTE: The designated key may also involve command keys, such as SHIFT
and CONTROL, to be held down when the key is pressed, as will be explained
below.

INSTALLATION

Copy the KeyInput directory into your XtraTools directory used by CanDo.
If you are working with the original CanDo distribution floppies, there may
not be enough room for the directory on the CanDoExtras disk.  One solution
might be to move the entire XtraTools directory to RAM, or to the CanDo
disk (you might have to delete some other files from the CanDo disk to do
so), but wherever you put it, be sure to update the XtraTools ToolType in
the CanDo icon or the cando.defaults file in the "s" directory on the CanDo
disk.

To move the entire KeyInput directory using Workbench, drag the KeyInput
icon onto the XtraTools icon.  The copy will be performed and will take
only a few moments.  From CLI just type

	"copy KeyInput [wherever]:XtraTools all"

and the copy will be performed.

USING THE KeyInput OBJECT

     From the main panel, press on the button marked "Xtra."  A requester
titled, "Extra Objects/Tools System," will appear.  Position on the KeyInput
line and select the "Perform" button.  The "KeyInput Object System" requester
will appear.  Select the "Add" button to create a KeyInput Object.  If the
KeyInput Object System was properly installed, you will now see the "KeyInput
Object Editor."  If not, repeat the installation procedures above and try to
use the KeyInput Object again.  If problems persist, call INOVAtronics
Technical support at (214) 340-4991.
     Three Fields in the "KeyInput Object Editor" must be filled out for each
KeyInput Object you create.  The first Field, "Name," is the name of the
KeyInput Object you are creating and can be anything you wish.
     The "Key Code" Field contains the code for the actual key which will
trigger an event.  The following Key Codes are valid for this Field:
        
0               P               CAPSLOCK        NUM7            
1               Q               CLOSEBRACK      NUM8            
2               R               COMMA           NUM9            
3               S               COMMODORE       NUMASTERISK     
4               T               CONTROL         NUMCLOSEPAR     
5               U               DELETE          NUMHYPHEN       
6               V               DOWN            NUMOPENPAR      
7               W               ENTER           NUMPERIOD       
8               X               EQUAL           NUMPLUS         
9               Y               ESCAPE          NUMSLASH        
A               Z               HELP            OPENBRACK       
B               F1              HYPHEN          PERIOD          
C               F2              INTER1          RETURN          
D               F3              INTER2          RIGHT           
E               F4              LEFT            RIGHTALT        
F               F5              LEFTALT         RIGHTAMIGA      
G               F6              LEFTAMIGA       RIGHTSHIFT      
H               F7              LEFTSHIFT       SEMICOLON       
I               F8              NUM0            SINGLEQUOTE     
J               F9              NUM1            SLASH           
K               F10             NUM2            SPACE           
L               ACCENT          NUM3            TAB             
M               AMIGA           NUM4            UP              
N               BACKSLASH       NUM5                    
O               BACKSPACE       NUM6            

     The "Command Keys" Field contains the set of keys (up to three) which
must also be held down when the key specified in the "Key Code" Field is
pressed.  If more than one Command Key is desired, each must be separated by
a space.  If you do not require any Command Keys, then enter NONE into the
"Command Keys" Field.

These five command keys can be used in any sequence:

CAPSLOCK        LEFTMOUSE       RIGHTMOUSE       
CONTROL         MIDDLEMOUSE      
     
along with one command key from each of the four groups below:

SHIFT KEYS      ALT KEYS        LEFT AMIGA      RIGHT AMIGA
----------      --------        ----------      -----------
BOTHSHIFTS      ALT             COMMODORE       AMIGA
LEFTSHIFT       BOTHALTS        LEFTAMIGA       RIGHTAMIGA
RIGHTSHIFT      LEFTALT         
SHIFT           RIGHTALT        

     Once you have selected the Key Code and the Command Keys for the
KeyInput Object, you can create the scripts for the events you wish to
monitor.  When finished, select the "OK" button and then the "Exit" button to
return to the Main Panel.  To test your newly added KeyInput Object, select
"Browse."  You can now use the KeyInput Object you just created.
     NOTE: The KeyInput Object System is only required for creating and
editing KeyInput Objects.  It is not required for running the created
applications.
