Navigation

phoenix_title wx.lib.masked.maskededit.MaskedEditMixin

This class allows us to abstract the masked edit functionality that could be associated with any text entry control. (eg. wx.TextCtrl, wx.ComboBox, etc.) It forms the basis for all of the lib.masked controls.


class_hierarchy Class Hierarchy

Inheritance diagram for class MaskedEditMixin:

sub_classes Known Subclasses

wx.lib.masked.combobox.BaseMaskedComboBox, wx.lib.masked.textctrl.BaseMaskedTextCtrl


method_summary Methods Summary

__init__

This is the “constructor” for setting up the mixin variable parameters for the composite class.

ClearValue

Blanks the current control value by replacing it with the default value.

ClearValueAlt

Blanks the current control value by replacing it with the default value.

GetCtrlParameter

Routine for retrieving the value of any given parameter

GetFieldParameter

Routine provided for getting a parameter of an individual field.

GetMaskParameter

old name for the GetCtrlParameters function (DEPRECATED)

GetPlainValue

Returns control’s value stripped of the template text.

IsDefault

Returns True if the value specified (or the value of the control if not specified)

IsEmpty

Returns True if control is equal to an empty value.

IsValid

Indicates whether the value specified (or the current value of the control

SetBackgroundColour

SetCtrlParameters

This public function can be used to set individual or multiple masked edit

SetFieldParameters

Routine provided to modify the parameters of a given field.

SetForegroundColour

SetMaskParameters

old name for the SetCtrlParameters function (DEPRECATED)

api Class API

class MaskedEditMixin

This class allows us to abstract the masked edit functionality that could be associated with any text entry control. (eg. wx.TextCtrl, wx.ComboBox, etc.) It forms the basis for all of the lib.masked controls.


Methods

__init__(self, name = 'MaskedEdit', **kwargs)

This is the “constructor” for setting up the mixin variable parameters for the composite class.


ClearValue(self)

Blanks the current control value by replacing it with the default value.


ClearValueAlt(self)

Blanks the current control value by replacing it with the default value. Using ChangeValue, so not to fire a change event


GetCtrlParameter(self, paramname)

Routine for retrieving the value of any given parameter


GetFieldParameter(self, field_index, paramname)

Routine provided for getting a parameter of an individual field.


GetMaskParameter(self, paramname)

old name for the GetCtrlParameters function (DEPRECATED)


GetPlainValue(self, candidate=None)

Returns control’s value stripped of the template text. plainvalue = MaskedEditMixin.GetPlainValue()


IsDefault(self, value=None)

Returns True if the value specified (or the value of the control if not specified) is equal to the default value.


IsEmpty(self, value=None)

Returns True if control is equal to an empty value. (Empty means all editable positions in the template == fillChar.)


IsValid(self, value=None)

Indicates whether the value specified (or the current value of the control if not specified) is considered valid.


SetBackgroundColour(self, colour)

SetCtrlParameters(self, **kwargs)

This public function can be used to set individual or multiple masked edit parameters after construction. (See maskededit module overview for the list of valid parameters.)


SetFieldParameters(self, field_index, **kwargs)

Routine provided to modify the parameters of a given field. Because changes to fields can affect the overall control, direct access to the fields is prevented, and the control is always “reconfigured” after setting a field parameter. (See maskededit module overview for the list of valid field-level parameters.)


SetForegroundColour(self, colour)

SetMaskParameters(self, **kwargs)

old name for the SetCtrlParameters function (DEPRECATED)