.. include:: headings.inc

.. currentmodule:: lib.masked.textctrl

.. highlight:: python



.. _lib.masked.textctrl.TextCtrl:

==========================================================================================================================================
|phoenix_title|  **TextCtrl**
==========================================================================================================================================

The "user-visible" masked text control; it is identical to the
BaseMaskedTextCtrl class it's derived from.
(This extra level of inheritance allows us to add the generic
set of masked edit parameters only to this class while allowing
other classes to derive from the "base" masked text control,
and provide a smaller set of valid accessor functions.)
See BaseMaskedTextCtrl for available methods.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **TextCtrl**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.masked.textctrl.TextCtrl_inheritance.png" alt="Inheritance diagram of TextCtrl" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Control.html" title="This is the base class for a control or 'widget'." alt="" coords="629,33,704,63"/> <area shape="rect" id="node2" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="472,31,552,62"/> <area shape="rect" id="node4" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="303,33,401,63"/> <area shape="rect" id="node6" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="153,33,225,63"/> <area shape="rect" id="node8" href="lib.masked.maskededit.MaskedEditMixin.html" title="This class allows us to abstract the masked edit functionality that could" alt="" coords="924,31,1153,62"/> <area shape="rect" id="node19" href="lib.masked.textctrl.BaseMaskedTextCtrl.html" title="This is the primary derivation from MaskedEditMixin.  It provides" alt="" coords="1247,58,1465,89"/> <area shape="rect" id="node12" href="lib.masked.maskededit.MaskedEditAccessorsMixin.html" title="To avoid a ton of boiler-plate, and to automate the getter/setter generation" alt="" coords="1203,5,1509,35"/> <area shape="rect" id="node18" href="lib.masked.textctrl.TextCtrl.html" title="The 'user-visible' masked text control; it is identical to the" alt="" coords="1559,31,1684,62"/> <area shape="rect" id="node13" href="TextEntry.html" title="Common base class for single line text entry fields." alt="" coords="621,137,712,167"/> <area shape="rect" id="node22" href="TextCtrl.html" title="A text control allows text to be displayed and edited." alt="" coords="1001,85,1076,115"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

:class:`lib.masked.maskededit.MaskedEditAccessorsMixin`, :class:`lib.masked.textctrl.BaseMaskedTextCtrl`

|


|api| Class API
===============
   

.. class:: TextCtrl( BaseMaskedTextCtrl, MaskedEditAccessorsMixin )

   The "user-visible" masked text control; it is identical to the
   BaseMaskedTextCtrl class it's derived from.
   (This extra level of inheritance allows us to add the generic
   set of masked edit parameters only to this class while allowing
   other classes to derive from the "base" masked text control,
   and provide a smaller set of valid accessor functions.)
   See BaseMaskedTextCtrl for available methods.