Uranium
Application Framework
UM.Settings.Validator.Validator Class Reference

Validates that a SettingInstance's value is within a certain minimum and maximum value. More...

Inheritance diagram for UM.Settings.Validator.Validator:
UM.Settings.SettingFunction.SettingFunction

Public Member Functions

def __init__
 Constructor. More...
 
def __call__
 Perform the actual validation. More...
 
- Public Member Functions inherited from UM.Settings.SettingFunction.SettingFunction
def __init__
 Constructor. More...
 
def __call__
 Call the actual function to calculate the value. More...
 
def __eq__ (self, other)
 
def isValid (self)
 Returns whether the function is ready to be executed. More...
 
def getUsedSettingKeys (self)
 Retrieve a set of the keys (strings) of all the settings used in this function. More...
 
def __str__ (self)
 
def __repr__ (self)
 
def __getstate__ (self)
 To support Pickle. More...
 
def __setstate__
 
def registerOperator
 Expose a custom function to the code executed by SettingFunction. More...
 

Detailed Description

Validates that a SettingInstance's value is within a certain minimum and maximum value.

This class performs validation of any value that has lt and gt implemented, but it is primarily used for numerical values like integers and floats.

Constructor & Destructor Documentation

◆ __init__()

def UM.Settings.Validator.Validator.__init__ (   self,
  key 
)

Constructor.

Parameters
instanceThe instance this Validator validates.

Member Function Documentation

◆ __call__()

def UM.Settings.Validator.Validator.__call__ (   self,
  value_provider 
)

Perform the actual validation.


The documentation for this class was generated from the following file: