Navigation

phoenix_title wx.propgrid.IntProperty

Basic property with integer value.


class_hierarchy Class Hierarchy

Inheritance diagram for class IntProperty:

method_summary Methods Summary

__init__

AddSpinStepValue

Returns what would be the new value of the property after adding SpinCtrl editor step to the current value.

DoGetValidator

Returns pointer to the wx.Validator that should be used with the editor of this property (None for no validator).

GetClassValidator

IntToValue

Converts integer (possibly a choice selection) into Variant value appropriate for this property.

StringToValue

Converts text into Variant value appropriate for this property.

ValidateValue

Implement this function in derived class to check the value.

ValueToString

Converts property value into a text representation.

api Class API

class wx.propgrid.IntProperty(NumericProperty)

Possible constructors:

IntProperty(label=PG_LABEL, name=PG_LABEL, value=0)

IntProperty(label, name, value)

Basic property with integer value.


Methods

__init__(self, *args, **kw)

overload Overloaded Implementations:


__init__ (self, label=PG_LABEL, name=PG_LABEL, value=0)

Parameters:

  • label (string) –

  • name (string) –

  • value (long) –


__init__ (self, label, name, value)

Parameters:

  • label (string) –

  • name (string) –

  • value (long) –



AddSpinStepValue(self, stepScale)

Returns what would be the new value of the property after adding SpinCtrl editor step to the current value.

Current value range and wrapping (if enabled) are taken into account. This member has to be implemented in derived properties.

Parameters:

stepScale (long) – SpinCtrl editor step is first multiplied by this factor and next added to the current value.

Return type:

PGVariant

Returns:

Value which property would have after adding SpinCtrl editor step.

Note

Current property value is not changed.


DoGetValidator(self)

Returns pointer to the wx.Validator that should be used with the editor of this property (None for no validator).

Setting validator explicitly via SetPropertyValidator will override this.

In most situations, code like this should work well (macros are used to maintain one actual validator instance, so on the second call the function exits within the first macro):

class MyPropertyClass(wx.propgrid.IntProperty):
    ...
    def DoGetValidator(self):
        validator = MyValidator(...)

        ... prepare validator...

        return validator
Return type:

Validator

Note

You can get common filename validator by returning wx.propgrid.FileProperty.GetClassValidator . wx.propgrid.DirProperty, for example, uses it.


static GetClassValidator()
Return type:

Validator


IntToValue(self, number, argFlags=0)

Converts integer (possibly a choice selection) into Variant value appropriate for this property.

Parameters:

  • number (int) – Integer to be translated into variant.

  • argFlags (int) – If PG_FULL_VALUE is set, returns complete, storable value instead of displayable one.

Return type:

tuple

Returns:

( bool, variant )

Note

  • If property is not supposed to use choice or spinctrl or other editor with int-based value, it is not necessary to implement this method.

  • Default implementation simply assign given int to m_value.

  • If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.

  • You might want to take into account that m_value is Mull variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).


StringToValue(self, text, argFlags=0)

Converts text into Variant value appropriate for this property.

Parameters:

  • text (string) – Text to be translated into variant.

  • argFlags (int) – If PG_FULL_VALUE is set, returns complete, storable value instead of displayable one (they may be different). If PG_COMPOSITE_FRAGMENT is set, text is interpreted as a part of composite property string value (as generated by ValueToString called with this same flag).

Return type:

tuple

You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).

Returns:

( bool, variant )

Note

Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.


ValidateValue(self, value, validationInfo)

Implement this function in derived class to check the value.

Return True if it is ok. Returning False prevents property change events from occurring.

Parameters:
Return type:

bool

Note

  • Default implementation always returns True.


ValueToString(self, value, argFlags=0)

Converts property value into a text representation.

Parameters:

  • value (PGVariant) – Value to be converted.

  • argFlags (int) – If 0 (default value), then displayed string is returned. If PG_FULL_VALUE is set, returns complete, storable string value instead of displayable. If PG_EDITABLE_VALUE is set, returns string value that must be editable in textctrl. If PG_COMPOSITE_FRAGMENT is set, returns text that is appropriate to display as a part of string property’s composite text representation.

Return type:

string

Note

Default implementation calls GenerateComposedValue .