X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/34138703c3997ce676a1e713d9ff9eb020640da7..2a45803fc3877afd0ae3ce356dfe216505165882:/include/wx/validate.h diff --git a/include/wx/validate.h b/include/wx/validate.h index deb5d79856..e79a3becb5 100644 --- 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 -// 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: @@ -30,41 +31,86 @@ class WXDLLEXPORT wxWindow; to intercept e.g. OnChar. Note that wxValidator and derived classes use reference counting. - */ +*/ -class WXDLLEXPORT wxValidator: public wxEvtHandler +class WXDLLIMPEXP_CORE wxValidator : public wxEvtHandler { -DECLARE_DYNAMIC_CLASS(wxValidator) public: - wxValidator(void); - ~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 wxObject *Clone() const + { return NULL; } + 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 to transfer data to the window + virtual bool TransferToWindow() { return false; } + + // Called to transfer data from the window + virtual bool TransferFromWindow() { return false; } + + // accessors + 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; } + + // test if beep is currently disabled + static bool IsSilent() { return ms_isSilent; } + + // 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 - // 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; } +protected: + wxWindowBase *m_validatorWindow; - // 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; }; +private: + static bool ms_isSilent; - // Called to transfer data to the window - virtual bool TransferToWindow(void) { return FALSE; } + DECLARE_DYNAMIC_CLASS(wxValidator) + wxDECLARE_NO_ASSIGN_CLASS(wxValidator); +}; - // Called to transfer data from the window - virtual bool TransferFromWindow(void) { return FALSE; }; +extern WXDLLIMPEXP_DATA_CORE(const wxValidator) wxDefaultValidator; - // ACCESSORS - inline wxWindow *GetWindow(void) const { return m_validatorWindow; } - inline void SetWindow(wxWindow *win) { m_validatorWindow = win; } +#define wxVALIDATOR_PARAM(val) val -protected: - wxWindow *m_validatorWindow; -}; +#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(NULL)) -WXDLLEXPORT_DATA(extern const wxValidator) wxDefaultValidator; + // 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__