Package wx :: Package lib :: Package masked :: Module textctrl :: Class BaseMaskedTextCtrl

[frames | no frames]

## Type BaseMaskedTextCtrl

               MaskedEditMixin --+
                                 |
    object --+                   |
             |                   |
        Object --+               |
                 |               |
        EvtHandler --+           |
                     |           |
                Window --+       |
                         |       |
                   Control --+   |
                             |   |
                      TextCtrl --+
                                 |
                                BaseMaskedTextCtrl

Known Subclasses:
  `IpAddrCtrl`, `NumCtrl`, `PreMaskedTextCtrl`, `TextCtrl`, `TimeCtrl`

This is the primary derivation from MaskedEditMixin. It provides a general masked text control that can be configured with different masks.

However, this is done with an extra level of inheritance, so that "general" classes like masked.TextCtrl can have all possible attributes, while derived classes, like masked.TimeCtrl and masked.NumCtrl can prevent exposure of those optional attributes of their base class that do not make sense for their derivation. Therefore, we define:

    BaseMaskedTextCtrl(TextCtrl, MaskedEditMixin)

and:

    masked.TextCtrl(BaseMaskedTextCtrl, MaskedEditAccessorsMixin).

This allows us to then derive:

    masked.NumCtrl( BaseMaskedTextCtrl )

and not have to expose all the same accessor functions for the derived control when they don't all make sense for it.

In practice, BaseMaskedTextCtrl should never be instantiated directly, but should only be used in derived classes.

Method Summary
| `__init__(self, parent, id, value, pos, size, style, validator, name, setupEventHandling, **kwargs)`
| `__repr__(self)`
| ``Clear`(self)` Blanks the current control value by replacing it with the default value.
| ``Cut`(self)` This function redefines the externally accessible .Cut to be a smart "erase" of the text in question, so as not to corrupt the masked control.
| `IsEmpty(*args, **kw)`
| ``IsModified`(self)` This function overrides the raw wx.TextCtrl method, because the masked edit mixin uses SetValue to change the value, which doesn't modify the state of this attribute.
| ``Paste`(self)` This function redefines the externally accessible .Paste to be a smart "paste" of the text in question, so as not to corrupt the masked control.
| ``Refresh`(self)` This function redefines the externally accessible .Refresh() to validate the contents of the masked control as it refreshes.
| ``SetFont`(self, *args, **kwargs)` Set the font, then recalculate control size, if appropriate.
| ``SetValue`(self, value)` This function redefines the externally accessible .SetValue() to be a smart "paste" of the text in question, so as not to corrupt the masked control.
| ``Undo`(self)` This function defines the undo operation for the control.

Property Summary

Class Variable Summary

Instance Method Details

### Clear(self)

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

  Overrides:
    `wx.TextCtrl.Clear`

### Cut(self)

This function redefines the externally accessible .Cut to be a smart "erase" of the text in question, so as not to corrupt the masked control. NOTE: this must be done in the class derived from the base wx control.

  Overrides:
    `wx.TextCtrl.Cut`

### IsModified(self)

This function overrides the raw wx.TextCtrl method, because the masked edit mixin uses SetValue to change the value, which doesn't modify the state of this attribute. So, the derived control keeps track on each keystroke to see if the value changes, and if so, it's been modified.

  Overrides:
    `wx.TextCtrl.IsModified`

### Paste(self)

This function redefines the externally accessible .Paste to be a smart "paste" of the text in question, so as not to corrupt the masked control. NOTE: this must be done in the class derived from the base wx control.

  Overrides:
    `wx.TextCtrl.Paste`

### Refresh(self)

This function redefines the externally accessible .Refresh() to validate the contents of the masked control as it refreshes. NOTE: this must be done in the class derived from the base wx control.

  Overrides:
    `wx.Window.Refresh`

### SetFont(self, *args, **kwargs)

Set the font, then recalculate control size, if appropriate.

  Overrides:
    `wx.Window.SetFont`

### SetValue(self, value)

This function redefines the externally accessible .SetValue() to be a smart "paste" of the text in question, so as not to corrupt the masked control. NOTE: this must be done in the class derived from the base wx control.

  Overrides:
    `wx.TextCtrl.SetValue`

### Undo(self)

This function defines the undo operation for the control. (The default undo is 1-deep.)

  Overrides:
    `wx.TextCtrl.Undo`

Generated by Epydoc 2.1.20050511.rpd on Thu Mar 22 12:07:17 2007 | http://epydoc.sf.net