home *** CD-ROM | disk | FTP | other *** search
/ Archive Magazine 1996 / ARCHIVE_96.iso / discs / mag_discs / volume_8 / issue_06 / risc_os / Hourglass < prev    next >
Text File  |  1988-10-14  |  3KB  |  89 lines
  1. ; > &.DocRISCOS.Hourglass
  2. ;
  3.  
  4. The Hourglass module will change the pointer shape to that of an Hourglass.
  5. You can optionally also display a percentage figure and two "LED" indicators
  6. for status information.
  7.  
  8. The Hourglass interface is via the following SWI's
  9.  
  10. Hourglass_On &406C0
  11. ------------
  12. Entry:
  13. Exit:
  14.  
  15. This turns on the Hourglass. Although control return immediately there is a
  16. delay of 1/3 of a second before the Hourglass becomes visible. Thus the client
  17. can bracket an operation by Hourglass_On/Hourglass_Off and the hourglass
  18. will only be displayed if the operation takes longer than 1/3 of a second.
  19. (For delays other than the default see Hourglass_Start).
  20.  
  21. Hourglass_On's are nestable. If the Hourglass is already visible then a count
  22. is incremented and the Hourglass will remain visible until an equivalent
  23. number of Hourglass_Off's are done.
  24.  
  25. Hourglass_Off &406C1
  26. -------------
  27. Entry:
  28. Exit:
  29.  
  30. This will turn off the Hourglass, unless of course there are nested 
  31. Hourglass_On calls in which case the Hourglass stays visible until
  32. an equal number of Hourglass_Off calls are made.
  33.  
  34. When the Hourglass is removed the pointer number and colours are restored
  35. to those in use at the first Hourglass_On.
  36.  
  37. Note that cursor shapes 3 and 4 are used (ie corrupted!) by the Hourglass,
  38. but users should not have been using these anyway.
  39.  
  40. Hourglass_Smash &406C2
  41. ---------------
  42. Entry:
  43. Exit:
  44.  
  45. Will turn off the Hourglass immediately taking no notice of nested 
  46. Hourglass_On's. A last ditch call for when you are sure neither you,
  47. nor anyone else, should be displaying an Hourglass.
  48.  
  49. Hourglass_Start &406C3
  50. ---------------
  51. Entry:
  52.     R0 = Delay before startup in centi-seconds.
  53. Exit:
  54.  
  55. Similar to Hourglass_On, except you can provide your own startup delay.
  56.  
  57. A delay of zero can be used to suppress the Hourglass, so future
  58. Hourglass_On and Hourglass_Start calls have no effect. This only applies
  59. if the Hourglass is currently off. The condition is terminated by the
  60. matching Hourglass_Off, or by an Hourglass_Smash.
  61.  
  62.  
  63. Hourglass_Percentage &406C4
  64. --------------------
  65. Entry:
  66.     R0 = (0-99) Percentage to display
  67.          otherwise turn off Percentage
  68. Exit:
  69.  
  70. The user can display a Percentage below the Hourglass. If in the
  71. range 0-99 it is displayed, values outside this range turn off the
  72. percentage. 
  73.  
  74. The initial condition of an Hourglass is to have Percentages turned off.
  75.  
  76. Hourglass_LEDs &406C5
  77. --------------
  78. Entry:
  79.     R0, R1 setup LEDs  
  80.             NewLEDs = (OldLEDs AND R1) XOR R0
  81. Exit:
  82.     R0 = OldLEDs
  83.  
  84. The are two display indicators above the Hourglass which can be used
  85. to display status information. These correspond to bits 0,1 of the
  86. LEDs word. Bit set indicates indicator on.
  87.  
  88. The default condition is all indicators off.
  89.