home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 447.lha / DoctorIcon_v1.0 / FileRequester.doc < prev   
Encoding:
Text File  |  1990-12-08  |  6.3 KB  |  116 lines
  1.  
  2.     The file requester used in Doctor Icon was created by Ray Lambert.  It
  3. is copyright 1989 by Theta Systems, Inc., Woburn, Massachusetts, and has
  4. been used by permission in Doctor Icon.  For more information about the file
  5. requester please contact the author -- information to do so is at the end of
  6. the file:  "DoctorIcon.doc"
  7.  
  8.  
  9.     The file requester allows you to select file names for loading or saving
  10. of disk files.  In most respects it is "standard" (relative to the majority
  11. of file requesters which already exist) and generally it is very intuitive.
  12. Some extra capabilities of the file requester include the ability to make
  13. selections at any time while the directory is being read rather than forcing
  14. you to wait until the whole directory is read, and the ability to halt the
  15. reading of the directory by pressing the right mouse button.  When the
  16. directory read operation is aborted, only files that have been read up to
  17. that point will be displayed.
  18.  
  19.     The top half of the file requester window contains the display area in
  20. which file names, sub-directory names and physical and logical device names
  21. are listed.  To the right of the display area is a proportional gadget which
  22. allows the user to scroll through the display when it contains more entries
  23. than can fit in the display area at once.  To select an entry in the display
  24. area simply double-click on it.  When a file name is double-clicked, that
  25. file name is selected and returned to the program.  When a sub-directory
  26. name is double-clicked, the file requester will move into that sub-directory
  27. and display the files and sub-directories which appear there.  When a
  28. logical or physical device name is doubled-clicked, the file requester moves
  29. to the root directory of that device and displays its contents.  File name
  30. entries can be identified by the fact that their file size is displayed on
  31. the right side of the display area.  Sub-directory entries are identified by
  32. the letters "<DIR>" on the right side of the display area.  Device entries
  33. are indentified by the letters "<VOL>" in the same position.  In addition,
  34. each entry type, file names, sub-directories and devices, are displayed in a
  35. different color.
  36.  
  37.     Below the display area are three string gadgets which contain, in order,
  38. a wildcard specification used to filter the files that are actually
  39. displayed (see below for a list of valid wildcard characters and
  40. expressions), the current drawer name and the current file name.  The
  41. wildcard specification can be modified at any time -- after modification if
  42. you press RETURN the current directory will get re-read and the files
  43. filtered with the new wildcard.  Likewise, the current directory string can
  44. also be modified at any time -- after modification if you press RETURN the
  45. new directory will be read in.  Also, the current file name can be modified
  46. at any time -- after modification if you press RETURN, the file name you
  47. just entered will be the selected file name and will be returned to the
  48. program just as though you had double-clicked on the name (this allows one
  49. to enter a file name which does not exist yet).  If you hold the SHIFT key
  50. while pressing RETURN when the cursor is in any of these string gadgets, the
  51. cursor will be advanced to the next logical field without any other action
  52. taking place.
  53.  
  54.     Below the three string gadgets are five buttons labeled, in order,
  55. "Parent", "Volumes", "Re-Read", "Accept" and "Cancel".  These perform the
  56. following functions:
  57.  
  58.     * "Parent":  Reads the parent directory of the current directory if
  59. there is one.  If there is no parent directory (already in the root
  60. directory) this button will be deactivated.
  61.  
  62.     * "Volumes":  Clicking on this gadget causes a list of logical and
  63. physical devices and volumes to be added onto the end of the currently
  64. displayed file list.  The display will also be repositioned to show the
  65. topmost volume in the list.  Once the volume list has been added to the
  66. display window, the "Volumes" button will become disabled (unselectable)
  67. until you either re-read the current directory or until you read a new
  68. directory, thus preventing more than one volume list from being added to the
  69. file list.
  70.  
  71.     * "Re-Read":  Forces the file requester to re-read and re-display the
  72. current directory.
  73.  
  74.     * "Accept":  Instructs the file requester that the file name which is
  75. currently displayed in the "File:" string gadget and the directory which is
  76. displayed in the "Drawer:" string gadget are acceptable and should be
  77. returned to the program.
  78.  
  79.     * "Cancel":  Instructs the file requester that you wish to cancel this
  80. file operation.
  81.  
  82.  
  83.  
  84.                            Wilcard Specifications
  85.  
  86.     The "Mask:" string gadget in the file requester allows you to enter
  87. wildcards which are used to filter the files that are displayed, thereby
  88. narrowing the contents of the file list to a specific type of file.  The
  89. following wildcards are recognized:
  90.     
  91.             ?   - matches one of any character
  92.             #x  - matches one or more occurances of "x", which can be
  93.                   any valid character
  94.             *   - matches any number of any characters
  95.             #?  - a special case of "#x" which works the same as "*"
  96.  
  97.     In addition, the file requester recognizes two additional special
  98. characters.  Both _must_ appear as the first character of an individual
  99. wildcard or they will not be recognized.
  100.     The first special character is the tilde character ("~").  This special
  101. character instructs the file requester to display all files except the ones
  102. which match the following wildcards.  For example, "*.doc" would tell the
  103. file requester to display all files ending in ".doc".  In contrast, "~*.doc"
  104. tells it to display all files which _do_not_ end in ".doc".
  105.     The second special character is the ampersand ("&").  This character is
  106. used to combine multiple cooperating wildcard specifications.  For example,
  107. if you wanted to see all ".doc" files as well as all ".txt" files you could
  108. use the following wildcard specification:  "*.doc&*.txt".  You may think of
  109. this as "all .doc files AND all .txt files".  Note that this character
  110. should only appear between valid wildcards and not before the first or after
  111. the last.
  112.     When the ampersand operator ("&") is used to combine an _inclusive_
  113. wildcard, such as "*.doc", and an _exclusive_ wildcard such as "~foo*", care
  114. must be taken to avoid specifying a wildcard which cancels-out files that
  115. you want displayed.
  116.