109 lines
3.5 KiB
C++
109 lines
3.5 KiB
C++
/*
|
|
* 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-2019 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 Definitions of control validators for schematic dialogs.
|
|
*/
|
|
|
|
#ifndef _SCH_VALIDATORS_H_
|
|
#define _SCH_VALIDATORS_H_
|
|
|
|
#include <wx/valtext.h>
|
|
|
|
|
|
#define FIELD_NAME -1
|
|
#define FIELD_VALUE -2
|
|
|
|
#define SHEETNAME_V 100 // We can't use SHEETNAME and SHEETFILENAME because they
|
|
#define SHEETFILENAME_V 101 // overlap with REFERENCE and VALUE
|
|
#define SHEETUSERFIELD_V 102
|
|
|
|
/**
|
|
* A text control validator used for validating the text allowed in library and
|
|
* schematic component fields.
|
|
*
|
|
* - The reference field does not accept spaces.
|
|
* - The value field does not accept spaces in the symbol library editor because in symbol
|
|
* libraries, the value field is the symbol name in the library.
|
|
*/
|
|
class SCH_FIELD_VALIDATOR : public wxTextValidator
|
|
{
|
|
int m_fieldId;
|
|
bool m_isLibEditor;
|
|
|
|
public:
|
|
SCH_FIELD_VALIDATOR( bool aIsLibEditor, int aFieldId, wxString* aValue = NULL );
|
|
|
|
SCH_FIELD_VALIDATOR( const SCH_FIELD_VALIDATOR& aValidator );
|
|
|
|
virtual wxObject* Clone() const override { return new SCH_FIELD_VALIDATOR( *this ); }
|
|
|
|
/**
|
|
* Override the default Validate() function provided by wxTextValidator 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 ) override;
|
|
};
|
|
|
|
|
|
class SCH_NETNAME_VALIDATOR : public wxValidator
|
|
{
|
|
public:
|
|
SCH_NETNAME_VALIDATOR( wxString *aVal = nullptr );
|
|
|
|
SCH_NETNAME_VALIDATOR( bool aAllowSpaces );
|
|
|
|
SCH_NETNAME_VALIDATOR( const SCH_NETNAME_VALIDATOR& aValidator );
|
|
|
|
void SetAllowSpaces( bool aAllowSpaces = true ) { m_allowSpaces = aAllowSpaces; }
|
|
|
|
bool GetAllowSpaces() const { return m_allowSpaces; }
|
|
|
|
bool Copy( const SCH_NETNAME_VALIDATOR& val );
|
|
|
|
virtual wxObject* Clone() const override { return new SCH_NETNAME_VALIDATOR( *this ); }
|
|
|
|
virtual bool TransferToWindow() override { return true; }
|
|
|
|
virtual bool TransferFromWindow() override { return true; }
|
|
|
|
wxTextEntry* GetTextEntry();
|
|
|
|
virtual bool Validate( wxWindow *aParent ) override;
|
|
|
|
protected:
|
|
|
|
// returns the error message if the contents of 'val' are invalid
|
|
virtual wxString IsValid( const wxString& aVal ) const;
|
|
|
|
private:
|
|
bool m_allowSpaces;
|
|
};
|
|
|
|
#endif // _SCH_VALIDATORS_H_
|