Numeric Documentation¶

Numeric class¶

Base Class

This is a base class and should not be instantiated directly.

Inheritance

Numeric class inherits from Widget class.

Numeric methods¶

Nothing to see here

Numeric class has no methods.

Numeric properties¶

property Numeric.upper_bound¶

Get or set the upper bound limit (int or float).

Default value is None and this bound will be ignored if not set to a valid value. It should not be smaller than (pygameyagui.Numeric.lower_bound). The current value of the widget will be automatically forced to comply.

property Numeric.lower_bound¶

Get or set the lower bound limit (int or float).

Default value is None and this bound will be ignored if not set to a valid value. It should not be bigger than (pygameyagui.Numeric.upper_bound). The current value of the widget will be automatically forced to comply.

property Numeric.unit¶

Get or set the quantity unit (str).

Default value is a empty string.

property Numeric.value¶

Get (int or float) or set (int, float or str) the value.

Default value is 0 (int). It will be forced to comply to upper and lower bounds if they are set.

property Numeric.decimal_places¶

Get or set the number of decimal places (int >= 0).

Default value is 0 (int). This property influences the string representation of the numeric value. It does not influences or rounds the value for calculations.