home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 18 / amigaformatcd18.iso / mui / mui_developer / autodocs / mui_gauge.doc < prev    next >
Text File  |  1997-03-10  |  2KB  |  101 lines
  1. TABLE OF CONTENTS
  2.  
  3. Gauge.mui/Gauge.mui
  4. Gauge.mui/MUIA_Gauge_Current
  5. Gauge.mui/MUIA_Gauge_Divide
  6. Gauge.mui/MUIA_Gauge_Horiz
  7. Gauge.mui/MUIA_Gauge_InfoText
  8. Gauge.mui/MUIA_Gauge_Max
  9. Gauge.mui/Gauge.mui
  10.  
  11.     A gauge object is a nice looking display element useful
  12.     for some kind of progress display.
  13. Gauge.mui/MUIA_Gauge_Current
  14.  
  15.     NAME
  16.     MUIA_Gauge_Current -- (V4 ) [ISG], LONG
  17.  
  18.     FUNCTION
  19.     Set the current level of the gauge. The value must be
  20.     between 0 and MUIA_Gauge_Max.
  21.  
  22.     SEE ALSO
  23.     MUIA_Gauge_Max
  24. Gauge.mui/MUIA_Gauge_Divide
  25.  
  26.     NAME
  27.     MUIA_Gauge_Divide -- (V4 ) [ISG], BOOL
  28.  
  29.     FUNCTION
  30.     If this attribute is != 0, every value set with
  31.     MUIA_Gauge_Current will be divided by this before
  32.     further processing.
  33.  
  34.     EXAMPLE
  35.     See BoopsiDoor demo program.
  36.  
  37.     SEE ALSO
  38.     MUIA_Gauge_Current
  39. Gauge.mui/MUIA_Gauge_Horiz
  40.  
  41.     NAME
  42.     MUIA_Gauge_Horiz -- (V4 ) [I..], BOOL
  43.  
  44.     FUNCTION
  45.     Determine if you want a horizontal or vertical gauge.
  46.     Default to FALSE
  47.  
  48.     SEE ALSO
  49.     MUIA_Gauge_Current
  50. Gauge.mui/MUIA_Gauge_InfoText
  51.  
  52.     NAME
  53.     MUIA_Gauge_InfoText -- (V7 ) [ISG], STRPTR
  54.  
  55.     FUNCTION
  56.     The text given here is displayed within a gauge object
  57.     and is usually intended to show some kind of percentage
  58.     information.
  59.  
  60.     This texts preparse is set to "\33c\0338", this makes
  61.     it appear centered and highlighted by default.
  62.  
  63.     Any %ld will be replaced with the current value of
  64.     MUIA_Gauge_Current.
  65.  
  66.     Note: Up to V18 of gauge.mui, InfoText worked only for 
  67.     horizontal gauges. If you intend to use and change info
  68.     text, you should specify an empty MUIA_Gauge_InfoText ("")
  69.     at object creation time. This makes your object get
  70.     a fixed height that fits the height of the info text.
  71.  
  72.     Since version 19 of gauge.mui, you can also use
  73.     MUIA_Gauge_InfoText for vertical gauges. 
  74.  
  75.     VERSION
  76.     Implemented in version 7 of gauge class (MUI 1.5).
  77.     Version 19 of gauge class (MUI 3.8) enhances this
  78.     attribute to work with vertical gauge objects too.
  79.  
  80.     EXAMPLE
  81.     ...
  82.     MUIA_Gauge_InfoText, "%ld %%",
  83.     ...
  84.  
  85.     SEE ALSO
  86.     MUIA_Gauge_Current
  87. Gauge.mui/MUIA_Gauge_Max
  88.  
  89.     NAME
  90.     MUIA_Gauge_Max -- (V4 ) [ISG], LONG
  91.  
  92.     FUNCTION
  93.     Set the maximum value for the gauge.
  94.     Defaults to 100.
  95.  
  96.     Currently, MUIA_Gauge_Max and MUIA_Gauge_Current 
  97.     is limited to 16 bit.
  98.  
  99.     SEE ALSO
  100.     MUIA_Gauge_Current
  101.