home *** CD-ROM | disk | FTP | other *** search
/ The CDPD Public Domain Collection for CDTV 3 / CDPDIII.bin / fish / 871-880 / ff871 / trashicon / trashicon.doc < prev    next >
Text File  |  1993-05-12  |  7KB  |  150 lines
  1. TrashIcon V1.4   © Mark McPherson, 13-May-93
  2. --------------------------------------------
  3.  
  4.   TrashIcon - A Workbench 2.04+ application icon to delete files.
  5.  
  6. DESCRIPTION
  7.   The workbench has a standard trashcan, but unfortunately, each disk
  8. must have its own, and it cannot be 'Left Out'.  TrashIcon basically
  9. puts an icon at a (possibly user-defined) position on the workbench
  10. screen, and deletes all files that are dragged onto it.
  11.  
  12. OPTIONS
  13.   The icon used for the appicon is just the program's icon, which can
  14. of course be changed, if the user wants (which is quite likely - I'm 
  15. a Software Engineer, not an artist!)
  16.  
  17.   The default options are taken from the icon's tooltypes.  These are as
  18. follows:
  19.  
  20.         FORCE - If set then this sets the behaviour when a file is protected
  21.                 from deletion.  If set to NO, then if a file is protected,
  22.                 it is not deleted.  If set to YES then the protect file is
  23.                 deleted.  If set to ASK then a requester is brought up asking
  24.                 the user to choose whether they want to override the protection
  25.                 on that file.
  26.  
  27.     RECURSIVE - If set, then if a directory is dragged to the icon,
  28.                 it, and all its contents are deleted.  If not set,
  29.                 then a directory will only be deleted if it is empty.
  30.  
  31.       CONFIRM - If set, then a requestor will pop up asking the user to
  32.                 confirm the action of deleting files.  It will display
  33.                 the number of files and directories in a manner similar
  34.                 to that of the workbench menu item 'Delete...'
  35.  
  36.        FORMAT - If set, then is the path and filename of the SYSTEM
  37.                 format program.  If not supplied then looks for
  38.                 SYS:System/Format.
  39.  
  40.      XPOS=xxx - If set, then this is the x-coordinate that the appicon
  41.                 will be set at when placed on the workbench screen. If
  42.                 there is something else already there, or it is off the
  43.                 boundaries of the screen, then it will be placed by
  44.                 Workbench.
  45.  
  46.      YPOS=xxx - Same as XPOS=xxx, but for the y-coordinate.
  47.  
  48.  
  49.   If the icon is double clicked on, then an options window will appear. 
  50. This gives the user the ability to overide the default flags in the
  51. tooltypes.  It also contains an 'About' requester.  Please look at this -
  52. after all, I did take the effort to put it there!  To quit the program,
  53. just click on the 'Quit' gadget.
  54.  
  55. FEATURES
  56.  
  57. Confirm
  58. If this option is set then when the user drags one or more files/dirs to
  59. the TrashIcon, an initial confirm requestor is brought up.  This has three
  60. options - OK, CONFIRM EACH, or CANCEL.  OK will go ahead and delete 
  61. all the objects requested.  CANCEL will cancel the operation, and CONFIRM
  62. EACH will bring up a further requestor for each individual file.  This
  63. requestor has four options - YES, ALL, CANCEL, and NO.  YES will delete
  64. that file, and go on to the next.  ALL will delete the rest of the files
  65. originally specified, CANCEL will abort the operation from this point, and
  66. NO will just skip that file and go on to the next.
  67.  
  68. Format
  69. When a disk icon is dragged on to the TrashIcon, a format requestor is
  70. used.  If the user selects YES, then that disk is formatted with the same
  71. name and DosType as the disk originally was.  If the user wants more control
  72. over the format, then they should use the format option from the workbench
  73. menu!
  74.  
  75.  
  76. FILES
  77.   TrashIcon      - the program
  78.   TrashIcon.info - The program's icon file, including example tooltypes.
  79.   TrashIcon.Doc  - This documentation file
  80.   Format         - This program should be present for the format disk 
  81.                    facility to work.
  82.  
  83.  
  84. HISTORY
  85.   V0.1 - Internal release.  Inital program.  No Options window.
  86.   V0.5 - Internal release.  Added options window.
  87.   V0.6 - Public release.  Handles XPOS,YPOS positioning.
  88.   V1.0 - Internal release.  Added purge option for completely deleting a file.
  89.   V1.1 - Internal release.  Made purge option even more secure! + bug fix.
  90.   V1.2 - Public release.  Added extra confirmation handling, and the format disk
  91.           option.  Removed purge option due to it being found to be unreliable.
  92.           I will add this again if I find a good way of implementing it.
  93.   V1.3 - Semi-public release.  Changed code significantly, fixed bugs.
  94.   V1.4 - Public release.  Removed ALL enforcer hits and fixed a bug introduced
  95.           with V1.3.
  96.  
  97.  
  98. TESTING
  99.   This version has been tested under V37.175, V39.106  and V40.003, on both
  100. accelerated and unaccelerated machines.  It worked as expected on all of 
  101. these, though I have yet to test it on an '040 machine (anybody want to 'lend' 
  102. me one? ;-).  For some reason, when deleting files from the RAM disk on an
  103. A3000, the window is not always updated.  I have no idea as to why, and it
  104. only seems to happen on A3000's.  It works fine on my A2000 with or without
  105. acceleration, and on the A4000/030.
  106. Several people mentioned that the program had enforcer hits.  These have now
  107. GONE... I hope nobody finds anymore!
  108.  
  109.  
  110. THANKS
  111.   Thanks go to Matt Jennings for testing, ideas, and allowing me to use his
  112. A3000.  Thanks also to all those who Emailed me with ideas as to how to
  113. improve the program, and to tell me they like it!
  114.  
  115.  
  116. AUTHOR
  117.   I am currently a student at the University of Kent at Canterbury,
  118. where I am studying for a degree in Computer Science.  This is my second
  119. public release of one of my programs.  The other being MmDir which
  120. made multiple, nested, directories in one go.  I have no current
  121. projects planned or on the go as I have to study for my degree - BUT, look out
  122. for something big after the Summer!!!
  123.  
  124. I can be contacted on the Internet and JANET at "msm@ukc.ac.uk".  If you can,
  125. please send me some E-Mail to say you use this program, along with comments
  126. on what else is necessary.  I got a fairly good response from previous
  127. releases, but still keep telling me you use my program, and what you want
  128. from it.
  129.  
  130. For others without access to E-Mail, I can be reached at:
  131.     54 Wrestwood Road
  132.     Bexhill-On-Sea
  133.     East Sussex
  134.     TN40 2LL
  135.  
  136.     England
  137.  
  138. It MAY take a couple of weeks for letters to reach me as I am currently at
  139. University, not at home!
  140.  
  141.  
  142. DISTRIBUTION
  143.   All code is copyright (C) 1993 Mark McPherson.  It is freely
  144. distributable and can be copied so long as no charge is made.  It
  145. may not be modified, sold or included in any commercial distribution
  146. without my written permission.  I also ask that this documentation
  147. file accompanies the main program.  The author takes no responsibility
  148. for any loss or damage that may arise from using this program.
  149.  
  150.