.. include:: headings.inc

.. currentmodule:: lib.masked.maskededit

.. highlight:: python



.. _lib.masked.maskededit.MaskedEditMixin:

==========================================================================================================================================
|phoenix_title|  **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| Inheritance Diagram
=====================================

Inheritance diagram for class **MaskedEditMixin**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.masked.maskededit.MaskedEditMixin_inheritance.png" alt="Inheritance diagram of MaskedEditMixin" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.masked.maskededit.MaskedEditMixin.html" title="This class allows us to abstract the masked edit functionality that could" alt="" coords="7,5,236,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~lib.masked.maskededit.MaskedEditMixin.__init__`                          This is the "constructor" for setting up the mixin variable parameters for the composite class.
:meth:`~lib.masked.maskededit.MaskedEditMixin.ClearValue`                        Blanks the current control value by replacing it with the default value.
:meth:`~lib.masked.maskededit.MaskedEditMixin.ClearValueAlt`                     Blanks the current control value by replacing it with the default value.
:meth:`~lib.masked.maskededit.MaskedEditMixin.GetCtrlParameter`                  Routine for retrieving the value of any given parameter
:meth:`~lib.masked.maskededit.MaskedEditMixin.GetFieldParameter`                 Routine provided for getting a parameter of an individual field.
:meth:`~lib.masked.maskededit.MaskedEditMixin.GetMaskParameter`                  old name for the GetCtrlParameters function  (DEPRECATED)
:meth:`~lib.masked.maskededit.MaskedEditMixin.GetPlainValue`                     Returns control's value stripped of the template text.
:meth:`~lib.masked.maskededit.MaskedEditMixin.IsDefault`                         Returns ``True`` if the value specified (or the value of the control if not specified)
:meth:`~lib.masked.maskededit.MaskedEditMixin.IsEmpty`                           Returns ``True`` if control is equal to an empty value.
:meth:`~lib.masked.maskededit.MaskedEditMixin.IsValid`                           Indicates whether the value specified (or the current value of the control
:meth:`~lib.masked.maskededit.MaskedEditMixin.SetCtrlParameters`                 This public function can be used to set individual or multiple masked edit
:meth:`~lib.masked.maskededit.MaskedEditMixin.SetFieldParameters`                Routine provided to modify the parameters of a given field.
:meth:`~lib.masked.maskededit.MaskedEditMixin.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.

   .. method:: __init__(self, name = 'MaskedEdit', \*\*kwargs)

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


   .. method:: ClearValue(self)

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


   .. method:: ClearValueAlt(self)

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


   .. method:: GetCtrlParameter(self, paramname)

      Routine for retrieving the value of any given parameter


   .. method:: GetFieldParameter(self, field_index, paramname)

      Routine provided for getting a parameter of an individual field.


   .. method:: GetMaskParameter(self, paramname)

      old name for the GetCtrlParameters function  (DEPRECATED)


   .. method:: GetPlainValue(self, candidate=None)

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


   .. method:: 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.


   .. method:: IsEmpty(self, value=None)

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


   .. method:: IsValid(self, value=None)

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


   .. method:: 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.)


   .. method:: 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.)


   .. method:: SetMaskParameters(self, \*\*kwargs)

      old name for the SetCtrlParameters function  (DEPRECATED)