home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 532.lha / PWKeys_v2.0 / SetPWkeys2.0.doc.pp / SetPWkeys2.0.doc
Encoding:
Text File  |  1991-07-10  |  11.2 KB  |  300 lines
  1.  
  2.                              //
  3.                          \\ // SetPWkeys V2.0
  4.                           \//
  5.  
  6.                                1991
  7.                                 by
  8.                           Preben Nielsen
  9.  
  10.  
  11. Note: Below I will talk of both SetPWkeys (off course) AND PWkeys. You
  12.       should also take a look at the PWkeys documentation (perhaps first).
  13.  
  14.  
  15. WHATS NEW
  16.  
  17.     SetPWkeys has been updated to handle the new functions and features
  18.   which have been added to the new version of PWkeys.
  19.  
  20.  
  21. WHAT IS SETPWKEYS ?
  22.  
  23.     SetPWkeys is an program that lets you define key-function bindings
  24.   etc. for use with the PWkeys program. So if you don't use PWkeys then
  25.   you won't have any use for SetPWkeys.
  26.  
  27.  
  28. HOW TO START SETPWKEYS
  29.  
  30.     From CLI      : Type 'SetPWkeys' and press RETURN.
  31.                     There is NO need to use 'RUN', 'RUNBACK', 'ARUN' etc.
  32.                     SetPWkeys is auto-detaching when run from CLI (i.e. It
  33.                     won't prevent you from closing the CLI-window).
  34.  
  35.     From Workbench: Double-click on the SetPWkeys icon.
  36.  
  37.  
  38. WHAT CAN SETPWKEYS DO ?
  39.  
  40.     PWkeys lets you perform 25 functions on windows, screens etc.
  41.   These functions are:
  42.  
  43.   Move-Window-To-Top-Of-Screen
  44.   Move-Window-To-Bottom-Of-Screen
  45.   Move-Window-To-Left-Side-Of-Screen
  46.   Move-Window-To-Right-Side-Of-Screen
  47.   Place-Window-In-Upper-Left-Corner-Of-Screen
  48.   Place-Window-In-Lower-Left-Corner-Of-Screen
  49.   Place-Window-In-Upper-Right-Corner-Of-Screen
  50.   Place-Window-In-Lower-Right-Corner-Of-Screen
  51.   Place-Window-In-Center-Of-Screen
  52.   Move-Window-To-Front
  53.   Move_Window-To-Back
  54.   Move-Backmost-Window-To-Front
  55.   Move_Frontmost-Window-To-Back
  56.   Activate-Previous-Window
  57.   Activate-Next-Window
  58.   Minimize-Window        (only windows with a SIZING-gadget)
  59.   Maximize-Window        (only windows with a SIZING-gadget)
  60.   Refresh-Window
  61.   Move-Backmost-Screen-To-Front
  62.   Move-Frontmost-Screen-To-Back
  63.   Subtract-Bitplane-From-Screen    (Not HAM-screens)
  64.   Add-Bitplane-To-Screen    (Within limits)
  65.   Toggle-Input-Lock
  66.   Toggle Fast-Mouse
  67.   Toggle Sun-Mouse
  68.  
  69.   By default PWkeys binds these functions to the following hotkeys:
  70.  
  71.   LSHIFT-LAMIGA-KP1       : Place-Window-In-Upper-Left-Corner-Of-Screen
  72.   LSHIFT-LAMIGA-KP2       : Move-Window-To-Bottom-Of-Screen
  73.   LSHIFT-LAMIGA-KP3       : Place-Window-In-Lower-Right-Corner-Of-Screen
  74.   LSHIFT-LAMIGA-KP4       : Move-Window-To-Left-Side-Of-Screen
  75.   LSHIFT-LAMIGA-KP5       : Place-Window-In-Center-Of-Screen
  76.   LSHIFT-LAMIGA-KP6       : Move-Window-To-Right-Side-Of-Screen
  77.   LSHIFT-LAMIGA-KP7       : Place-Window-In-Upper-Left-Corner-Of-Screen
  78.   LSHIFT-LAMIGA-KP8       : Move-Window-To-Top-Of-Screen
  79.   LSHIFT-LAMIGA-KP9       : Place-Window-In-Upper-Right-Corner-Of-Screen
  80.   LSHIFT LAMIGA-LEFTARROW : Activate-Previous-Window
  81.   LSHIFT LAMIGE-RIGHTARROW: Activate-Next-Window
  82.   LSHIFT-LAMIGA-DOWNARROW : Move-Window-To-Front
  83.   LSHIFT-LAMIGA-UPARROW   : Move-Window-To-Back
  84.   LSHIFT-LAMIGA-TAB       : Refresh-Window
  85.   LSHIFT-LAMIGA-F1        : Minimize-Window
  86.   LSHIFT-LAMIGA-F2        : Maximize-Window
  87.   LAMIGA-DOWNARROW        : Move-Backmost-Window-To-Front
  88.   LAMIGA-UPARROW          : Move-Frontmost-Window-To-Back
  89.  
  90.   RSHIFT-RAMIGA-DOWNARROW : Move-Backmost-Screen-To-Front
  91.   RSHIFT-RAMIGA-UPARROW   : Move-Frontmost-Screen-To-Back
  92.   RSHIFT-RAMIGA-F9        : Subtract-Bitplane-From-Screen
  93.   RSHIFT-RAMIGA-F10       : Add-Bitplane-To-Screen
  94.  
  95.   LAMIGA-RAMIGA-BACKSPACE : Toggle-Input-Lock
  96.   LAMIGA-RAMIGA-DEL       : Toggle-Fast-Mouse
  97.   LAMIGA-RAMIGA-HELP      : Toggle-Sun-Mouse
  98.  
  99.  
  100.  where
  101.  
  102.   LAMIGA     means the left Amiga/Command key
  103.   RAMIGA     means the right Amiga/Command key
  104.   LSHIFT     means the left 'SHIFT' key
  105.   RSHIFT     means the right 'SHIFT' key
  106.   HELP       means the 'HELP' key
  107.   DEL        means the 'DEL' key
  108.   BACKSPACE  means the '<-' backspace key
  109.   TAB        means the '->|' tabulator key
  110.   KP1        means '1' on the numeric keyboard
  111.   KP2        means '2' on the numeric keyboard
  112.   KP3        means '3' on the numeric keyboard
  113.   KP4        means '4' on the numeric keyboard
  114.   KP5        means '5' on the numeric keyboard
  115.   KP6        means '6' on the numeric keyboard
  116.   KP7        means '7' on the numeric keyboard
  117.   KP8        means '8' on the numeric keyboard
  118.   KP9        means '9' on the numeric keyboard
  119.   F1         means the 'F1' key
  120.   F2         means the 'F2' key
  121.   F9         means the 'F9' key
  122.   F10        means the 'F10' key
  123.   UPARROW    means the arrow-up key
  124.   DOWNARROW  means the arrow-down key
  125.   RIGHTARROW means the arrow-right key
  126.   LEFTARROW  means the arrow-left key
  127.  
  128.  
  129.   SetPWkeys lets you define your own key-function bindings if you aren't
  130.   content with the ones above (this is nearly the sole reason for SetPWkeys
  131.   existence).
  132.  
  133.  
  134. SOME TERM EXPLANATIONS
  135.  
  136.     From now on, the term 'qualifier-key' will mean any one of these:
  137.  
  138.      the CTRL-key
  139.      the CAPSLOCK-key
  140.      the left  SHIFT-key
  141.      the right SHIFT-key
  142.      the left  ALT-key
  143.      the right ALT-key
  144.      the left  AMIGA-key
  145.      the right AMIGA-key
  146.  
  147.     The term 'qualifiers' will mean any combination of qualifier-keys.
  148.  
  149.     The term 'action-key' will mean a key that will trigger some action
  150.     (This could also be a qualifier-key).
  151.  
  152.     The term 'hotkey' will mean a combinations zero or more qualifier-keys
  153.     together with ONE action-key.
  154.  
  155.     LMB will mean the left mouse button.
  156.  
  157.  
  158. WHAT THE SCREEN DISPLAYS
  159.  
  160.     When SetPWkeys is started it will display a single-bitplane screen.
  161.   This screen contains:
  162.  
  163.   1.  In the upper left part of the screen is three boxes named 'Window',
  164.       'Screen' and 'Miscellaneous' containing 18, 4 and 3 function-names
  165.       respectively.
  166.  
  167.   2.  At the bottom of the screen is a picture of the entire KEYBOARD.
  168.  
  169.   3.  In the upper right corner of the KEYBOARD is a string-gadget used for
  170.       saving/loading settings to/from disk.
  171.  
  172.   4.  Just above the KEYBOARD is 5 string-gadgets used for setting mousespeed,
  173.       handler-priority, screen/mouse blanking timeout etc.
  174.  
  175.   5.  In the upper right part of the screen is 8 boolean-gadgets, which will
  176.       be described somewhere below.
  177.  
  178.   6.  The title-bar of the screen used for displaying messages to the
  179.       user (You perhaps).
  180.  
  181. THE FUNCTIONS
  182.  
  183.     The names of the functions is contained in three boxes named 'Window',
  184.   'Screen' and 'Miscellaneous'. The 'Window' box contains 18 functions for
  185.   manipulating windows. The 'Screen' box contains 4 functions for manipulating
  186.   screens. The 'Miscellaneous' box currently contains 3 functions for turning
  187.   special facilities on and off.
  188.  
  189.     To modify the key bindings of any of the 25 functions, simply click
  190.   the mouse on the name of the function. The function is now hilited
  191.   and the KEYBOARD at the bottom of the screen will display the current
  192.   hotkey. When a function that is not hilited appears unreadable it means
  193.   that the function is undefined (i.e. has no hotkey yet).
  194.  
  195.  
  196. THE KEYBOARD
  197.  
  198.     When you have selected one of the 25 functions, the keyboard will
  199.   display the current hotkey. The selected qualifier-keys will appear
  200.   ghosted (like the title-bar on inactive windows under kickstart 1.0-1.3),
  201.   and the selected action-key will appear hilited.
  202.  
  203.     To select a qualifier-key hold down a SHIFT-key and click the LMB on
  204.   the key. To clear it simply hold down a SHIFT-key and click the LMB on
  205.   it again.
  206.  
  207.     To select an action-key just click the LMB on it. To clear it simply
  208.   click the LMB on it again. A qualifier-key can also be used as an
  209.   action-key. It is possible to define a hotkey such as LALT-LSHIFT-RALT
  210.   (i.e. if you hold down the LALT and the LSHIFT, then pressing the RALT
  211.    would trigger some action).
  212.  
  213.  
  214. THE GADGETS
  215.  
  216.     The upper right part of the screen contains 8 boolean-gadgets:
  217.  
  218.     »  The 'Check' gadget which will check if there are any duplicates
  219.        amongst the hotkeys and tell you the result (but it won't show
  220.        you which). It will also check the values in the string-gadgets
  221.        to see if you have specified invalid values. 'Export' and 'Save'
  222.        will automatically use the facility and fail if anything is wrong.
  223.  
  224.     »  The 'Quit' gadget which ends SetPWkeys.
  225.  
  226.     »  The 'Undo' gadget which will undo any modifications you have made
  227.        on the keyboard since you clicked on the current function. This can
  228.        also undo a 'Clear'.
  229.  
  230.     »  The 'Clear' gadget which will undefine the current function by
  231.        wiping the keyboard clean (this can be recoved using 'Undo'). If
  232.        there is any undefined functions when you select 'Save' or 'Export',
  233.        these functions will be disabled (i.e. they accessible through PWkeys).
  234.  
  235.     »  The 'Import' gadget which will grab the hotkeys from the PWkeys handler
  236.        (if the handler is in memory). SetPWkeys will automatically try to
  237.        import the hotkeys when it is started. If it can't, it will display
  238.        the default hotkeys.
  239.  
  240.     »  The 'Export' gadget which will copy the hotkeys to the PWkeys handler
  241.        (if the handler is in memory).
  242.  
  243.     »  The 'Save' gadget which will save the hotkeys to a file (the file
  244.        can then be used by PWkeys).  Type the name of the file in the
  245.        string-gadget in the upper right corner of the KEYBOARD. You must
  246.        type the the name BEFORE hitting 'Save'.
  247.  
  248.     »  The 'Load' gadget which will load hotkeys from a file (iff the
  249.        file has been created with this correct version of SetPWkeys). Type
  250.        the name of the file in the string-gadget in the upper right corner
  251.        of the KEYBOARD. You must type the the name BEFORE hitting 'Load'.
  252.  
  253.  
  254.     Just above the KEYBOARD are 5 string-gadgets which are:
  255.  
  256.     »  The 'Screen Off' gadget which lets you specify how long the keyboard
  257.        and mouse should be idle, before the screen blanks (default is 300
  258.        seconds, 0 disables this option).
  259.  
  260.     »  The 'Mouse Off' gadget which lets you specify how long the mouse should
  261.        be idle before it blanks (default is 5 seconds, 0 disables this option).
  262.  
  263.     »  The 'Priority' gadget which lets you specify the priority of the PWkeys
  264.        handler. This is usefull if you have other input-handlers installed
  265.        that causes conflict. You are allowed to specify 0-127 (127 means
  266.        highest priority) but you should not go below 51 if you don't want to
  267.        mess with intuition which lies at 50.
  268.  
  269.     »  The 'Speed' gadget which lets you specify the acceleration factor
  270.        applied to mouse-movements. This can be in the range 0-9 (Default
  271.        is 3)
  272.  
  273.     »  The 'Threshold' gadget which lets you specify the sensitivity
  274.        of the mouse-movements. Higher values means increased sensitivity.
  275.        This can be in the range 0-9 (Default is 1).
  276.  
  277.    NOTE: Setting speed to 1 is in fact the same as having no acceleration at
  278.          all. Setting both speed AND threshold to 0 means that the mouse will
  279.          be immovable. Setting speed to 0 AND threshold > 0 in the mouse being
  280.          SLOWER than normal.
  281.  
  282.  
  283. CREDITS:
  284.  
  285.     Davide P. Cervone for his wKeys from Fisk-disk 128.
  286.     Matt Dillon for DMouse which showed me how to implement mouse-blanking
  287.                 and a SunMouse.
  288.  
  289. =====================================================================
  290.    Send bug-reports, suggestions, comments etc. to:
  291.  
  292.         ///
  293.        ///  Preben Nielsen
  294.  \\\  ///  Oehlenschlægersgade 72 st. T.V.
  295.   \\\///  1663 Copenhagen V.
  296.    \///  Denmark
  297.  
  298.    I would also like to hear from you if you actually use PWkeys/SetPWkeys.
  299.  
  300.