home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 8 Other / 08-Other.zip / xfeel2.zip / manual.doc next >
Text File  |  1994-04-24  |  6KB  |  130 lines
  1. Manual for XFeel Version 2.0
  2.  
  3. The new xfeel version now consists of two parts. First the xfeel as known
  4. from versions 1.x and secondly a utility to assign hotkeys to predefined
  5. actions.
  6.  
  7. Necessary files:
  8.     xfeel.exe
  9.     xfeel2.dll
  10.     xfeel.ico
  11.  
  12. To install xfeel, put xfeel.exe in your startup folder and xfeel2.dll
  13. somewhere in your LIBPATH. 
  14.  
  15. After startup a dialog box is shown where you can configure xfeel. With the
  16. buttons 'Save' and 'Load' you can save resp. load a configuration set. If 
  17. you specify a configurationfile as a command line parameter no dialog is
  18. shown at startup.
  19.  
  20. The dialogbox consists of two independent parts:
  21.  
  22. 1. XFeel. By pressing this pushbutton you get another dialog where you can 
  23. specify your xfeel options. There are the following options:
  24. -    turn xfeel on or off.
  25. -    dynamic or static Z-Ordering. With static ordering the window below
  26.     the mouse pointer gets active without being moved to front. With
  27.     dynamic Z-Ordering the window is raised automatically.
  28. -    Hide mouse. The mouse pointer is hidden after typing any key. It gets
  29.     visible again, after a movement of the mouse.
  30. -    Click to front. With static Z-Ordering a window stays in the back,
  31.     as long as you don't click into the titlebar. By specifying this 
  32.     option you can click anywhere into a window to raise it to the top.
  33.  
  34. 2. Hotkeys. This feature uses most of the place in the initial dialog. It
  35. is possible, to assign an action to most of the keys on your keyboard.
  36.  
  37. Proceedings to assign an action to a key:
  38. a.    In the upper listbox all windows are listed that are open right now.
  39.     By doubleclicking on the name or by selecting it and pressing the 
  40.     'Insert' button you move the name to the lower listbox. This is
  41.     a list of windows having assigned an action to them. A window 
  42.     may have several actions assigned to. By selecting a window in
  43.     the lower listbox and pressing the 'Remove' button the window is
  44.     deleted from the lower listbox. There are two special windows shown
  45.     on top of the upper listbox. 'Active window' if you want to specify
  46.     an action for that one resp. 'No Window' if you want a hotkey not
  47.     influencing a predefined window.
  48. b.    After you selected a window in the upper list and by this moved it to
  49.     the lower one, you can assign the hotkey to it. You do this by
  50.     selecting the entry in the listbox and pressing the 'Define' button.
  51.     You get a little dialogbox to assign the key. Press the button
  52.     'Start'. You may now press the key you want assigned. You'll see the
  53.     scancode as well as the modifiers (Shift, Alt, Ctrl) you pressed.
  54.     After you pressed the desired key, you have to press the 'Stop' button
  55.     to acknowledge your choice and to press the 'Ok' button. With the 
  56.     'Test' button you may test, if your hotkey works. If it does you will
  57.     hear a beep. If everything went right you'll see an asterix in front
  58.     of the window name in the lower listbox.
  59. c.    Now you have choosen a window and a key. You still have to defined 
  60.     the action which is to be taken. Again you have to select a window
  61.     shown in the lower listbox. Then you may press the 'Action' button.
  62.     Once more you'll get to another dialogbox. There are two main classes
  63.     of actions. There are standard actions as well as custom actions. For 
  64.     a custom action you have to write your own dll with a function 
  65.     corresponing the following syntax:
  66.  
  67.         void function (HWND window);
  68.  
  69.     The parameter given to your function is the actual window handle of
  70.     the assigned window. You have to enter the name of the dll as well 
  71.     as the name of the function. After marking the checkbox 'Custom 
  72.     action' you get two entryfields, where you can do exactly that.
  73.  
  74.     The other class of actions are standard actions. These are 5 pre-
  75.     defined actions, which probably will be used quite often:
  76.     -    Show Window. The assigned window is brought to front or 
  77.         restored if it was previously minimized. However the window
  78.         aready has to be open.
  79.     -    Close Window. The assigned window is closed.
  80.     -    Minimize window. The assigned window is minimized.
  81.     -    Maximize window. The assigned window is maximized. Didn't
  82.         expect that, did you?   ;-)
  83.     -    Start session. A new session is started. The two entryfields
  84.         'Command' and 'Parameter' get enabled and you can enter the 
  85.         name and eventually the parameter(s) for it. Often you will
  86.         assign a hotkey who starts a session with the window 'No
  87.         Window' assigned to it.
  88.     -    Post Message. Posts a message to the assigned window. The 
  89.         message type may be selected in the combobox 'Message' and 
  90.         the two message parameters in the entryfields 'Param 1' and
  91.         'Param 2'.
  92.  
  93. Some more remarks:
  94. 1.    By pressing the 'Ok' button in the first dialogbox, your settings 
  95.     get active.
  96. 2.    By pressing the 'Unload' button, xfeel is unloaded and therefore no
  97.     more hotkeys are active.
  98. 3.    At startup, if you haven't given a startup file with your own defini-
  99.     tions, there is one predefined action. The hotkey dialog window is 
  100.     assigned to the key 'F12' with the action 'Show Window'. Therefore,
  101.     by pressing 'F12' you may view the xfeel window anytime (as long as
  102.     xfeel is active).
  103. 4.    At the bottom of the dialogbox,is a checkbox named 'Full hierarchy'.
  104.     Normally, in the lower listbox, only the actual window title is
  105.     shown. By marking this checkbox, the names of all parent windows of it
  106.     are shown as well. The names are separated by a '|'.
  107.  
  108.  
  109. Any remarks are welcomed. However no answer is guaranteed. My email
  110. adress you'll find in the 'About' box. However I'll write it here once again.
  111.  
  112.     mhof@iiic.ethz.ch
  113.  
  114.     Have fun
  115.  
  116.         Markus
  117.  
  118. PS: This program is freeware. So you may copy it freely without any restric-
  119. tions. However I'd prefer if you let the files intact, as well it would even
  120. be nicer if you'd include this doc-file too.
  121.  
  122. PPS: Wrote a custom action which you think is great, and not too special to
  123. be of use to other people as well? Don't hesitate, send it to me. I got a
  124. program to uudecode.
  125.  
  126.  
  127.  
  128.  
  129.     
  130.