home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Programming / Basic / wst!blz1.dms / in.adf / docs / rilibdocs.lha / RIAppLib.doc < prev    next >
Encoding:
Text File  |  1994-09-05  |  5.8 KB  |  215 lines
  1. Library Name:
  2.   riapplib #57
  3.  
  4. Authors:
  5.   ReflectiveImages, 17 Mayles Road, Southsea, Portsmouth, Hampshire, UK PO4 8NP
  6.  
  7. OverView:
  8.   Another Reflective Images Library, renamed by me...
  9.  
  10. Authors Docs:
  11.  
  12. ;------------------------------
  13. ;- WB library version 0.9     -
  14. ;- ©1994 Reflective Images    -
  15. ;------------------------------
  16.  
  17. This small library provides quick and easy to use commands for accessing
  18. AppWindows, AppIcons and AppMenus.
  19.  
  20. * PLEASE NOTE * 
  21. This library must have at least V37+ of Workbench/DOS/Icon libraries
  22.  
  23. This version of the library only enables you to read the FIRST file
  24. dragged to an AppWindow/AppIcon or selected from an AppMenu - future
  25. versions will have additional commands AppWindowArg/AppIconArg/AppMenuArg
  26. which returns the filename of the specified arg. E.g. f$=AppIconArg(1)
  27.  
  28. Command List:
  29.  
  30.   AppEvent()
  31.   AppWindowEvent()
  32.   AppIconEvent()
  33.   AppMenuEvent()
  34.   AddAppWindow()
  35.   AddAppIcon()
  36.   AddAppMenu()
  37.   DelAppWindow()
  38.   DelAppIcon()
  39.   DelAppMenu()
  40.   AppWindowFile()
  41.   AppIconFile()
  42.   AppIconHit()
  43.   AppMenuFile()
  44.   AppMenuHit()
  45.  
  46.  
  47. Function : AppEvent
  48. ------------------------------------------------------------------------------
  49. Modes  : Amiga
  50. Syntax : status=AppEvent
  51.  
  52. This command checks the msg ports of any open AppIcons/AppWindows/AppMenus
  53. and if an event has been passed, returns -1. 0 indicates no event has
  54. occurred.
  55.  
  56. e.g.
  57.   Repeat
  58.     VWait
  59.   Until AppEvent
  60.  
  61.  
  62. Function : AppWindowEvent
  63. ------------------------------------------------------------------------------
  64. Modes  : Amiga
  65. Syntax : status=AppWindowEvent
  66.  
  67. This command checks the msg ports of any open AppWindows and if an event
  68. has been passed, returns -1. 0 indicates no event has occurred.
  69.  
  70. e.g.
  71.   Repeat
  72.     VWait
  73.   Until AppWindowEvent
  74.  
  75.  
  76. Function : AppIconEvent
  77. ------------------------------------------------------------------------------
  78. Modes  : Amiga
  79. Syntax : status=AppIconEvent
  80.  
  81. This command checks the msg ports of any AppIcons and if an event has been
  82. passed, returns -1. 0 indicates no event has occurred.
  83.  
  84. e.g.
  85.   Repeat
  86.     VWait
  87.   Until AppIconEvent
  88.  
  89.  
  90. Function : AppMenuEvent
  91. ------------------------------------------------------------------------------
  92. Modes  : Amiga
  93. Syntax : status=AppMenuEvent
  94.  
  95. This command checks the msg ports of any AppMenus and if an event has been
  96. passed, returns -1. 0 indicates no event has occurred.
  97.  
  98. e.g.
  99.   Repeat
  100.     VWait
  101.   Until AppMenuEvent
  102.  
  103.  
  104. Function : AddAppWindow
  105. -------------------------------------------------------------------------------
  106. Modes  : Amiga
  107. Syntax : success=AddAppWindow(windownumber)
  108.  
  109. This command attempts to make the window specified by 'windownumber' to become
  110. an AppWindow. -1 means success, 0 means failure. There is a currently
  111. limit of 4 AppWindows.
  112.  
  113.  
  114. Function : AddAppIcon
  115. -------------------------------------------------------------------------------
  116. Modes  : Amiga
  117. Syntax : success=AddAppIcon(id,text$,iconname$)
  118.  
  119. This command attempts to place an AppIcon onto the Workbench desktop.
  120. ID is a unique identification number. Text$ is text to display underneath
  121. the AppIcon and Iconname$ is the name of the file to use the Icon imagery.
  122. -1 means success, 0 means failure.
  123. e.g.
  124.   suc=AddAppIcon(0,"Test","Work:Test")
  125.   If suc=0 Then End
  126.   
  127.  
  128. Function : AddAppMenu
  129. -------------------------------------------------------------------------------
  130. Modes  : Amiga
  131. Syntax : success=AddAppMenu(id,text$)
  132.  
  133. This command tries to add 'text$' to the Tools menu of Workbench.
  134. ID is a unique identification number. Returns -1 for success, 0 for failure.
  135. e.g.
  136.   suc=AddAppMenu(0,"Blitz2")
  137.   If suc=0 Then End
  138.  
  139.  
  140. Function : AppWindowFile
  141. -------------------------------------------------------------------------------
  142. Modes  : Amiga
  143. Syntax : filename$=AppWindowFile(windownumber)
  144.  
  145. This command returns the complete path of the file which was dragged to the
  146. AppWindow. If the file was in fact a directory a '/' is appended.
  147. An empty string signifies nothing was Dragged.
  148.  
  149.  
  150. Function : AppIconFile
  151. ------------------------------------------------------------------------------
  152. Modes  : Amiga
  153. Syntax : filename$=AppIconFile(id)
  154.  
  155. This command returns the complete path of the file which was dragged to the
  156. AppIcon. If the file was in fact a directory a '/' is appended.
  157. An empty string signifies nothing was Dragged.
  158.  
  159.  
  160. Function : AppMenuFile
  161. ------------------------------------------------------------------------------
  162. Modes  : Amiga
  163. Syntax : filename$=AppMenuFile(id)
  164.  
  165. This command returns the complete path of the file which was selected when
  166. the AppMenu was hit. If the file was in fact a directory a '/' is appended.
  167. An empty string signifies nothing was selected.
  168.  
  169.  
  170. Function : AppIconHit
  171. ------------------------------------------------------------------------------
  172. Modes  : Amiga
  173. Syntax : status=AppIconHit(id)
  174.    idnumber=AppIconHit
  175.  
  176. This command returns the status of the AppIcon <id>. -1 = The icon was
  177. doubleclicked, 0 = nothing has happened.
  178. If no argument is supplied, the function returns the number of the
  179. doubleclicked icon, or -1 for none.
  180.  
  181.  
  182. Function : AppMenuHit
  183. ------------------------------------------------------------------------------
  184. Modes  : Amiga
  185. Syntax : status=AppMenuHit(id)
  186.    idnumber=AppMenuHit
  187.  
  188. This returns the status of the AppMenu item <id>. -1 = This menu
  189. item was selected, 0 = This menu item was not selected.
  190. If no argument is given, the function returns the numbe of the
  191. selected menu item, or -1 for none.
  192.  
  193.  
  194. Function : DelAppWindow/DelAppIcon/DelAppMenu
  195. ------------------------------------------------------------------------------
  196. Modes  : Amiga
  197. Syntax : success=DelAppWindow[(number)]
  198.    success=DelAppIcon[(id)]
  199.    success=DelAppMenu[(id)]
  200.  
  201. These commands will remove the AppWindow/AppIcon/AppMenu from the system
  202. and free up the associated message ports.
  203.  
  204. *** IMPORTANT *** You must call DelAppWindow BEFORE closing a window,
  205. or your machine will GURU!
  206.  
  207.  
  208.  
  209.  
  210. -----------------======= T H E   E N D ======------------------------
  211. Enjoy!
  212.  
  213. Steve.
  214.  
  215.