home *** CD-ROM | disk | FTP | other *** search
/ Computerworld 1996 March / Computerworld_1996-03_cd.bin / idg_cd3 / utility / freedk25 / freedock.doc < prev    next >
Text File  |  1996-02-14  |  15KB  |  346 lines
  1. FreeDock v2.5a                                                      03 JUN 95
  2. ==============                                                      ---------
  3.  
  4. What is FreeDock ?
  5. ==================
  6.  
  7. Freedock is another Windows dock program, the difference between this one and
  8. all the other dock programs I have seen, are that you get the source code &
  9. this one does everything I want it to do. If it does not do everything you
  10. want it to do, feel free to modify it and add functionality to it.
  11.  
  12. Freedock is available as 16 and 32 bit executables and runs happily 
  13. under NT (I've only tried Intel so far but I would be interested if
  14. anyone tries comipiling on any other NT architecture).
  15.  
  16. Freedock from v 1.11 is compiled under MS Visual C/C++, although it 
  17. should still compile under Borland C/C++.
  18.  
  19.  
  20. Who Wrote it ?
  21. ==============
  22.  
  23. Author : Sean Gordon
  24.          22 Buller Street
  25.          Lochgelly
  26.          FIFE
  27.          KY5 9AH
  28. Email  : sean.gordon@dundee.ATTGIS.com
  29.  
  30.  
  31.  
  32. How Free is FreeDock ?
  33. ======================
  34.  
  35. Completely free, if you like it, send me an Email or a postcard.
  36. You can modify the source code & redistribute it with three conditions:
  37.  
  38. 1) The program must remain FreeWare.
  39. 2) The Source code must always be provided.
  40. 3) The program & Docs must always mention my name.
  41.  
  42.  
  43. What's new since v2.00 ?
  44. ========================
  45.  
  46. Freedock ported to Windows NT as well as 16 bit windows, now supplied in 
  47. 16 & 32 bit versions.
  48.  
  49. Applications in the dock can now be started as "Always On Top"
  50.  
  51. Code ported to Microsoft Visual C (v1.5 for 16bit & v2.0 for 32bit) mostly
  52. minor changes.
  53.  
  54. The method for Grabbing a window has been changed to support NT.
  55.  
  56. A Previewer is now provided to allow the stored window size/position for an
  57. application to be viewed and changed without having to start the application.
  58.  
  59. The entire dock can be scaled to a size which suits the user, from double
  60. size down to 1/8th size.
  61.  
  62. Applications in the dock can now be started in "Separate Memory" (NT only).
  63.  
  64. Slots can be locked into the dock to stop them accidentally being dragged off.
  65.  
  66. Separate .INI files for the 16 and 32 bit versions of FreeDock, the .INI file
  67. is now called FREEDK16.INI or FREEDK32.INI
  68.  
  69.  
  70. How do I install it ?
  71. =====================
  72.  
  73. Copy the required version FREEDK16.EXE or FREEDK32.EXE (16 or 32 bit) 
  74. into a directory of your choice and then add it to your windows startup
  75. folder.
  76.  
  77. If you are upgrading from an older version of FreeDock, copy the FREEDOCK.INI
  78. file to either (or both) FREEDK16.INI or FREEDK32.ini depending on the version
  79. you are using.
  80.  
  81. If you have not used FreeDock before, copy one of the .INI files into your 
  82. windows directory, this is not strictly necessary since FreeDock will create 
  83. the file if it does not exist, and assume a set of default values.
  84.  
  85.  
  86. Why is this manual so short ?
  87. =============================
  88.  
  89. The documentation is very brief since I currently do not have the time to
  90. write a proper manual, although most of the functionality is fairly 
  91. obvious (famous last words :-) What d'ya mean it's not intuitive ?
  92.  
  93.  
  94. What Does it do ?
  95. =================
  96.  
  97. This is a dock program for windows, it supports drag'n'drop of applications 
  98. into to dock to add them and also the launching of apps by dropping files 
  99. on them.
  100. Unique feature is the ability to drop a collection of files into the dock
  101. at the same time and have them put into consecutive free slots.
  102. Freedock also allows you to specifiy the start up condition of the
  103. applications in the dock.
  104.  
  105. See the following sections for more details.
  106.  
  107.  
  108.  
  109. Drag and Drop
  110. -------------
  111. I've had a few people ask me what this is, so here is a brief explanation.
  112. Drag & Drop was introduced in Windows 3.1 & is only supported by the 
  113. Windows file manager (of the programs which are part of windows).
  114. To drag an application or file into FreeDock, move the mouse over the 
  115. file in File Manager, press & hold down the left mouse button (a small icon 
  116. will now appear at the mouse pointer) move this until it is over a free 
  117. slot in FreeDock & release the mouse button. The Application or document
  118. file's associated application should now appear in FreeDock.
  119.  
  120. Another way of looking at it is that it is the same as copying a file in
  121. File Manager except you "copy" the file to FreeDock instead of the destination
  122. directory.
  123.  
  124.  
  125. You can also add an application to the dock by right clicking an empty slot
  126. and filling in the Application Name (with or without the path) and selecting
  127. OK. FreeDock will then fillout the Runtime Dir & Icon File fields with the
  128. default values.
  129.  
  130.  
  131. Special Slots
  132. -------------
  133.  
  134. The dock also has 3 special slots which are built-in to the program :
  135.  
  136. 1) Exit Windows  - Exits windows with or without confirmation
  137. 2) Check MailBox - Checks mail box files for new messages arriving, this 
  138.                    requires the mail box file to be visible to dos as a 
  139.                    normal file ie. a unix mailbox visible via NFS or a 
  140.                    similar virtual drive mechanism.
  141.  
  142. 3) Clock         - A clock in a slot (Not Implemented yet)
  143.  
  144. These slots can be activated or deactivated in the Main Dock Options dialog, 
  145. currently any changes will not take effect until the next time FreeDock
  146. is started.
  147.  
  148.  
  149. Slot Options
  150. ------------
  151.  
  152. Every slot (except the empty ones) in the dock has an options dialog which can 
  153. be accessed by clicking the right mouse button with the cursor over the slot.
  154.  
  155. - Main Dock Options : Activate built-in slots (as above) 
  156.                       Dock Visibility, this provides 2 options
  157.                         1) Always On Top - Keeps the dock on top of all 
  158.                            windows even when it is not active.
  159.  
  160.                         2) Max View - if this is active, whenever another 
  161.                            window is Maximized it will not be allowed to 
  162.                            cover the dock window. (Not Yet Implemented)
  163.                       Dock Postion - This changes the orientation of the 
  164.                                      dock i.e. horizontal or vertical.
  165.  
  166.                       Single Click - If this option is checked, the user
  167.                                      can start applications in the dock with
  168.                                      a single click.
  169.                       Slots in Dock - The arrows control the number of slots 
  170.                               in the dock between 0 & 32. The value 
  171.                               for the maximum dock size is actually taken from
  172.                               the MaxDockSize field in the [Main Options]
  173.                               section of the .ini file, this value can be
  174.                               altered as required to provide more slots, or
  175.                               to save memory.
  176.  
  177.                       Dock Size - This option sets the size (in pixels) of
  178.                               each slot in the dock and therefore the actual
  179.                               size of the dock. This has the effect of
  180.                               scaling the entire dock up or down in size.
  181.  
  182.                       Lock Dock - This option allows the slots in the dock
  183.                               to be locked in position to stop accidental
  184.                               moving or deleting of slots.
  185.  
  186. - Exit Windows Options : Confirm Exit ?
  187.  
  188. - Mail Check Options : Mail Box File - The path to the mail box to watch.
  189.                        Frequency of checking - How often to check the mail 
  190.                        box. Sound for new mail - Make a noise when new mail 
  191.                        arrives.
  192.  
  193. - Application Options : Startup - Set the Startup state of the application, 
  194.                                   the first 3 options are self explanitory, 
  195.                                   the last is to start the application with
  196.                                   a stored position and size. This position
  197.                                   and size is set by dragging the Window
  198.                                   Grabber tool and dropping it onto the 
  199.                                   window whose size & Position you want
  200.                                   to keep. Whilst the Grabber Tool is being
  201.                                   dragged, the Application Options dialog is
  202.                                   temporarily hidden.
  203.  
  204.                         Always On Top - This option tells FreeDock to start an
  205.                                   application so that the application's window
  206.                                   is always on top. This is available in
  207.                                   combination with one of the startup states
  208.                                   described above.
  209.  
  210.                         Separate Memory - This option tells FreeDock to start
  211.                                   the application in a Separate Memory Space.
  212.                                   This option only applies under NT when 
  213.                                   starting 16 bit applications, it is ignored
  214.                                   if the application is 32 Bit.
  215.  
  216.                         Window Grabber - This is a tool which is dragged off
  217.                                          the dialog box an dropped on the 
  218.                                          window whose size/position you wish
  219.                                          to store.
  220.  
  221.                         Hide Dialog When Grabbing - This check box allows the
  222.                                          dialog box to automatically hide 
  223.                                          itself when you are using the 
  224.                                          grabber to grab a window.
  225.  
  226.                         Preview - This allows the stored window position for
  227.                                   an application to be previewed and changed.
  228.  
  229.                         Icon Selector - This displays the current Icon, and
  230.                                         the number of icons in the file, the
  231.                                         scroll bar is used to change the icon.
  232.                                         Or you can click on the icon to pop up
  233.                                         a dialog which offers a choice of all
  234.                                         the icons in a file 50 at a time.
  235.  
  236.                         FileName, Parameters & Default dir are self explanitory
  237.  
  238.                         Icon File - is the file to extract the appliaction 
  239.                                     icon from.
  240.  
  241.                         Remove - Remove this application from the dock.
  242.                                  (Same effect as dragging the slot off the dock
  243.                                   altogether and releaseing the left mouse 
  244.                                   button.)
  245.  
  246.  
  247. Mouse Actions
  248. -------------
  249.  
  250. Double clicking on an application slot launches the application.
  251. OR if the Single Click option is selected, a single click will launch it.
  252.  
  253. Double Clicking on the Exit Windows Slot will exit windows.
  254.         (With optional prompt)
  255.  
  256. Double clicking on the FreeDock Slot brings up an about dialog with options to
  257.     - Exit FreeDock
  258.  
  259. Moving the cursor over the FreeDock Slot, pressing the left mouse button and 
  260. keeping it pressed, allows the Dock to be dragged to a new position in on the
  261. desktop.
  262.  
  263. Right Clicking on an application slot dispalys a dialog which allows the applications
  264. details to be edited.
  265.  
  266. Right Clicking on an empty slot brings up an empty application details dialog & allows
  267. the user to fill in the details of the application, which is then added to the dock
  268. in the position of the empty slot.
  269.  
  270. Moving the cursor over a slot and pressing the left mouse button and keeping 
  271. it pressed, allows the slot to be dragged to a new position in the dock. The
  272. slot can also be dragged off the dock completely, in which case the cursor
  273. becomes a skull & cross bones, indicting that if the slot is dropped here 
  274. (i.e. the left mouse button is released) then the slot will be removed from 
  275. the dock.
  276.  
  277. Moving a slot to any free slot position simply moves the slot to that position.
  278. Moving a slot to any occupied position exchanges the position of the two slots
  279. in the dock.
  280.  
  281.  
  282. Command Line Options
  283. --------------------
  284.  
  285. If you have compiled the debug window code into Freedock, the debug window
  286. is activated by specifying /DEBUG on the command line. If this option is not
  287. specified then Freedock runs as normal.
  288.  
  289.  
  290. Compiling FreeDock
  291. ------------------
  292.  
  293. FreeDock has been compiled using Microsoft Visual C/C++ v1.5 & v2.0, I have 
  294. not tried to compile Freedock with Borland C but I see no reason why
  295. it would not compile with minimal (if any) changes required, since it was
  296. originally written with Borland C.
  297.  
  298.  
  299. Files Included
  300. --------------
  301.  
  302. FREEDK16 EXE    - The FreeDock Program (16 Bit)
  303. FREEDK32 EXE    - The FreeDock Program (32 Bit)
  304.  
  305. FREEDK16 INI    -
  306. FREEDK32 INI    - A default .ini files for FreeDock, if you don't use one,
  307.                   FreeDock will create one for you in your windows system dir.
  308. README   TXT    - A very brief README for FreeDock
  309. HISTORY  TXT    - A brief history of FreeDock
  310. FREEDOCK DOC    - A brief manual for FreeDock (This File)
  311.  
  312. DOCKSRC.ZIP     - An archive of the source code, containing : 
  313.  
  314.         MAIN     C      - Main Code Module
  315.         DOCKUTIL C      - Utilities Module
  316.         DOCKWIN  C      - Main Dock Window Code Module
  317.         DRAWBMP  C      - Bitmap Utilities Module
  318.         FREEDOCK H      - Header file for FreeDock
  319.         RESOURCE H      - Header file for resource definitions
  320.         FREEDOCK DEF    - Definition file for Compiling FreeDock
  321.         FREEDOCK RC     - Resource script file for FreeDock, you will need a 
  322.                           resource editor to edit this.
  323.         FREEDOCK RES    - Compiled version of the above Resource script.
  324.         
  325.         BLANK    BMP    - Blank Slot Bitmap
  326.         GRABBER  BMP    - The Grabber tool Button
  327.         GRABBER2 BMP    - The Grabber tool Button with grabber dragged off.
  328.         CLOCK    ICO    - Icon for Clock Slot (not implemented)
  329.         EXIT     ICO    - Icon for Exit Windows Slot
  330.         FREEDOCK ICO    - Title Icon for Freedock
  331.         MAIL     ICO    - Icon for Mailbox with mail
  332.         NOMAIL   ICO    - Icon for Mailbox with no mail
  333.         HAND     CUR    - Cursor for dragging a slot
  334.         GRABBER  CUR    - Cursor for grabbing a window
  335.         REMOVE   CUR    - Cursor for dragging slots off the dock to 
  336.                           delete them
  337.         FREEDK16 MAK    - Make File for Microsoft Visual C/C++ v1.5 (16 Bit)
  338.         FREEDK32 MAK    - Make File for Microsoft Visual C/C++ v2.0 (32 Bit)
  339.                         
  340.  
  341.  
  342. Thanks
  343. ======
  344.  
  345. Thanks to Martin Smith, Angus Foreman, Brian Duncan for testing FreeDock.
  346.