interface/validate.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        validate.h
   3 // Purpose:     interface of wxValidator
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxValidator
  11     @wxheader{validate.h}
  12
  13     wxValidator is the base class for a family of validator classes that
  14     mediate between a class of control, and application data.
  15
  16     A validator has three major roles:
  17
  18     -#  To transfer data from a C++ variable or own storage to and from a
  19         control.
  20     -#  To validate data in a control, and show an appropriate error message.
  21     -#  To filter events (such as keystrokes), thereby changing the behaviour
  22         of the associated control.
  23
  24     Validators can be plugged into controls dynamically.
  25
  26     To specify a default, "null" validator, use ::wxDefaultValidator.
  27
  28     For more information, please see @ref overview_validator.
  29
  30     @beginWxPythonOnly
  31     If you wish to create a validator class in wxPython you should derive the
  32     class from @c wxPyValidator in order to get Python-aware capabilities for
  33     the various virtual methods.
  34     @endWxPythonOnly
  35
  36     @library{wxcore}
  37     @category{validator}
  38
  39     @stdobjects
  40     ::wxDefaultValidator
  41
  42     @see @ref overview_validator, wxTextValidator, wxGenericValidator
  43 */
  44 class wxValidator : public wxEvtHandler
  45 {
  46 public:
  47     /**
  48         Constructor.
  49     */
  50     wxValidator();
  51
  52     /**
  53         Destructor.
  54     */
  55     ~wxValidator();
  56
  57     /**
  58         All validator classes must implement the Clone() function, which
  59         returns an identical copy of itself.
  60
  61         This is because validators are passed to control constructors as
  62         references which must be copied. Unlike objects such as pens and
  63         brushes, it does not make sense to have a reference counting scheme to
  64         do this cloning because all validators should have separate data.
  65
  66         @return This base function returns @NULL.
  67     */
  68     virtual wxObject* Clone() const;
  69
  70     /**
  71         Returns the window associated with the validator.
  72     */
  73     wxWindow* GetWindow() const;
  74
  75     /**
  76         This functions switches on or turns off the error sound produced by the
  77         validators if an invalid key is pressed.
  78     */
  79     void SetBellOnError(bool doIt = true);
  80
  81     /**
  82         Associates a window with the validator.
  83     */
  84     void SetWindow(wxWindow* window);
  85
  86     /**
  87         This overridable function is called when the value in the window must
  88         be transferred to the validator.
  89
  90         @return @false if there is a problem.
  91     */
  92     virtual bool TransferFromWindow();
  93
  94     /**
  95         This overridable function is called when the value associated with the
  96         validator must be transferred to the window.
  97
  98         @return @false if there is a problem.
  99     */
 100     virtual bool TransferToWindow();
 101
 102     /**
 103         This overridable function is called when the value in the associated
 104         window must be validated.
 105
 106         @return @false if the value in the window is not valid; you may pop up
 107                 an error dialog.
 108     */
 109     virtual bool Validate(wxWindow* parent);
 110 };
 111
 112 /**
 113     An empty, "null" wxValidator instance.
 114 */
 115 wxValidator wxDefaultValidator;
 116