summaryrefslogtreecommitdiff
path: root/eeschema/sch_validators.h
diff options
context:
space:
mode:
Diffstat (limited to 'eeschema/sch_validators.h')
-rw-r--r--eeschema/sch_validators.h72
1 files changed, 72 insertions, 0 deletions
diff --git a/eeschema/sch_validators.h b/eeschema/sch_validators.h
new file mode 100644
index 0000000..6c34060
--- /dev/null
+++ b/eeschema/sch_validators.h
@@ -0,0 +1,72 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2016 Wayne Stambaugh, stambaughw@gmail.com
+ * Copyright (C) 2016 KiCad Developers, see change_log.txt for contributors.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, you may find one here:
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ * or you may search the http://www.gnu.org website for the version 2 license,
+ * or you may write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+/**
+ * @file sch_validators.h
+ * @brief Defintions of control validators for schematic dialogs.
+ */
+
+#ifndef _SCH_VALIDATORS_H_
+#define _SCH_VALIDATORS_H_
+
+
+#include <wx/valtext.h>
+
+/**
+ * class SCH_FILED_VALIDATOR
+ *
+ * is the text control validator used for validating the text allowed in library and
+ * schematic component fields.
+ * Note
+ * Reference field does not accept spaces
+ * Value field does not accept spaces in Component Library Editor, because in .lib component
+ * libraries, the value field is the component name in lib, and spaces are not allowed
+ * in component names in lib
+ */
+class SCH_FIELD_VALIDATOR : public wxTextValidator
+{
+ int m_fieldId;
+ bool m_isLibEditor;
+
+public:
+ SCH_FIELD_VALIDATOR( bool aIsCmplibEditor, int aFieldId, wxString* aValue = NULL );
+
+ SCH_FIELD_VALIDATOR( const SCH_FIELD_VALIDATOR& aValidator );
+
+ virtual wxObject* Clone() const { return new SCH_FIELD_VALIDATOR( *this ); }
+
+ /**
+ * Function Validate
+ *
+ * overrides the default Validate() function provided by wxTextValidate to provide
+ * better error messages.
+ *
+ * @param aParent - a pointer to the parent window of the error message dialog.
+ * @return true if the text in the control is valid otherwise false.
+ */
+ virtual bool Validate( wxWindow *aParent );
+};
+
+
+#endif // _SCH_VALIDATORS_H_