.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.masked.ipaddrctrl
.. highlight:: python
.. _wx.lib.masked.ipaddrctrl.IpAddrCtrl:
==========================================================================================================================================
|phoenix_title| **wx.lib.masked.ipaddrctrl.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| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
IpAddrCtrl:
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.masked.ipaddrctrl.IpAddrCtrlAccessorsMixin`, :class:`wx.lib.masked.textctrl.BaseMaskedTextCtrl`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.masked.ipaddrctrl.IpAddrCtrl.__init__` Default class constructor.
:meth:`~wx.lib.masked.ipaddrctrl.IpAddrCtrl.GetAddress` Returns the control value, with any spaces removed.
:meth:`~wx.lib.masked.ipaddrctrl.IpAddrCtrl.OnDot` Defines what action to take when the '.' character is typed in the
:meth:`~wx.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 = wx.DefaultPosition, size = wx.DefaultSize, style = wx.TE_PROCESS_TAB, validator = wx.DefaultValidator, name = 'IpAddrCtrl', setupEventHandling = True, \*\*kwargs)
Default class constructor.
:param wx.Window `parent`: the window parent. Must not be ``None``;
:param integer `id`: window identifier. A value of -1 indicates a default value;
:param string `value`: value to be shown;
:param `pos`: the control position. A value of (-1, -1) indicates a default position,
chosen by either the windowing system or wxPython, depending on platform;
:type `pos`: tuple or :class:`wx.Point`
:param `size`: the control size. A value of (-1, -1) indicates a default size,
chosen by either the windowing system or wxPython, depending on platform;
:param integer `style`: the window style;
:param wx.Validator `validator`: this is mainly provided for data-transfer, as control does
its own validation;
:param string `name`: the window name;
:param boolean `setupEventHandling`: setup event handling by default.
.. 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.
:param string `value`: the IP address in the form '000.000.000.000'