.. include:: headings.inc

.. currentmodule:: lib.masked.ipaddrctrl

.. highlight:: python



.. _lib.masked.ipaddrctrl.IpAddrCtrl:

==========================================================================================================================================
|phoenix_title|  **IpAddrCtrl**
==========================================================================================================================================

This class is a particular type of MaskedTextCtrl that accepts
and understands the semantics of IP addresses, reformats input
as you move from field to field, and accepts '.' as a navigation
character, so that typing an IP address can be done naturally.



|

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

Inheritance diagram for class **IpAddrCtrl**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.masked.ipaddrctrl.IpAddrCtrl_inheritance.png" alt="Inheritance diagram of IpAddrCtrl" 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="node17" href="lib.masked.textctrl.BaseMaskedTextCtrl.html" title="This is the primary derivation from MaskedEditMixin.  It provides" alt="" coords="1235,58,1453,89"/> <area shape="rect" id="node12" href="TextEntry.html" title="Common base class for single line text entry fields." alt="" coords="621,137,712,167"/> <area shape="rect" id="node27" href="lib.masked.ipaddrctrl.IpAddrCtrl.html" title="This class is a particular type of MaskedTextCtrl that accepts" alt="" coords="1535,31,1703,62"/> <area shape="rect" id="node18" href="TextCtrl.html" title="A text control allows text to be displayed and edited." alt="" coords="1001,85,1076,115"/> <area shape="rect" id="node21" href="lib.masked.ipaddrctrl.IpAddrCtrlAccessorsMixin.html" title="Defines IpAddrCtrl's list of attributes having their own" alt="" coords="1203,5,1485,35"/> </map> 
   </p>

|


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

:class:`lib.masked.ipaddrctrl.IpAddrCtrlAccessorsMixin`, :class:`lib.masked.textctrl.BaseMaskedTextCtrl`

|


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

================================================================================ ================================================================================
:meth:`~lib.masked.ipaddrctrl.IpAddrCtrl.__init__`                               
:meth:`~lib.masked.ipaddrctrl.IpAddrCtrl.GetAddress`                             Returns the control value, with any spaces removed.
:meth:`~lib.masked.ipaddrctrl.IpAddrCtrl.OnDot`                                  Defines what action to take when the '.' character is typed in the
:meth:`~lib.masked.ipaddrctrl.IpAddrCtrl.SetValue`                               Takes a string value, validates it for a valid IP address,
================================================================================ ================================================================================


|


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

.. class:: IpAddrCtrl( BaseMaskedTextCtrl, IpAddrCtrlAccessorsMixin )

   This class is a particular type of MaskedTextCtrl that accepts
   and understands the semantics of IP addresses, reformats input
   as you move from field to field, and accepts '.' as a navigation
   character, so that typing an IP address can be done naturally.

   .. method:: __init__( self, parent, id=-1, value = '', pos = DefaultPosition, size = DefaultSize, style = TE_PROCESS_TAB, validator = DefaultValidator, name = 'IpAddrCtrl', setupEventHandling = True, \*\*kwargs)


   .. method:: GetAddress(self)

      Returns the control value, with any spaces removed.


   .. method:: OnDot(self, event)

      Defines what action to take when the '.' character is typed in the
      control.  By default, the current field is right-justified, and the
      cursor is placed in the next field.


   .. method:: SetValue(self, value)

      Takes a string value, validates it for a valid IP address,
      splits it into an array of 4 fields, justifies it
      appropriately, and inserts it into the control.
      Invalid values will raise a ValueError exception.