home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / games / chicken / !Chicken / Documents / AWLibSWIs next >
Text File  |  1994-04-15  |  4KB  |  113 lines
  1. SWI documentation for AW-WimpLib module
  2.  
  3. Prefix: AWLib_
  4. Chunk : &48340
  5.  
  6.  
  7. This file, and the module itself, is Public Domain. Write to the following
  8. address to obtain the source code or submit improvements/ideas:
  9.  Andrew Wood
  10.  7 Astley Grove
  11.  Seaton Sluice
  12.  Whitley Bay
  13.  Tyne + Wear
  14.  NE26 4JL
  15.  England
  16. Note that you need no permission to use the module, even in commercial
  17. products, so long as it has not been altered.
  18.  
  19.  
  20. AWLib_IconText: Read/write icon text
  21.  R0: Window handle
  22.  R1: Icon handle
  23.  R2: Pointer to data buffer
  24.  R3: 0 to read, 1 to write
  25.  
  26. AWLib_IconValid: Read/write icon validation string - registers as above
  27.  
  28. AWLib_ScrollReq: Handle a Wimp_Poll Scroll_Request
  29.  R1: Pointer to Wimp_Poll block
  30.  R2: X step (OS units per arrow click)
  31.  R3: Y step
  32.  
  33. AWLib_MenuHeader: Create a menu header
  34.  R0: Pointer to menu title (up to 12 characters)
  35.  R1: Width of menu (OS units)
  36.  R2: Pointer to buffer to hold menu (returned as next free space in buffer)
  37.  
  38. AWLib_MenuItem: Add a menu item to a menu (OBSOLETE - use AddMenuItem)
  39.  R0: Pointer to menu item leafname (up to 12 characters)
  40.  R1: Tick flag (1=ticked, 0=not ticked)
  41.  R2: Shade flag (1=greyed out, 0=normal)
  42.  R3: Writeable flag
  43.  R4: Last item (1=this is the last item in the menu)
  44.  R5: Warn flag (1=give Message_MenuWarning when pointer is on submenu arrow)
  45.  R6: Submenu pointer (-1=no submenu)
  46.  R7: Address to store menu item at (returned as next free space)
  47.  
  48. AWLib_IconState: Read/write icon state
  49.  R0: Window handle
  50.  R1: Icon handle
  51.  R2: State (1=selected, 0=not selected)
  52.  R3: 0 to read, 1 to write
  53.  
  54. AWLib_IconBType: Read/write icon button type - registers as above, R2=type
  55.  
  56. AWLib_IconShade: Read/write icon shade flag -registers as above; R2=1:Shaded
  57.  
  58. AWLib_IconRedraw: Forced icon redraw
  59.  R0: Window handle
  60.  R1: Icon handle
  61.  
  62. AWLib_CheckOpen: Check if a window is open
  63.  R0: Window handle
  64.  R1: Returned as 1 if open, 0 if not
  65.  
  66. AWLib_CentreOpen: Open a window in the centre of the screen
  67.  R0: Window handle
  68.  R1: 0 to use Wimp_OpenWindow, 1 to use Wimp_CreateMenu
  69.  
  70. AWLib_DialogueBox: Open a dialogue box at the pointer
  71.  R0: Window handle/menu pointer
  72.  
  73. AWLib_GetCoords: Convert screen co-ordinates to window relative co-ordinates
  74.  R0: Window handle
  75.  R1: Screen X (OS units) - returned as OS units from work area's X origin
  76.  R2: Screen Y (OS units) - returned as OS units from work area's Y origin
  77.  
  78. AWLib_Leafname: Return a file's leafname, given the full pathname
  79.  R0: Address of name - returned as address of leafname in original string
  80.  
  81. AWLib_Pathname: Return a file's pathname minus the leafname and the last "."
  82.  R0: Address of name; R0 preserved, and &0D put at the last "." in the name
  83.  
  84. AWLib_SimClick: Simulate a WIMP mouse click
  85.  R0: Window handle
  86.  R1: Icon handle
  87.  R2: Button state
  88.  
  89. AWLib_IconAdd: Add a value to an icon's numerical string contents (eg "1")
  90.  R0: Window handle
  91.  R1: Icon handle
  92.  R2: Amount to add (can be positive or negative)
  93.  R3: Minimum value that icon can hold
  94.  R4: Maximum value that icon can hold
  95.     -NB This command is used in icons with buffer arrows, for ease of use.
  96.  
  97. AWLib_AddMenuItem: Add menu item to a menu (use instead of AWLib_MenuItem)
  98.  R0: Address to store menu item at (returned as next free space, ie +24)
  99.  R1: Pointer to buffer for indirected text (returned as next free byte)
  100.  R2: Submenu pointer, or -1 for none
  101.  R3: Pointer to menu item leafname
  102.  R4: Flags:
  103.       bit 0: Tick flag
  104.       bit 1: Dotted line flag
  105.       bit 2: Writeable flag
  106.       bit 3: Warn flag (give Message_MenuWarning when over submenu arrow)
  107.       bit 4: Shade flag (1=menu item is greyed out)
  108.       bit 5: Indirected flag
  109.       bit 6: Use anti-aliased font
  110.       bit 7: Last item flag
  111.       bit 8: Centre item horizontally
  112.  bits 24-31: Font handle (if bit 6 is set)
  113.