.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxValidator 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxValidator \- 
  Base validator class
 
.SH DESCRIPTION

  


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


   
    to transfer data from a C++ variable or own storage to and from a control;
     
    to validate data in a control, and show an appropriate error message;
     
    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
   
    wxDefaultValidator
   
   .
  
  


   For more information, please see
   Validator overview
   .
  
 
.SH "PARENTS"

  wxEvtHandler
   
  wxObject
 
.SH "INCLUDE FILES"
wx/validate.h
.SH MEMBERS

  
.SS  wxValidator ()

     


      Constructor.
     
    
   
  
.SS  ~wxValidator ()

     


      Destructor.
     
    
   
  
.SS virtual wxObject* 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.
     
     


      This base function returns NULL.
     
    
   
  
.SS wxWindow* GetWindow ()

     


      Returns the window associated with the validator.
     
    
   
  
.SS void SetBellOnError (bool doIt = true)

     


      This functions switches on or turns off the error sound produced by the
      validators if an invalid key is pressed.
     
    
   
  
.SS void SetWindow (wxWindow* window)

     


      Associates a window with the validator.
     
    
   
  
.SS virtual bool TransferToWindow ()

     


      This overridable function is called when the value in the window must be
      transferred to the validator. Return false if there is a problem.
     
    
   
  
.SS virtual bool 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.
     
    
   
  
.SS virtual bool Validate (wxWindow* 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.
     
    
 
.SH "SEE ALSO"

  wxEvtHandler
   
  wxObject
 
  Validator overview
   
  wxTextValidator
   
  wxGenericValidator
  ,
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.