NCBI C++ ToolKit
number_validator.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 #ifndef _NUMBER_VALIDATOR_H_
2 #define _NUMBER_VALIDATOR_H_
3 
4 /* $Id: number_validator.hpp 24602 2011-10-25 17:59:16Z katargir $
5  * ===========================================================================
6  *
7  * PUBLIC DOMAIN NOTICE
8  * National Center for Biotechnology Information
9  *
10  * This software/database is a "United States Government Work" under the
11  * terms of the United States Copyright Act. It was written as part of
12  * the author's official duties as a United States Government employee and
13  * thus cannot be copyrighted. This software/database is freely available
14  * to the public for use. The National Library of Medicine and the U.S.
15  * Government have not placed any restriction on its use or reproduction.
16  *
17  * Although all reasonable efforts have been taken to ensure the accuracy
18  * and reliability of the software and data, the NLM and the U.S.
19  * Government do not and cannot warrant the performance or results that
20  * may be obtained by using this software or data. The NLM and the U.S.
21  * Government disclaim all warranties, express or implied, including
22  * warranties of performance, merchantability or fitness for any particular
23  * purpose.
24  *
25  * Please cite the author in any work or product based on this material.
26  *
27  * ===========================================================================
28  *
29  * Authors: Roman Katargin
30  *
31  * File Description:
32  *
33  */
34 
35 #include <corelib/ncbistd.hpp>
36 
37 #include <gui/gui_export.h>
38 
39 #include <wx/valtext.h>
40 
42 
43 class NCBI_GUIWIDGETS_WX_EXPORT CNumberValidator : public wxTextValidator
44 {
45 public:
46  CNumberValidator(long* val_ptr,
47  long minVal = numeric_limits<long>::min(),
48  long maxVal = numeric_limits<long>::max(),
49  const char* szErrMsg = 0);
51  virtual ~CNumberValidator(){}
52 
53  // Make a clone of this validator (or return NULL) - currently necessary
54  // if you're passing a reference to a validator.
55  // Another possibility is to always pass a pointer to a new validator
56  // (so the calling code can use a copy constructor of the relevant class).
57  virtual wxObject *Clone() const { return new CNumberValidator(*this); }
58  bool Copy(const CNumberValidator& val);
59 
60  // Called when the value in the window must be validated.
61  // This function can pop up an error message.
62  virtual bool Validate(wxWindow *parent);
63 
64  // Called to transfer data to the window
65  virtual bool TransferToWindow();
66 
67  // Called to transfer data from the window
68  virtual bool TransferFromWindow();
69 
70 protected:
71  bool CheckValidator() const;
72 
73  long* m_ValPtr;
74  long m_MinVal;
75  long m_MaxVal;
76  wxString m_ErrMsg;
77 private:
79 };
80 
81 
83 {
84 public:
85  CNumberOrBlankValidator(long* val_ptr,
86  long minVal = numeric_limits<long>::min(),
87  long maxVal = numeric_limits<long>::max(),
88  const char* szErrMsg = 0);
91  // Make a clone of this validator (or return NULL) - currently necessary
92  // if you're passing a reference to a validator.
93  // Another possibility is to always pass a pointer to a new validator
94  // (so the calling code can use a copy constructor of the relevant class).
95  virtual wxObject *Clone() const { return new CNumberOrBlankValidator(*this); }
96 
97  // Called when the value in the window must be validated.
98  // This function can pop up an error message.
99  virtual bool Validate(wxWindow *parent);
100 
101  // Called to transfer data to the window
102  virtual bool TransferToWindow();
103 
104 private:
106 };
107 
109 
110 #endif // _NUMBER_VALIDATOR_H_
111 
virtual wxObject * Clone() const
CNumberValidator & operator=(const CNumberValidator &)
virtual ~CNumberValidator()
virtual wxObject * Clone() const
CNumberValidator & operator=(const CNumberValidator &)
Include a standard set of the NCBI C++ Toolkit most basic headers.
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
#define NCBI_GUIWIDGETS_WX_EXPORT
Definition: gui_export.h:543
Defines to provide correct exporting from DLLs in Windows.
T max(T x_, T y_)
T min(T x_, T y_)
Modified on Wed Feb 21 09:56:54 2024 by modify_doxy.py rev. 669887