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, [email protected]
5 * Copyright (C) 2016-2021 KiCad Developers, see AUTHORS.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_FIELD and VALUE_FIELD
41#define SHEETUSERFIELD_V 102
42
43#define LABELUSERFIELD_V 200
44
53class SCH_FIELD_VALIDATOR : public wxTextValidator
54{
55public:
56 SCH_FIELD_VALIDATOR( bool aIsLibEditor, int aFieldId, wxString* aValue = nullptr );
57
58 SCH_FIELD_VALIDATOR( const SCH_FIELD_VALIDATOR& aValidator );
59
60 virtual wxObject* Clone() const override { return new SCH_FIELD_VALIDATOR( *this ); }
61
69 virtual bool Validate( wxWindow *aParent ) override;
70
71private:
74};
75
76
77/*
78 * A refinement of the NETNAME_VALIDATOR which also allows (and checks) bus definitions.
79 */
81{
82public:
83 SCH_NETNAME_VALIDATOR( wxString* aVal = nullptr ) :
84 NETNAME_VALIDATOR( aVal )
85 { }
86
87 SCH_NETNAME_VALIDATOR( bool aAllowSpaces ) :
88 NETNAME_VALIDATOR( aAllowSpaces )
89 { }
90
92 NETNAME_VALIDATOR( aValidator )
93 { }
94
95 virtual wxObject* Clone() const override { return new SCH_NETNAME_VALIDATOR( *this ); }
96
97protected:
99 wxString IsValid( const wxString& aVal ) const override;
100
101private:
102 static wxRegEx m_busGroupRegex;
103};
104
105#endif // _SCH_VALIDATORS_H_
A text control validator used for validating the text allowed in library and schematic symbol fields.
SCH_FIELD_VALIDATOR(bool aIsLibEditor, int aFieldId, wxString *aValue=nullptr)
virtual bool Validate(wxWindow *aParent) override
Override the default Validate() function provided by wxTextValidator to provide better error messages...
virtual wxObject * Clone() const override
static wxRegEx m_busGroupRegex
virtual wxObject * Clone() const override
SCH_NETNAME_VALIDATOR(bool aAllowSpaces)
SCH_NETNAME_VALIDATOR(const SCH_NETNAME_VALIDATOR &aValidator)
wxString IsValid(const wxString &aVal) const override
SCH_NETNAME_VALIDATOR(wxString *aVal=nullptr)
Custom text control validator definitions.