home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Programming / Basic / bb_ext.dms / in.adf / LibsDev.lha / userlibdocs / AaronsIconLib.doc < prev    next >
Encoding:
Text File  |  1994-09-05  |  2.9 KB  |  108 lines
  1. Library Name:
  2.   aaronsiconlib #62
  3.  
  4. Author:
  5.   Aaron Koolen, Vision Software, 15 Day Street, Newton, Auckland, NZ
  6.  
  7. OverView:
  8.   Not only has Aaron kindly fixed up passing of argumens in our
  9.   cliargslib but has also donated this library which similar to
  10.   the Reflective Images version allows access to information
  11.   from the programs workbench icon.
  12.  
  13. Commands:
  14.   GetIconInfo:  boolean.w=GetIconInfo(icon#,iconname$)
  15.   IconTool$:    tool$=IconTool$(icon#,toolname$)
  16.   IconSubTool$: boolean.w=IconSubTool$(toolname$,subtool$)
  17.   IconType:     type.w=IconType(icon#)
  18.   IconStack:    stackSize.l=IconStack(icon#)
  19.   IconDefTool$: deftool$.w=IconDefTool$(icon#)
  20.  
  21. Authors Documentation:
  22.  
  23. AaronsIconLib
  24. =============
  25.  
  26. This library is for processing the icon (.info) files.  It only provides
  27. routines for reading the data from icons, not for writing or creating new
  28. icons, which may be added later.  It is most useful when used in conjunction
  29. with the ArgsLib.  You can set the maximum number of allowed icon info's
  30. in the options.  Also to free an IconInfo object, after a GetIconInfo use
  31. Free IconInfo #
  32.  
  33.  
  34. Function: GetIconInfo
  35. ---------------------
  36. Syntax: boolean.w=GetIconInfo(icon#,iconname$)
  37.  
  38. This examines a .info file so you can get information about it.
  39. 'iconname$' is the name of the icon without the .info suffix and icon# is
  40. the number of the IconInfo object you want to put the data under.  It will
  41. return FALSE (0) if it failed, or TRUE (-1) if it succeeded.
  42.  
  43. Function: IconTool$
  44. -------------------
  45. Syntax: tool$=IconTool$(icon#,toolname$)
  46.  
  47. Returns the respective data of the tooltype specified by 'toolname$' of
  48. IconInfo object icon#.
  49.  
  50. EG
  51.  
  52.   If IconTool$(0,"CX_POPUP")="YES" Then Gosub PopUpWindow
  53.  
  54.  
  55. Function: IconSubTool$
  56. ----------------------
  57. Syntax: boolean.w=IconSubTool$(toolname$,subtool$)
  58.  
  59. Returns TRUE (-1) or FALSE (0) if the sub tool type 'subtool$' exists
  60. within the tool 'toolname$'
  61.  
  62. EG
  63.  
  64.   If IconSubTool$(0,IconTool$(0,"FILETYPE"),"ILBM") Then file type of
  65.     file was ILBM.
  66.  
  67. A Subtool (My word) is one that resides in a tool type but is separated by
  68. bars (|).  EG
  69.  
  70. FILETYPE=PaintProgram|ILBM    (PaintProgram and ILBM are "Sub Tools")
  71.  
  72. IconTool$ will return the PaintProgram|ILBM part and you can then use
  73. IconSubtool$ to see if things like ILBM or PaintProgram exist in that
  74. string.
  75.  
  76. NOTE:  This does not require the passing if an IconInfo object, it simply
  77. requires 2 strings, so you can use it for other things too.
  78.  
  79.  
  80. Function: IconType
  81. ------------------
  82. Syntax: type.w=IconType(icon#)
  83.  
  84. Returns the type of IconInfo object icon#.
  85.  
  86. EG  NPrint IconType(0)
  87.  
  88. 'type' is one of the list from workbench/workbench.bb2.
  89.  
  90.  
  91. Function: IconStack
  92. -------------------
  93. Syntax: stackSize.l=IconStack(icon#)
  94.  
  95. Returns the stack sie setting of the icon.
  96.  
  97.  
  98. Function: IconDefTool$
  99. ----------------------
  100. Syntax: deftool$.w=IconDefTool$(icon#)
  101.  
  102. Returns the default tool of the icon.
  103.  
  104. EG  NPrint IconDefTool$(icon#)
  105.  
  106. May print something like "blitz2:blitz2" if icon# references a Blitz2 source
  107. program.
  108.