Package peppy :: Package lib :: Module userparams :: Class FloatParam

Class FloatParam

      object --+        
               |        
debug.debugmixin --+    
                   |    
               Param --+
                       |
                      FloatParam

Int parameter that displays a text entry field as its user interface.

The text is converted through the locale atof conversion.

Instance Methods

textToValue(self, text)
Convert the user's config text to the type expected by the python code.

setValue(self, ctrl, value)
Populate the control given the user value.

getValue(self, ctrl)
Get the user value from the control.

Inherited from Param: OnCallback, __init__, __str__, getCtrl, getLabel, isSettable, isVisible, processCallback, setCallback, setInitialState, setValueWithoutCallback, valueToText

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__

Class Methods
Inherited from `debug.debugmixin`: `dprint`

Class Variables

default = 0.0

Inherited from Param: callback_event

Inherited from debug.debugmixin: debuglevel

Properties
Inherited from `object`: `__class__`

Method Details

textToValue(self, text)

Convert the user's config text to the type expected by the python code.

Subclasses should return the type expected by the user code.

Overrides: Param.textToValue: (inherited documentation)

setValue(self, ctrl, value)

Populate the control given the user value.

If any conversion is needed to show the user value in the control, do it here.

Overrides: Param.setValue: (inherited documentation)

getValue(self, ctrl)

Get the user value from the control.

If the control doesn't automatically return a value of the correct type, convert it here.

Overrides: Param.getValue: (inherited documentation)