Gauge.mui Class Reference¶

BOOPSI custom class Gauge.mui (MUI 3.8 dev). Each ### sub-section below documents one of the class's attributes or methods. Sub-classes of Gauge.mui are listed at the end under Sub-classes; the class hierarchy itself is documented in the MUI classes index.

Function index¶

Class definition

• Gauge.mui

Attributes

• MUIA_Gauge_Current
• MUIA_Gauge_Divide
• MUIA_Gauge_Horiz
• MUIA_Gauge_InfoText
• MUIA_Gauge_Max

---

Gauge.mui¶

---

MUIA_Gauge_Current¶

MUIA_Gauge_Current -- (V4 ) [ISG], LONG

Function

Set the current level of the gauge. The value must be between 0 and MUIA_Gauge_Max.

See also

MUIA_Gauge_Max

---

MUIA_Gauge_Divide¶

MUIA_Gauge_Divide -- (V4 ) [ISG], BOOL

Function

If this attribute is != 0, every value set with MUIA_Gauge_Current will be divided by this before further processing.

Example

See BoopsiDoor demo program.

See also

MUIA_Gauge_Current

---

MUIA_Gauge_Horiz¶

MUIA_Gauge_Horiz -- (V4 ) [I..], BOOL

Function

Determine if you want a horizontal or vertical gauge. Default to FALSE

See also

MUIA_Gauge_Current

---

MUIA_Gauge_InfoText¶

MUIA_Gauge_InfoText -- (V7 ) [ISG], STRPTR

Function

The text given here is displayed within a gauge object and is usually intended to show some kind of percentage information. This texts preparse is set to "\33c\0338", this makes it appear centered and highlighted by default. Any %ld will be replaced with the current value of MUIA_Gauge_Current. Note: Up to V18 of gauge.mui, InfoText worked only for horizontal gauges. If you intend to use and change info text, you should specify an empty MUIA_Gauge_InfoText ("") at object creation time. This makes your object get a fixed height that fits the height of the info text. Since version 19 of gauge.mui, you can also use MUIA_Gauge_InfoText for vertical gauges. VERSION Implemented in version 7 of gauge class (MUI 1.5). Version 19 of gauge class (MUI 3.8) enhances this attribute to work with vertical gauge objects too.

Example

...
MUIA_Gauge_InfoText, "%ld %%",
...

See also

MUIA_Gauge_Current

---

MUIA_Gauge_Max¶

MUIA_Gauge_Max -- (V4 ) [ISG], LONG

Function

Set the maximum value for the gauge. Defaults to 100. Currently, MUIA_Gauge_Max and MUIA_Gauge_Current is limited to 16 bit.

See also

MUIA_Gauge_Current

---