************
wx.Validator
************

Inheritance diagram for `wx.Validator`:

|

.. inheritance-diagram:: wx.Validator

|

Description
===========

`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:

1. To transfer data from a C++ variable or own storage to and from a control;
2. To validate data in a control, and show an appropriate error message;
3. To filter events (such as keystrokes), thereby changing the behaviour of the associated control.

Validators can be plugged into controls dynamically.

To specify a default, 'null' validator, use the symbol `wx.DefaultValidator`.

.. note:: **wx.Python note:** If you wish to create a validator class in wxPython you should derive the class from `wx.PyValidator <wx.PyValidator.html>`_ 
   in order to get Python-aware capabilities for the various virtual methods.


Derived From
^^^^^^^^^^^^^

* `wx.EvtHandler <wx.EvtHandler.html>`_ 
* `wx.Object <wx.Object.html>`_ 


Known Subclasses
^^^^^^^^^^^^^^^^

`wx.PyValidator <wx.PyValidator.html>`_


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `Clone <#Clone>`_ 
* `GetWindow <#GetWindow>`_ 
* `IsSilent <#IsSilent>`_ 
* `SetBellOnError <#SetBellOnError>`_ 
* `SetWindow <#SetWindow>`_ 
* `TransferFromWindow <#TransferFromWindow>`_ 
* `TransferToWindow <#TransferToWindow>`_ 
* `Validate <#Validate>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `Window <#Window>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__()

   `No docstrings found for this method.` 

--------


.. method:: Clone()

   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.

   |

   **Returns:**

   `wx.Validator <wx.Validator.html>`_
 

--------

.. method:: GetWindow()

   Returns the window associated with the validator.

   |

   **Returns:**

   `wx.Window <wx.Window.html>`_
 

--------

.. method:: IsSilent()

   `No docstrings found for this method.` 

--------


.. method:: SetBellOnError(doIt=True)

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

   **Parameters:**

   * `doIt` (bool) 


--------

.. method:: SetWindow(window)

   Associates a window with the validator.

   **Parameters:**

   * `window` (`wx.Window <wx.Window.html>`_) 

--------

.. method:: TransferFromWindow()

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

   Return ``False`` if there is a problem.

   |

   **Returns:**

   `bool` 

--------

.. method:: TransferToWindow()

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

   Return ``False`` if there is a problem.

   |

   **Returns:**

   `bool` 

--------

.. method:: Validate(parent)

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

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

   **Parameters:**

   * `parent` (`wx.Window <wx.Window.html>`_) 

   |  

   **Returns:**

   `bool` 

--------

Properties
^^^^^^^^^^

.. attribute:: Window

   See `GetWindow <#GetWindow>`_  and `SetWindow <#SetWindow>`_