This rule should be used to indicate if a value, in the display model, is valid or invalid.
More...
Data descriptors inherited from dialog.rule.ValueRule: |
| def | display |
| def | name |
| def | valid |
Data descriptors inherited from dialog.rule.Rule: |
| def | __dict__ |
| | dictionary for instance variables (if defined)
|
| def | __weakref__ |
| | list of weak references to the object (if defined)
|
| def | dialog |
| def | enabled |
| def | object |
Additional Inherited Members |
| def | foo |
| def | foo |
Detailed Description
This rule should be used to indicate if a value, in the display model, is valid or invalid.
Examples include limiting a number within a range.
Method resolution order
Validate
dialog.rule.ValueRule
dialog.rule.Rule
builtin.object
Constructor & Destructor Documentation
| def dialog.rules.Validate.__init__ |
( |
|
args | ) |
|
number, name, root will all be filled in for you
@param do A function which takes one argument, a dictionary
of key value pairs representing the current state
of the display model.
@param reason A string to be displayed to the user if this rule
indicates that their value isn't valid.
@param triggers A list of Fields to trigger this off other than
the field you're adding it to.
Reimplemented from dialog.rule.ValueRule.
Member Function Documentation
| def dialog.rules.Validate.__dict__ |
( |
|
args | ) |
|
| def dialog.rules.Validate.__getdialog__ |
( |
|
args | ) |
|
| def dialog.rules.Validate.__getdisplay__ |
( |
|
args | ) |
|
| def dialog.rules.Validate.__getenabled__ |
( |
|
args | ) |
|
| def dialog.rules.Validate.__getname__ |
( |
|
args | ) |
|
| def dialog.rules.Validate.__getobject__ |
( |
|
args | ) |
|
| def dialog.rules.Validate.__getvalid__ |
( |
|
args | ) |
|
| def dialog.rules.Validate.__weakref__ |
( |
|
args | ) |
|
| def dialog.rules.Validate.delete |
( |
|
args | ) |
|
You may override this function.
This function is called when the rule is removed, often to
be replaced by a quick call to new
Reimplemented from dialog.rule.ValueRule.
| def dialog.rules.Validate.dialog |
( |
|
args | ) |
|
| def dialog.rules.Validate.display |
( |
|
args | ) |
|
| def dialog.rules.Validate.enabled |
( |
|
args | ) |
|
| def dialog.rules.Validate.get_storage |
( |
|
args | ) |
|
This is where you store your data if you need to store data between
invocations of your rule.
@param dat The item you're editing.
@return a list. You can put things into this list and they'll
be there the next time you call get_storage
@note This is a constant time function.
Reimplemented from dialog.rule.ValueRule.
| def dialog.rules.Validate.name |
( |
|
args | ) |
|
| def dialog.rules.Validate.new |
( |
|
args | ) |
|
| def dialog.rules.Validate.object |
( |
|
args | ) |
|
| def dialog.rules.Validate.run |
( |
|
args | ) |
|
| def dialog.rules.Validate.set_storage |
( |
|
args | ) |
|
You may prefer to override the default storage.
Lists actually get pretty expensive, so if you modify
your rule to use tuples (if you need to save multiple values)
or the single value you need to save you'll save a lot of memory
in multi edit.
For the Change rule, this means 178 bytes per item instead of 242 bytes.
Reimplemented from dialog.rule.ValueRule.
| def dialog.rules.Validate.valid |
( |
|
args | ) |
|
Public Member Functions inherited from dialog.rule.ValueRule
1.8.1.2