cleanup - added whitespace around operators, some blank lines, fixed comment typos...

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

diff --git a/include/wx/validate.h b/include/wx/validate.h
index deb5d79856199431c43c81d06d9062c296af5015..f45efe137616dd7ffc6d14f7cea78af5c6addb88 100644 (file)
--- a/include/wx/validate.h
+++ b/include/wx/validate.h
@@ -1,24 +1,25 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// 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
 // 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;
 
 #include "wx/event.h"
 
 class WXDLLEXPORT wxWindow;

+class WXDLLEXPORT wxWindowBase;

 
 /*
  A validator has up to three purposes:
 
 /*
  A validator has up to three purposes:


@@ -30,41 +31,68 @@ class WXDLLEXPORT wxWindow;
     to intercept e.g. OnChar.
 
  Note that wxValidator and derived classes use reference counting.
     to intercept e.g. OnChar.
 
  Note that wxValidator and derived classes use reference counting.

- */
+*/

 
 

-class WXDLLEXPORT wxValidator: public wxEvtHandler
+class WXDLLEXPORT wxValidator : public wxEvtHandler

 {
 {

-DECLARE_DYNAMIC_CLASS(wxValidator)

 public:
 public:

-  wxValidator(void);
-  ~wxValidator();
+    wxValidator();
+    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 wxObject *Clone() const
+        { return (wxValidator *)NULL; }
+    bool Copy(const wxValidator& val)
+        { m_validatorWindow = val.m_validatorWindow; return true; }

 
 

-  // 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(void) const { return NULL; }
-  inline bool Copy(const wxValidator& val) { 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; };

 
 

-  // 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; };
+    // Called to transfer data to the window
+    virtual bool TransferToWindow() { return false; }

 
 

-  // Called to transfer data to the window
-  virtual bool TransferToWindow(void) { return FALSE; }
+    // Called to transfer data from the window
+    virtual bool TransferFromWindow() { return false; };

 
 

-  // Called to transfer data from the window
-  virtual bool TransferFromWindow(void) { return FALSE; };
+    // accessors
+    wxWindow *GetWindow() const { return (wxWindow *)m_validatorWindow; }
+    void SetWindow(wxWindowBase *win) { m_validatorWindow = win; }

 
 

-  // ACCESSORS
-  inline wxWindow *GetWindow(void) const { return m_validatorWindow; }
-  inline void SetWindow(wxWindow *win) { m_validatorWindow = win; }
+    // validators beep by default if invalid key is pressed, these functions
+    // allow to change it
+    static bool IsSilent() { return ms_isSilent; }
+    static void SetBellOnError(bool doIt = true) { ms_isSilent = doIt; }

 
 protected:
 
 protected:

-    wxWindow *m_validatorWindow;
+    wxWindowBase *m_validatorWindow;
+
+private:
+    static bool ms_isSilent;
+
+    DECLARE_DYNAMIC_CLASS(wxValidator)
+    DECLARE_NO_COPY_CLASS(wxValidator)

 };
 
 };
 

-WXDLLEXPORT_DATA(extern const wxValidator) wxDefaultValidator;
+extern WXDLLEXPORT_DATA(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 WXDLLEXPORT wxValidator;
+    #define wxDefaultValidator (*((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__