home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Programming / Basic / wst!blz1.dms / in.adf / docs / NeilsProgressLib.doc < prev    next >
Encoding:
Text File  |  1994-09-05  |  3.4 KB  |  145 lines
  1. Library:
  2.   neilsindicatorlib #55
  3.  
  4. Author:
  5.   Neil O'Rourke, 6 Victoria St, TAMWORTH, NSW 2340, AUSTRALIA
  6.  
  7. Overview:
  8.   A progress indicator library, very snazzy, need gadtools and req?
  9.  
  10. Commands:
  11.   ret.l=PICreateRequest(Title$,Min.l,Max.l [,NoGadgets])
  12.  
  13. Author's Documentation:
  14.  
  15. ProgressIndicatorLib Documentation
  16.  
  17. Neil O'Rourke
  18.  
  19. Version 1.2 (17/7/94)
  20.  
  21.  
  22. Introduction
  23. ~~~~~~~~~~~~
  24.  
  25. There have been several Progress Indicators around for a while.  Just about
  26. all of them have problems of one form or another.  Some need 8 colour Work-
  27. bench screens, none properly scale the incoming values.
  28.  
  29. A progress indicator should be adaptable to the programmers need, to
  30. inform the user what is happening.  If creating a progress indicator is too
  31. hard, then the programmer will give up, and the user will suffer.
  32.  
  33. Here is my solution to this.
  34.  
  35. This library consists on only three commands, and requires ReqTools to run.
  36. The Progress Indicator is not part of ReqTools, but modeled closely on the
  37. one in PowerPacker and the Amiga Style Guide.  The Indicator is usable in 
  38. screens of 1 bitplane and up, and happily scales the data into a percentage 
  39. bar.
  40.  
  41. For instance, suppose you are scanning through a block of memory on a byte
  42. by byte basis, with start address Start and end address Start+4069.
  43.  
  44. To set up the requester, you'd type
  45.  
  46.   PICreateRequest("Please Wait...",Start,Start+4096)
  47.  
  48. and the requester takes care of every thing else.  To update the requester,
  49. you'd type
  50.  
  51.   PIUpdateRequest(Start+Offset)
  52.  
  53. and the requester scales the addresses into a displayable form.
  54.  
  55.  
  56. Commands
  57. ~~~~~~~~
  58.  
  59. ret.l=PICreateRequest(Title$,Min.l,Max.l [,NoGadgets])
  60. ------------------------------------------------------
  61.  
  62. Creates a Progress Indicator requester, locks the calling window and
  63. returns either True or False.  Always check this!  The requester can fail
  64. if there isn't enough memory, or Min>Max.
  65.  
  66. Min and Max refer to what the bar actually displays.  These are unsigned
  67. values, so no negative numbers are allowed.
  68.  
  69. If the requester has returned True, then the window that called it is now
  70. locked and will not accept any input from the user.  The only thing the
  71. user can do now is hit the Cancel gadget.
  72.  
  73. If you include the NoGadgets field with any number at all, then the request
  74. will open up WITHOUT a Stop gadget.  Use of this feature is stronHÁ j
  75. 0(
  76. HÀ.€//
  77. /A
  78. <NºXOïfor advanced programmersgadget
  79. $
  80. /C
  81. <& j
  82. p
  83. "
  84. "k
  85. 2,l[d(/
  86. 0*/
  87. <|`܆N®ý¢Lߕ‡ D
  88. )@gf/
  89. Nºª.‹NºjÞHx
  90. a
  91. ø"POp
  92. @d¹@d¸Nº,d¸S
  93. @d¸NºMhNº Nº_>NºxNºKBNºYxNºZNºjðHl_Þ/,^:Nºn9@_Ìa
  94.  
  95. ¨NºÔPO  gFAíÿÎ",lmN®ÿ@ -ÿÞ°­ÿÒg­
  96. ¸ÿÖ -ÿ֐­ÿâ.
  97. pd¾€l‡"
  98. N®ÿ:/
  99. Nº.‹Nºj:XONºfB§/,^>Nºm NºM¨HlB¦/,gBNºpHlB·/,gFNºdNºytOeP
  100. Hx
  101. a
  102. ÷DXOp
  103. /
  104. /
  105. NºÄLíLüÿN]NuHç
  106. ~ÿ0,dPHÀB§Hl[”/
  107. HldNºbOïs was caus
  108.  
  109. f>|
  110. `2 HÀB§Hl[”/
  111. HldNº8O°JWaitT
  112.  
  113. g
  114. 9FdP,[”`RFp¼@mÈ`,[”AìdCìd0°fJ
  115. föf 0,dR2,dP²@g00,dRHÀB§Hl[”/
  116. Hld0NºØOïvent
  117. ), or t•‰8•ˆCmodule co
  118. NºXOLß VBLANK interrupt, however•Š°•‹
  119. wind•‰H•ˆè
  120. alid 
  121. `·ì^>f&S  fô  f,0,^8r$°Am./,^:NºÄXOJ@g  l^:p,l[`N®ýØ
  122.  
  123.  
  124. f r
  125. ,lmN®ÿ:`¤LßH
  126. NuHç  ,gg/
  127. Nº?”XO ,gBg/
  128. Nº?†XO ,gFg/
  129. Nº?xXO ,gªg/
  130. Nº?jXO ,g°g/
  131. Nº?\XOJ¬g´g
  132. /,g´Nº:XOJ¬gg"lg,lZN®þ>/,gNº6XO ,g
  133. g/
  134. NºjÞXONºÀNºôNº NºhâNºWf ,^>g( ld°!lZì start sometim
  135. þÆ/,^B/,^>Nº˜POJ¬[„g
  136. /,[„Nº¾XOJ¬[ˆg
  137. /,[ˆNº®XOJ¬[Œg
  138. /,[ŒNºžXO ,^lg/
  139. Nº*XO ,^:g/
  140. Nº(XOJ¬[|g CìZ¸,lZN®þ> ,[tg
  141. "@tributal.
  142.  
  143. ProgressIndicatorLib is written in 100% machine code, and requires WB2.0>
  144. to run.
  145.