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

Inheritance diagram of IpAddrCtrl


super_classes Known Superclasses

wx.lib.masked.ipaddrctrl.IpAddrCtrlAccessorsMixin, wx.lib.masked.textctrl.BaseMaskedTextCtrl


method_summary Methods Summary

__init__

Default class constructor.

GetAddress

Returns the control value, with any spaces removed.

OnDot

Defines what action to take when the ‘.’ character is typed in the

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.


Methods

__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.

Parameters:

  • parent (wx.Window) – the window parent. Must not be None;

  • id (integer) – window identifier. A value of -1 indicates a default value;

  • value (string) – value to be shown;

  • pos (tuple or wx.Point) – the control position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform;

  • size – the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform;

  • style (integer) – the window style;

  • validator (wx.Validator) – this is mainly provided for data-transfer, as control does its own validation;

  • name (string) – the window name;

  • setupEventHandling (boolean) – setup event handling by default.


GetAddress(self)

Returns the control value, with any spaces removed.


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.


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.

Parameters:

value (string) – the IP address in the form ‘000.000.000.000’