include/wx/validate.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/validate.h
   3 // Purpose:     wxValidator class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     29/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_VALIDATE_H_
  13 #define _WX_VALIDATE_H_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "validate.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_VALIDATORS
  22
  23 #include "wx/event.h"
  24
  25 class WXDLLEXPORT wxWindow;
  26 class WXDLLEXPORT wxWindowBase;
  27
  28 /*
  29  A validator has up to three purposes:
  30
  31  1) To validate the data in the window that's associated
  32     with the validator.
  33  2) To transfer data to and from the window.
  34  3) To filter input, using its role as a wxEvtHandler
  35     to intercept e.g. OnChar.
  36
  37  Note that wxValidator and derived classes use reference counting.
  38 */
  39
  40 class WXDLLEXPORT wxValidator : public wxEvtHandler
  41 {
  42 public:
  43     wxValidator();
  44     virtual ~wxValidator();
  45
  46     // Make a clone of this validator (or return NULL) - currently necessary
  47     // if you're passing a reference to a validator.
  48     // Another possibility is to always pass a pointer to a new validator
  49     // (so the calling code can use a copy constructor of the relevant class).
  50     virtual wxObject *Clone() const
  51         { return (wxValidator *)NULL; }
  52     bool Copy(const wxValidator& val)
  53         { m_validatorWindow = val.m_validatorWindow; return TRUE; }
  54
  55     // Called when the value in the window must be validated.
  56     // This function can pop up an error message.
  57     virtual bool Validate(wxWindow *WXUNUSED(parent)) { return FALSE; };
  58
  59     // Called to transfer data to the window
  60     virtual bool TransferToWindow() { return FALSE; }
  61
  62     // Called to transfer data from the window
  63     virtual bool TransferFromWindow() { return FALSE; };
  64
  65     // accessors
  66     wxWindow *GetWindow() const { return (wxWindow *)m_validatorWindow; }
  67     void SetWindow(wxWindowBase *win) { m_validatorWindow = win; }
  68
  69     // validators beep by default if invalid key is pressed, these functions
  70     // allow to change it
  71     static bool IsSilent() { return ms_isSilent; }
  72     static void SetBellOnError(bool doIt = TRUE) { ms_isSilent = doIt; }
  73
  74 protected:
  75     wxWindowBase *m_validatorWindow;
  76
  77 private:
  78     static bool ms_isSilent;
  79
  80     DECLARE_DYNAMIC_CLASS(wxValidator)
  81     DECLARE_NO_COPY_CLASS(wxValidator)
  82 };
  83
  84 WXDLLEXPORT_DATA(extern const wxValidator) wxDefaultValidator;
  85
  86 #define wxVALIDATOR_PARAM(val) val
  87
  88 #else // !wxUSE_VALIDATORS
  89     // wxWidgets is compiled without support for wxValidator, but we still
  90     // want to be able to pass wxDefaultValidator to the functions which take
  91     // a wxValidator parameter to avoid using "#if wxUSE_VALIDATORS"
  92     // everywhere
  93     class WXDLLEXPORT wxValidator;
  94     #define wxDefaultValidator (*((wxValidator *)NULL))
  95
  96     // this macro allows to avoid warnings about unused parameters when
  97     // wxUSE_VALIDATORS == 0
  98     #define wxVALIDATOR_PARAM(val)
  99 #endif // wxUSE_VALIDATORS/!wxUSE_VALIDATORS
 100
 101 #endif // _WX_VALIDATE_H_
 102