A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://wxpython.org/Phoenix/docs/html/wx.Validator.html below:

wx.Validator — wxPython Phoenix 4.2.4a1 documentation

wx.Validator¶

wx.Validator is the base class for a family of validator classes that mediate between a class of control, and application data.

A validator has three major roles:

Validators can be plugged into controls dynamically.

To specify a default, “null” validator, use wx.DefaultValidator .

For more information, please see Validator Overview.

See also

Validator Overview, TextValidator , GenericValidator , IntegerValidator , FloatingPointValidator

Class Hierarchy¶

Inheritance diagram for class

Validator

:

Known Subclasses¶

GenericValidator , NumValidator , TextValidator

Methods Summary¶

__init__

Constructor.

Clone

All validator classes must implement the Clone function, which returns an identical copy of itself.

GetWindow

Returns the window associated with the validator.

IsSilent

Returns if the error sound is currently disabled.

SetWindow

Associates a window with the validator.

SuppressBellOnError

This functions switches on or turns off the error sound produced by the validators if an invalid key is pressed.

TransferFromWindow

This overridable function is called when the value in the window must be transferred to the validator.

TransferToWindow

This overridable function is called when the value associated with the validator must be transferred to the window.

Validate

This overridable function is called when the value in the associated window must be validated.

Properties Summary¶ Class API¶
class wx.Validator(EvtHandler)¶

Possible constructors:

Validator is the base class for a family of validator classes that mediate between a class of control, and application data.


Methods¶
__init__(self)¶

Constructor.

Return type:

None


Clone(self)¶

All validator classes must implement the Clone function, which returns an identical copy of itself.

This is because validators are passed to control constructors as references which must be copied. Unlike objects such as pens and brushes, it does not make sense to have a reference counting scheme to do this cloning because all validators should have separate data.

Return type:

wx.Object

Returns:

This base function returns None.


GetWindow(self)¶

Returns the window associated with the validator.

Return type:

wx.Window


static IsSilent()¶

Returns if the error sound is currently disabled.

Return type:

bool


SetWindow(self, window)¶

Associates a window with the validator.

This function is automatically called by wxWidgets when creating a Window-derived class instance which takes a wx.Validator reference. Since wxWidgets 3.1.1, it can be overridden in custom validators in order to perform any one-time initialization or checks of the window when the validator is associated with it.

E.g.

wx.TextCtrl(self, wx.ID_ANY, u'', wx.DefaultPosition, wx.DefaultSize, 0,
            validator=MyValidator())

will automatically link the TextValidator instance with the wx.TextCtrl instance and call SetWindow method on the TextValidator object.

Parameters:

window (wx.Window)

Return type:

None


static SuppressBellOnError(suppress=True)¶

This functions switches on or turns off the error sound produced by the validators if an invalid key is pressed.

Parameters:

suppress (bool) – If True, error sound is not played when a validator detects an error. If False, error sound is enabled.

Return type:

None

Added in version 2.9.1.


TransferFromWindow(self)¶

This overridable function is called when the value in the window must be transferred to the validator.

Return type:

bool

Returns:

False if there is a problem.


TransferToWindow(self)¶

This overridable function is called when the value associated with the validator must be transferred to the window.

Return type:

bool

Returns:

False if there is a problem.


Validate(self, parent)¶

This overridable function is called when the value in the associated window must be validated.

Parameters:

parent (wx.Window) – The parent of the window associated with the validator.

Return type:

bool

Returns:

False if the value in the window is not valid; you may pop up an error dialog.


Properties¶
Window¶

See GetWindow and SetWindow


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4