.. include:: headings.inc

.. module:: lib.masked.ctrl

.. currentmodule:: lib.masked.ctrl

.. highlight:: python



.. _lib.masked.ctrl:

==========================================================================================================================================
|phoenix_title|  **ctrl**
==========================================================================================================================================

*masked.Ctrl* is actually a factory function for several types of
masked edit controls:

    =================  =========================================================
    masked.TextCtrl     standard masked edit text box
    masked.ComboBox     adds combobox capabilities
    masked.IpAddrCtrl   adds logical input semantics for IP address entry
    masked.TimeCtrl     special subclass handling lots of time formats as values
    masked.NumCtrl      special subclass handling numeric values
    =================  =========================================================

masked.Ctrl works by looking for a special *controlType*
parameter in the variable arguments of the control, to determine
what kind of instance to return.
controlType can be one of::

    controlTypes.TEXT
    controlTypes.COMBO
    controlTypes.IPADDR
    controlTypes.TIME
    controlTypes.NUMBER

These constants are also available individually, ie, you can
use either of the following::

    from wxPython.wx.lib.masked import Ctrl, COMBO, TEXT, NUMBER, TIME
    from wxPython.wx.lib.masked import Ctrl, controlTypes

If not specified as a keyword argument, the default controlType is
controlTypes.TEXT.

Each of the above classes has its own unique arguments, but Masked.Ctrl
provides a single "unified" interface for masked controls.



|

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

Inheritance diagram for module **ctrl**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.masked.ctrl_inheritance.png" alt="Inheritance diagram of ctrl" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.masked.ctrl.controlTypes.html" title="ctrl.controlTypes" alt="" coords="7,5,148,35"/> </map> 
   </p>

|


|function_summary| Functions Summary
====================================

================================================================================ ================================================================================
:func:`~lib.masked.ctrl.Ctrl`                                                    Actually a factory function providing a unifying
================================================================================ ================================================================================


|


|class_summary| Classes Summary
===============================

================================================================================ ================================================================================
:ref:`lib.masked.ctrl.controlTypes`                                              
================================================================================ ================================================================================


|


.. toctree::
   :maxdepth: 1
   :hidden:

   lib.masked.ctrl.controlTypes





Functions
------------

.. function:: Ctrl( \*args, \*\*kwargs)

   Actually a factory function providing a unifying
   interface for generating masked controls.