thermometer
The thermometer class provides an interface to manage properties and actions of thermometer widgets.
Hierarchy
ℹ️ Important
- This class inherit from the
widgetclass - To simplify the distinction between form objects and object type, this documentation uses the term
widgetfor all form objects, whether static (a line, a rectangle…) or not (a button, a subform…). - All functions that return
Thisreturn the current widget object and can include one call after another.
This class is available via the form class through the Thermometer interface.
Example
This.form:=cs.form.new(This)
...
This.myThermo:=This.form.Thermometer("Thermometer")
...
This.myThermo.barber().start()
This class is, more generally, available from the cs class store, or cs.ui class store if you use the UI component.
Example
Form.myThermo:=cs.thermometer.new("Thermometer")
Form.myThermo.barber().start()
cs.thermometer.new()
cs.thermometer.new ( name : Text) : cs.thermometer
cs.thermometer.new ( name : Text ; parent : Object) : cs.thermometer
cs.thermometer.new ( ) : cs.thermometer
| Parameter | Type | Description | |
|---|---|---|---|
| name | Text | → | Widget name |
| parent | cs.form | → | form object containing the widget |
| result | cs.thermometer | ← | New cs.thermometer |
Description
cs.thermometer.new() creates & returns a new instance of the class.
- The optional
parentparameter is thecs.formobject containing the widget. This parameter is automatically set if instantiation is performed via a form widget instantiation function of thecs.formclass. - If the
nameparameter is ommited, the constructor use the result of OBJECT Get name (Object current )
⚠️ Omitting the widget name can only be used if the constructor is called from the object method.
Properties & Functions
Inherited properties and functions are described in the parent classes:
Functions
| Functions | |
|---|---|
.asynchronous () → This |
Sets the progress indicator as circular indicator displaying continuous animation |
.isAsynchronous () → Boolean |
Returns True if the progress indicator is asynchronous |
.barber () → This |
Sets the progress indicator as bar displaying continuous animation |
.isBarber () → Boolean |
Returns True if the progress indicator is a barber shop |
.progress () → This |
Sets the progress indicator as standard progress bar |
.isProgress () → Boolean |
Returns True if the progress indicator is a standard progress bar |
.getIndicatorType () → Integer |
Returns the indicator type |
.start () → This |
Starts an asynchronous progress indicator |
.stop () → This |
Stops an asynchronous progress indicator |
📌 To set the value of a standard progress bar use the property
valueor the inherited function .setValue()