KiCad PCB EDA Suite
sch_validators.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2016 Wayne Stambaugh, stambaughw@gmail.com
5  * Copyright (C) 2016-2019 KiCad Developers, see change_log.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
30 #ifndef _SCH_VALIDATORS_H_
31 #define _SCH_VALIDATORS_H_
32 
33 #include <wx/valtext.h>
34 #include <validators.h>
35 
36 #define FIELD_NAME -1
37 #define FIELD_VALUE -2
38 
39 #define SHEETNAME_V 100 // We can't use SHEETNAME and SHEETFILENAME because they
40 #define SHEETFILENAME_V 101 // overlap with REFERENCE and VALUE
41 #define SHEETUSERFIELD_V 102
42 
51 class SCH_FIELD_VALIDATOR : public wxTextValidator
52 {
53  int m_fieldId;
55 
56 public:
57  SCH_FIELD_VALIDATOR( bool aIsLibEditor, int aFieldId, wxString* aValue = NULL );
58 
59  SCH_FIELD_VALIDATOR( const SCH_FIELD_VALIDATOR& aValidator );
60 
61  virtual wxObject* Clone() const override { return new SCH_FIELD_VALIDATOR( *this ); }
62 
70  virtual bool Validate( wxWindow *aParent ) override;
71 };
72 
73 
74 /*
75  * A refinement of the NETNAME_VALIDATOR which also allows (and checks) bus definitions.
76  */
78 {
79 public:
80  SCH_NETNAME_VALIDATOR( wxString *aVal = nullptr ) :
81  NETNAME_VALIDATOR( aVal )
82  { }
83 
84  SCH_NETNAME_VALIDATOR( bool aAllowSpaces ) :
85  NETNAME_VALIDATOR( aAllowSpaces )
86  { }
87 
89  NETNAME_VALIDATOR( aValidator )
90  { }
91 
92 protected:
93  // returns the error message if the contents of 'val' are invalid
94  wxString IsValid( const wxString& aVal ) const override;
95 };
96 
97 #endif // _SCH_VALIDATORS_H_
SCH_NETNAME_VALIDATOR(const SCH_NETNAME_VALIDATOR &aValidator)
SCH_NETNAME_VALIDATOR(bool aAllowSpaces)
virtual wxObject * Clone() const override
SCH_NETNAME_VALIDATOR(wxString *aVal=nullptr)
wxString IsValid(const wxString &aVal) const override
#define NULL
SCH_FIELD_VALIDATOR(bool aIsLibEditor, int aFieldId, wxString *aValue=NULL)
A text control validator used for validating the text allowed in library and schematic component fiel...
virtual bool Validate(wxWindow *aParent) override
Override the default Validate() function provided by wxTextValidator to provide better error messages...
Custom text control validator definitions.