home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d8xx / d839 / trashicon.lha / TrashIcon / TrashIcon.Doc < prev    next >
Text File  |  1993-03-13  |  6KB  |  139 lines
  1. TrashIcon V1.2   © Mark McPherson, 26-Feb-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 deletion overides any protection flags
  21.                 on the file, thus causing ALL files to be deleted.
  22.  
  23.     RECURSIVE - If set, then if a directory is dragged to the icon,
  24.                 it, and all its contents are deleted.  If not set,
  25.                 then a directory will only be deleted if it is empty.
  26.  
  27.       CONFIRM - If set, then a requestor will pop up asking the user to
  28.                 confirm the action of deleting files.  It will display
  29.                 the number of files and directories in a manner similar
  30.                 to that of the workbench menu item 'Delete...'
  31.  
  32.        FORMAT - If set, then is the path and filename of the SYSTEM
  33.                 format program.  If not supplied then looks for
  34.                 SYS:System/Format.
  35.  
  36.      XPOS=xxx - If set, then this is the x-coordinate that the appicon
  37.                 will be set at when placed on the workbench screen. If
  38.                 there is something else already there, or it is off the
  39.                 boundaries of the screen, then it will be placed by
  40.                 Workbench.
  41.  
  42.      YPOS=xxx - Same as XPOS=xxx, but for the y-coordinate.
  43.  
  44.  
  45.   If the icon is double clicked on, then an options window will appear. 
  46. This gives the user the ability to overide the default flags in the
  47. tooltypes.  It also contains an 'About' requester.  Please look at this -
  48. after all, I did take the effort to put it there!  To quit the program,
  49. just click on the 'Quit' gadget.
  50.  
  51. FEATURES
  52.  
  53. Confirm
  54. If this option is set then when the user drags one or more files/dirs to
  55. the TrashIcon, an initial confirm requestor is brought up.  This has three
  56. options - OK, CONFIRM EACH, or CANCEL.  OK will go ahead and delete 
  57. all the objects requested.  CANCEL will cancel the operation, and CONFIRM
  58. EACH will bring up a further requestor for each individual file.  This
  59. requestor has four options - YES, ALL, CANCEL, and NO.  YES will delete
  60. that file, and go on to the next.  ALL will delete the rest of the files
  61. originally specified, CANCEL will abort the operation from this point, and
  62. NO will just skip that file and go on to the next.
  63.  
  64. Format
  65. When a disk icon is dragged on to the TrashIcon, a format requestor is
  66. used.  If the user selects YES, then that disk is formatted with the same
  67. name and DosType as the disk originally was.  If the user wants more control
  68. over the format, then they should use the format option from the workbench
  69. menu!
  70.  
  71.  
  72. FILES
  73.   TrashIcon      - the program
  74.   TrashIcon.info - The program's icon file, including example tooltypes.
  75.   TrashIcon.Doc  - This documentation file
  76.   Format         - This program should be present for the format disk 
  77.                    facility to work.
  78.  
  79.  
  80. HISTORY
  81.   V0.1 - Internal release.  Inital program.  No Options window.
  82.   V0.5 - Internal release.  Added options window.
  83.   V0.6 - Public release.  Handles XPOS,YPOS positioning.
  84.   V1.0 - Internal release.  Added purge option for completely deleting a file.
  85.   V1.1 - Internal release.  Made purge option even more secure! + bug fix.
  86.   V1.2 - This release.  Added extra confirmation handling, and the format disk
  87.           option.  Removed purge option due to it being found to be unreliable.
  88.           I will add this again if I find a good way of implementing it.
  89.  
  90.  
  91. TESTING
  92.   This version has been tested under V37.175, and V39.106, on both
  93. accelerated and unaccelerated machines.  It actually worked on all of
  94. them!  It hasn't been tested with Enforcer or other such programs.  If
  95. there ARE any problems then please tell me!
  96.  
  97.  
  98. TECHNICAL NOTES - PLEASE HELP ME!
  99.   While formatting, I'd like to be able to change to a busy pointer.
  100. However, I have no idea of how to do this - I know there is a SetPointer
  101. function, but I'd like to be able to use the system default busy pointer.
  102. Again, if anybody can help then please send me some information.
  103.  
  104.  
  105. AUTHOR
  106.   I am currently a student at the University of Kent at Canterbury,
  107. where studying for a degree in Computer Science.  This is my second
  108. public release of one of my programs.  The other being MmDir which
  109. made multiple, nested, directories in one go.  At the moment, as well
  110. as continuing to try to get a good degree, I am putting all my effort
  111. into this program  - until I find something more interesting to work
  112. on anyway!
  113.  
  114. I can be contacted on the Internet at "msm@ukc.ac.uk", and JANET at
  115. "msm@uk.ac.ukc" (Note the subtle difference ;-).  If you can, please send me
  116. some E-Mail to say you use this program, along with comments on what else is
  117. necessary.  I got a fairly good response from the last release, but still keep
  118. telling me you use my program, and what you want from it.
  119.  
  120. For others without access to E-Mail, I can be reached at:
  121.     54 Wrestwood Road
  122.     Bexhill-On-Sea
  123.     East Sussex
  124.     TN40 2LL
  125.  
  126.     England
  127.  
  128. though it could take a couple of weeks to actually get to me.
  129.  
  130.  
  131. DISTRIBUTION
  132.   All code is copyright (C) 1993 Mark McPherson.  It is freely
  133. distributable and can be copied so long as no charge is made.  It
  134. may not be modified, sold or included in any commercial distribution
  135. without my written permission.  I also ask that this documentation
  136. file accompanies the main program.  The author takes no responsibility
  137. for any loss or damage that may arise from using this program.
  138.  
  139.