home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 19 / AACD19.BIN / AACD / Programming / AWNP / AWNP-Docs / getfile.doc < prev    next >
Encoding:
Text File  |  2000-05-24  |  5.4 KB  |  249 lines
  1. There are actually two file requesters available in AWNPipe. The ClassAct/Reaction getfile.gadget, and the ASL file requester. Only the getfile.gadget can be displayed in a gui. Both can be opened under your control to present the user with a file requester. The details for the ASL requester are at the end of this file.
  2.  
  3.   *** GETFILE GADGET CLASS ***
  4.  
  5. GetFile gadget event.
  6. -------------------------
  7.  
  8. 'gadget GID  success ["filename" ["filename" ...]]'
  9.  
  10.  Success=0 user selected no file or canceled.
  11.  Success!=0 user selected a file.
  12. Filenames are fully qualified with path.
  13.  
  14. GetFile gadget parameters.
  15. -------------------------
  16.  
  17. font=GID
  18.  
  19. This sets the font for the gadget. The GID points to an ALREADY defined text attribute.
  20.  
  21.  
  22. readonly (ro)
  23.  
  24.  This gadget is read only.
  25.  
  26. disable=number (dis=)
  27.  
  28.  The gadget is enabled if number = 0 , disabled if number != 0. Defaults to enabled.
  29.  
  30. gadgettext="file requester title" (gt=)
  31.  
  32.  Set the title of the file requester.
  33.  
  34. pattern="pattern" (pat=)
  35.  
  36.  Set and Enable pattern matching in the file.
  37.  
  38. multi  (m)
  39.  
  40.  Allow multi selection in the file requester. (does not seem to work)
  41.  
  42. save
  43.  
  44.  This is a save requester.
  45.  
  46. drawers (dr)
  47.  
  48.  Only show and allow selections of drawers.
  49.  
  50. icons (i)
  51.  
  52.  Do NOT show .info files.
  53.  
  54. filename="path:filename" (fn=)
  55.  
  56.  Set the filename and directory for the file requester. It must end in a '/' for drawer only file requesters
  57.  
  58. Wide=num
  59. High=num
  60.  
  61.  Set the size of the requester when opened.
  62.  
  63. unattached    (ua)
  64.  
  65.  This file requester is not attached to the CA window. It may still be activated in the modify conversation.
  66.  
  67. minwidth=number (minw=)
  68.  
  69.  Set the minimum width for this gadget
  70.  
  71. minheight=number (minh=)
  72.  
  73.  Set the minimum height for this gadget
  74.  
  75. weightedwidth=number (weiw=)
  76.  
  77.  Set the weighted width for this gadget
  78.  
  79. weightedheight=number (weih=)
  80.  
  81.  Set the weighted height for this gadget
  82.  
  83. nominalsize (noms)
  84.  
  85.  Set this gadget to its nominal size.
  86.  
  87. tags="tags|data[|tag|data...]|0
  88.  
  89.  A list of tag and value pairs in HEX. Do not forget the trailing null !
  90.  
  91. childlabel    (chl)
  92. childlabelr   (chlr)
  93.  
  94.  Use the previously defined image as a childlabel for this gadget. Display the childlabel to the right or left of the gadget.
  95.  
  96. replace=GID
  97.  
  98.  Use this gadget to replace an existing gadget specified by GID.
  99.  
  100. Definition Reply
  101. -----------------
  102.  
  103.  When the gadget creation is successful the pipe replies
  104. with
  105.  
  106. 'ok GID'
  107.  
  108. GetFile gadget modify parameters.
  109. -------------------------
  110.  
  111. selected=number (sel=)
  112.  
  113. This modify command is only valid for UNATTACHED getfile gadgets. Number is ignored but must be given. This opens the file requester and the selected files are returned rather than a simple ok.
  114. You should not use other modify instructions on the same line as 'selected'.
  115.  
  116. NOTE: You can not force an attached getfile to open.
  117.  
  118. disable=number (dis=)
  119.  
  120.  The gadget is enabled if number = 0 , disabled if number != 0.
  121.  
  122. save=number
  123.  
  124.  If number=0 this is NOT a save requester. If number~=0 this is a save requester.
  125.  
  126. filename="path:filename" (fn=)
  127.  
  128.  Set the filename and directory for the file requester.
  129.  
  130. gadgettext="title" (gt=)
  131.  
  132.  Set the file requesters title.
  133.  
  134.  
  135.   *** GETFILE ASL ***
  136.  
  137. The ASL requester does not send events.
  138.  
  139. GetFile ASL parameters.
  140. -------------------------
  141.  
  142. ASL
  143.  
  144.   This tells AWNP you want to define an ASL file requester.
  145.  
  146. font=GID
  147.  
  148. This sets the font for the gadget. The GID points to an ALREADY defined text attribute.
  149.  
  150.  
  151. gadgettext="file requester title" (gt=)
  152.  
  153.  Set the title of the file requester.
  154.  
  155. pattern="pattern" (pat=)
  156.  
  157.  Set and Enable pattern matching in the file.
  158.  
  159. multi  (m)
  160.  
  161.  Allow multi selection in the file requester. (does not seem to work)
  162.  
  163. save
  164.  
  165.  This is a save requester.
  166.  
  167. drawers (dr)
  168.  
  169.  Only show and allow selections of drawers.
  170.  
  171. icons (i)
  172.  
  173.  Do NOT show .info files.
  174.  
  175. filename="path:filename" (fn=)
  176.  
  177.  Set the filename and directory for the file requester. It must end in a '/' for drawer only file requesters
  178.  
  179. Wide=num
  180. High=num
  181.  
  182.  Set the size of the requester when opened.
  183.  
  184. top=num
  185. left=num
  186.  
  187.  Set the position of the requester when it opens.
  188.  
  189. postx="positive text"
  190.  
  191.  Set the text for the positive choice in the file requester. Defaults to OK.
  192.  
  193. negtx="negative text"
  194.  
  195.  Set the text for the positive choice in the file requester. Defaults to Cancel
  196.  
  197. Definition Reply
  198. -----------------
  199.  
  200.  When the gadget creation is successful the pipe replies
  201. with
  202.  
  203. 'ok GID'
  204.  
  205. GetFile ASL modify parameters.
  206. -------------------------
  207.  
  208.  You can only modify the ASL getfile requester when opening it. Unless the selected keyword is present the modify line is ignored.
  209.  
  210.  
  211. selected=number (sel=)
  212.  
  213. Number is ignored but must be given. This opens the file requester and you get returned the following line rather than a simple ok.
  214.  
  215. SUCCESS "path:drawer/filename" "path2:drawer2/filename2"  ...
  216.  
  217. SUCCESS=0 if the user aborted the file requester without making a selection. SUCCESS !=0 if the user selected a file, each file name is quoted and all are on a single line.
  218.  
  219. save=number
  220.  
  221.  If number=0 this is NOT a save requester. If number~=0 this is a save requester.
  222.  
  223. filename="path:filename" (fn=)
  224.  
  225.  Set the filename and directory for the file requester.
  226.  
  227. gadgettext="title" (gt=)
  228.  
  229.  Set the file requesters title.
  230.  
  231. Wide=num
  232. High=num
  233.  
  234.  Set the size of the requester when opened.
  235.  
  236. top=num
  237. left=num
  238.  
  239.  Set the position of the requester when it opens.
  240.  
  241. postx="positive text"
  242.  
  243.  Set the text for the positive choice in the file requester. Defaults to OK.
  244.  
  245. negtx="negative text"
  246.  
  247.  Set the text for the positive choice in the file requester. Defaults to Cancel
  248.  
  249.