wxRTC: fixed guidelines overwriting adjacent cell borders; corrected capitalisation...

[wxWidgets.git] / include / wx / validate.h

diff --git a/include/wx/validate.h b/include/wx/validate.h
index 1cb97fe6049adecddd6e99f8973689059f9826d9..0adf3bf47780b432021bc1dcef50071c107989d6 100644 (file)
--- a/include/wx/validate.h
+++ b/include/wx/validate.h
@@ -1,24 +1,24 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        validate.h
+// Name:        wx/validate.h
 // Purpose:     wxValidator class
 // Author:      Julian Smart
 // Modified by:
 // Created:     29/01/98
-// RCS-ID:      $Id$
 // Copyright:   (c) 1998 Julian Smart
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef _WX_VALIDATEH__
-#define _WX_VALIDATEH__
+#ifndef _WX_VALIDATE_H_
+#define _WX_VALIDATE_H_
 
-#ifdef __GNUG__
-    #pragma interface "validate.h"
-#endif
+#include "wx/defs.h"
+
+#if wxUSE_VALIDATORS
 
 #include "wx/event.h"
 
-class WXDLLEXPORT wxWindow;
+class WXDLLIMPEXP_FWD_CORE wxWindow;
+class WXDLLIMPEXP_FWD_CORE wxWindowBase;
 
 /*
  A validator has up to three purposes:
@@ -32,50 +32,84 @@ class WXDLLEXPORT wxWindow;
  Note that wxValidator and derived classes use reference counting.
 */
 
-class WXDLLEXPORT wxValidator : public wxEvtHandler
+class WXDLLIMPEXP_CORE wxValidator : public wxEvtHandler
 {
 public:
     wxValidator();
-    ~wxValidator();
+    wxValidator(const wxValidator& other)
+        : wxEvtHandler()
+        , m_validatorWindow(other.m_validatorWindow)
+    {
+    }
+    virtual ~wxValidator();
 
     // Make a clone of this validator (or return NULL) - currently necessary
     // if you're passing a reference to a validator.
     // Another possibility is to always pass a pointer to a new validator
     // (so the calling code can use a copy constructor of the relevant class).
-    virtual wxValidator *Clone() const
-        { return (wxValidator *)NULL; }
+    virtual wxObject *Clone() const
+        { return NULL; }
     bool Copy(const wxValidator& val)
-        { m_validatorWindow = val.m_validatorWindow; return TRUE; }
+        { m_validatorWindow = val.m_validatorWindow; return true; }
 
     // Called when the value in the window must be validated.
     // This function can pop up an error message.
-    virtual bool Validate(wxWindow *WXUNUSED(parent)) { return FALSE; };
+    virtual bool Validate(wxWindow *WXUNUSED(parent)) { return false; }
 
     // Called to transfer data to the window
-    virtual bool TransferToWindow() { return FALSE; }
+    virtual bool TransferToWindow() { return false; }
 
     // Called to transfer data from the window
-    virtual bool TransferFromWindow() { return FALSE; };
+    virtual bool TransferFromWindow() { return false; }
 
     // accessors
-    wxWindow *GetWindow() const { return m_validatorWindow; }
-    void SetWindow(wxWindow *win) { m_validatorWindow = win; }
+    wxWindow *GetWindow() const { return (wxWindow *)m_validatorWindow; }
+    void SetWindow(wxWindowBase *win) { m_validatorWindow = win; }
+
+    // validators beep by default if invalid key is pressed, this function
+    // allows to change this
+    static void SuppressBellOnError(bool suppress = true)
+        { ms_isSilent = suppress; }
 
-    // validators beep by default if invalid key is pressed, these functions
-    // allow to change it
+    // test if beep is currently disabled
     static bool IsSilent() { return ms_isSilent; }
-    static void SetBellOnError(bool doIt = TRUE) { ms_isSilent = doIt; }
+
+    // this function is deprecated because it handled its parameter
+    // unnaturally: it disabled the bell when it was true, not false as could
+    // be expected; use SuppressBellOnError() instead
+#if WXWIN_COMPATIBILITY_2_8
+    static wxDEPRECATED_INLINE(
+        void SetBellOnError(bool doIt = true),
+        ms_isSilent = doIt;
+    )
+#endif
 
 protected:
-    wxWindow *m_validatorWindow;
+    wxWindowBase *m_validatorWindow;
 
 private:
     static bool ms_isSilent;
 
     DECLARE_DYNAMIC_CLASS(wxValidator)
+    wxDECLARE_NO_ASSIGN_CLASS(wxValidator);
 };
 
-WXDLLEXPORT_DATA(extern const wxValidator) wxDefaultValidator;
+extern WXDLLIMPEXP_DATA_CORE(const wxValidator) wxDefaultValidator;
+
+#define wxVALIDATOR_PARAM(val) val
+
+#else // !wxUSE_VALIDATORS
+    // wxWidgets is compiled without support for wxValidator, but we still
+    // want to be able to pass wxDefaultValidator to the functions which take
+    // a wxValidator parameter to avoid using "#if wxUSE_VALIDATORS"
+    // everywhere
+    class WXDLLIMPEXP_FWD_CORE wxValidator;
+    #define wxDefaultValidator (*reinterpret_cast<wxValidator*>(NULL))
+
+    // this macro allows to avoid warnings about unused parameters when
+    // wxUSE_VALIDATORS == 0
+    #define wxVALIDATOR_PARAM(val)
+#endif // wxUSE_VALIDATORS/!wxUSE_VALIDATORS
+
+#endif // _WX_VALIDATE_H_
 
-#endif
-    // _WX_VALIDATEH__