home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Programming / Basic / bb_ext.dms / in.adf / LibsDev.lha / userlibdocs / FuzziesReqLib.Doc < prev    next >
Encoding:
Text File  |  1994-09-05  |  10.4 KB  |  246 lines
  1. Library Name:
  2.   fuzziesreqlib #53
  3.  
  4. Author:
  5.   Peter Tavinor, 22 Tuhangi St, Kamo, Whangarei, New Zealand
  6.  
  7. OverView:
  8.   Not only has Peter Tavinor (King Fuzzy) kindly fixed up and added
  9.   stuff to our own libraries (seriallib especially) he has also sent
  10.   us this library which is one of three that take advantage of the
  11.   ReqLibrary.
  12.   Fuzzy has also cludged up Ted with hotkeys and stuff, if you
  13.   want to get hold of this version I suggest writing to him
  14.   at the above address. Anyway, sorry I couldn't fit more of
  15.   his stuff in this issue.
  16.  
  17. Commands:
  18.   ColourRequest:    Colour=ColourRequest(Colour)
  19.   TextRequest:      Button=TextRequest(Text,Title,Left Text[,[Middle Text,]Right Text])
  20.   TextTimeout:      TextTimeout Timeout Seconds
  21.   GetString$:       String$=GetString$(Title$,Default$,Visable size,Max length)
  22.   ReqFileRequest$:  selectedfile$=ReqFileRequest$(Title$,File$,Path$,Flags)
  23.   FileReqSize:      FileReqSize Lines High,File Length,Device Length
  24.   FileFilter:       FileFilter Show$,Hide$
  25.   ReqColours:       ReqColours Text,Detail,Block[,File,Dir,Device[,GadText,GadBox,StringName,StringBox,Frame]]
  26.   FileStructure:    Fs.l=FileStructure
  27.   MaxSelect$:       Path$=MaxSelect$(Title$,File$,Path$,Flags,number of files)
  28.   NextFile$:        f$=NextFile$
  29.   ReqFontSize:      sz=ReqFontSize
  30.   Req_Base:         rl.l=Req_Base
  31.   Dos_Base:         dl.l=Dos_Base
  32.   Int_Base:         il.l=Int_Base
  33.   Gfx_Base:         gl.l=Gfx_Base
  34.   Rex_Base:         rxl.l=Rex_Base
  35.   Con_Base:         cl.l=Con_Base
  36.  
  37. Authors Docs:
  38.  
  39.  Req   Library  Ver 1.1 By King Fuzzy  No. 201
  40.  
  41.  $VER: Req Library extention Docs version 1.1 by King Fuzzy
  42.  
  43. The following commands are in the Reqlib library and they require the req.library
  44. To get the Requests on a custom window use CatchDosErrs (see Reference Manual)
  45. ============================================================================
  46. Function ColourRequest
  47. ----------------------------------------------------------------------------
  48. Syntax:  Colour=ColourRequest(Colour)
  49.  
  50. This function brings up a handy little palette and allows the user to select
  51. a colour using Colour as the default
  52.  
  53. c=ColourRequest(1)
  54.  
  55. ============================================================================
  56. Function TextRequest
  57. ----------------------------------------------------------------------------
  58. Syntax:  Button=TextRequest(Text,Title,Left Text[,[Middle Text,]Right Text])
  59.  
  60. This brings up a text requester with Text as the message and Title in the titlebar
  61. It can have 1, 2 or 3 buttons to select from
  62. The requester's colours can be changed: See ReqColours
  63. Left button
  64. Left and Right buttons
  65. Left, Middle and Right buttons
  66.  
  67. The text in the buttons is determined by Left Text,Middle Text and Right Text
  68.  
  69. the value returned is
  70. 1  left button
  71. 2  middle button
  72. 0  right button
  73.  
  74. Button=TextRequest("I am a simple requester","Blitz Prog","Left","Middle","Right")
  75.  
  76. ============================================================================
  77. Statement                  TextTimeout
  78. ----------------------------------------------------------------------------
  79. Syntax:  TextTimeout Timeout Seconds
  80.  
  81. Its surpose to set the timeout for the text requester but it don't work yet
  82.  
  83. ============================================================================
  84. Function GetString$
  85. ----------------------------------------------------------------------------
  86. Syntax:  String$=GetString$(Title$,Default$,Visable size,Max length)
  87.  
  88. This brings up a string requester allowing the user to enter a string
  89. The maximum length and the visable length are set with Max length and Visable size
  90. The default string must have a maximum length of at least Max length
  91. Returns a null string if cancel is selected
  92.  
  93. MaxLen d$=40
  94. s$=GetString$("Type something",d$,30,40)
  95.  
  96.  
  97. ============================================================================
  98. Function ReqFileRequest$
  99. ----------------------------------------------------------------------------
  100. Syntax:  selectedfile$=ReqFileRequest$(Title$,File$,Path$,Flags)
  101.  
  102. Yes it's another file/font requester, No it won't bring up the blitz requester if it fails
  103. the maximum length of File$ must be 32 and Path$ must be 132
  104. The Flags are as follows (Clipped from reqbase.i)
  105.  
  106. FRQSHOWINFOB      EQU 0  =   1      ;Set this in Flags if you want .info files to show.  They default to hidden.
  107. FRQEXTSELECTB     EQU 1  =   2      ;Set this in Flags if you want extended select.  Default is not.
  108. FRQCACHINGB       EQU 2  =   4      ;Set this in Flags if you want directory caching.  Default is not.
  109. FRQGETFONTSB      EQU 3  =   8      ;Set this in Flags if you want a font requester rather than a file requester.
  110. FRQINFOGADGETB    EQU 4  =  16      ;Set this in Flags if you want a hide-info files gadget.
  111. FRQHIDEWILDSB     EQU 5  =  32      ;Set this in Flags if you DON'T want 'show' and 'hide' string gadgets.
  112. FRQABSOLUTEXYB    EQU 6  =  64      ;Use absolute x,y positions rather than centering on mouse.
  113. FRQCACHEPURGEB    EQU 7  = 128      ;Purge the cache whenever the directory date stamp changes if this is set.
  114. FRQNOHALFCACHEB   EQU 8  = 256      ;Don't cache a directory unless it is completely read in when this is set.
  115. FRQNOSORTB        EQU 9  = 512      ;Set this in Flags if you DON'T want sorted directories.
  116. FRQNODRAGB        EQU 10 =1024      ;Set this in Flags if you DON'T want a drag bar and depth gadgets.
  117. FRQSAVINGB        EQU 11 =2048      ;Set this bit if you are selecting a file to save to.
  118. FRQLOADINGB       EQU 12 =4096      ;Set this bit if you are selecting a file(s) to load from.
  119.                                     ;These two bits (save and load) aren't currently used for
  120.                                     ;anything, but they may be in the future, so you should
  121.                                     ;remember to set them.  Also, these bits make it easier if
  122.                                     ;somebody wants to customize the file requester for their
  123.                                     ;machine.  They can make it behave differently for loading
  124.                                     ;vs saving.
  125. FRQDIRONLYB       EQU 13 =8192      ;Allow the user to select a directory, rather than a file.
  126.  
  127. Just add together what you want and use it. EG. 6 is Caching and extended select
  128.  
  129. Also see  FileReqSize,FileFilter,ReqColours,FileStructure,MaxSelect and NextFile
  130.  
  131. MaxLen fl$=32:MaxLen dr$=132
  132. f$=ReqFileRequest$("Select a file",fl$,dr$,4)
  133.  
  134. FRQEXTSELECTB is not used
  135. Returns a null string if user aborts
  136.  
  137. ============================================================================
  138. Statement         FileReqSize
  139. ----------------------------------------------------------------------------
  140. Syntax:  FileReqSize Lines High,File Length,Device Length
  141.  
  142. This sets the size of the Req File Requester
  143. The defaults are 8,16,10
  144.  
  145. FileReqSize 20,25,12
  146.  
  147. ============================================================================
  148. Statement         FileFilter
  149. ----------------------------------------------------------------------------
  150. Syntax:  FileFilter Show$,Hide$
  151.  
  152. This sets the Hide and Show filters in the req file requester
  153.  
  154. FileFilter "Req.*","*.Bak"
  155.  
  156. This will show all files starting with 'Req.' but not ones ending with '.Bak'
  157.  
  158. ============================================================================
  159. Statement                  ReqColours
  160. ----------------------------------------------------------------------------
  161. Syntax:  ReqColours Text,Detail,Block[,File,Dir,Device[,GadText,GadBox,StringName,StringBox,Frame]]
  162.  
  163. Text,Detail and Block are for both the req file requester and the text requester
  164. File,Dir,Device,GadText,GadBox,StringName,StringBox and Frame are only for the req file requester
  165.  
  166. Try changing the colours one at a time to see what they change
  167.  
  168. ReqColours 1,2,3
  169. ReqColours 1,2,3,3,2,1
  170. ReqColours 1,2,3,3,2,1,1,2,3,4,5
  171.  
  172. ============================================================================
  173. Function          FileStructure
  174. ----------------------------------------------------------------------------
  175. Syntax:  Fs.l=FileStructure
  176.  
  177. Returns a pointer to the req file requester structure
  178.  
  179. ============================================================================
  180. Statement                  MaxSelect$
  181. ----------------------------------------------------------------------------
  182. Syntax:  Path$=MaxSelect$(Title$,File$,Path$,Flags,number of files)
  183.                            
  184. Select the number of files that can be selected with the extended selector
  185. see ReqFile Requestor for more information
  186.  
  187. ============================================================================
  188. Function          NextFile$
  189. ----------------------------------------------------------------------------
  190. Syntax:  f$=NextFile$
  191.          
  192. Returns the next file in the extended file structure
  193.  
  194. ============================================================================
  195. Function          ReqFontSize
  196. ----------------------------------------------------------------------------
  197. Syntax: sz=ReqFontSize
  198.  
  199.  This Returns the size of the last font selected with the font requester
  200.  
  201. ============================================================================
  202. Function          Req_Base
  203. ----------------------------------------------------------------------------
  204. Syntax: rl.l=Req_Base
  205.  
  206.  This Returns pointer to Req.Library used in jsr calls
  207.  
  208. ============================================================================
  209. Function          Dos_Base
  210. ----------------------------------------------------------------------------
  211. Syntax: dl.l=Dos_Base
  212.  
  213.  This Returns pointer to Dos.Library used in jsr calls
  214.  
  215. ============================================================================
  216. Function          Int_Base
  217. ----------------------------------------------------------------------------
  218. Syntax: il.l=Int_Base
  219.  
  220.  This Returns pointer to Intuition.Library used in jsr calls
  221.  
  222. ============================================================================
  223. Function          Gfx_Base
  224. ----------------------------------------------------------------------------
  225. Syntax: gl.l=Gfx_Base
  226.  
  227.  This Returns pointer to Graphics.Library used in jsr calls
  228.  
  229. ============================================================================
  230. Function          Rex_Base
  231. ----------------------------------------------------------------------------
  232. Syntax: rxl.l=Rex_Base
  233.  
  234.  This Returns pointer to RexxSys.Library I think, It says RexxSysBase in the req library docs
  235.  
  236. ============================================================================
  237. Function          Con_Base
  238. ----------------------------------------------------------------------------
  239. Syntax: cl.l=Con_Base
  240.  
  241.  This Returns pointer to Console.device 
  242.  
  243. used for jsr calls mainly rawkey to cookedkey 
  244.  
  245.  
  246.