KiCad PCB EDA Suite
Loading...
Searching...
No Matches
dialog_lib_new_symbol.cpp
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) 2009 Wayne Stambaugh <[email protected]>
5 * Copyright The 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
26
27#include <default_values.h>
28#include <eda_draw_frame.h>
29#include <sch_validators.h>
30#include <template_fieldnames.h>
31
32
33static wxString getDerivativeName( const wxString& aParentName )
34{
35 return wxString::Format( "%s_1", aParentName );
36}
37
38
40 const wxArrayString& aSymbolNames,
41 const wxString& aInheritFromSymbolName,
42 std::function<bool( const wxString& newName )> aValidator ) :
43 DIALOG_LIB_NEW_SYMBOL_BASE( dynamic_cast<wxWindow*>( aParent ) ),
46 m_validator( std::move( aValidator ) ),
47 m_inheritFromSymbolName( aInheritFromSymbolName ),
48 m_nameIsDefaulted( true )
49{
50 if( aSymbolNames.GetCount() )
51 {
52 wxArrayString unescapedNames;
53
54 for( const wxString& name : aSymbolNames )
55 unescapedNames.Add( UnescapeString( name ) );
56
57 m_comboInheritanceSelect->SetStringList( unescapedNames );
58 }
59
60 m_textName->SetValidator( FIELD_VALIDATOR( FIELD_T::VALUE ) );
62
64
65 m_comboInheritanceSelect->Connect( FILTERED_ITEM_SELECTED,
66 wxCommandEventHandler( DIALOG_LIB_NEW_SYMBOL::onParentSymbolSelect ),
67 nullptr, this );
68
69 m_textName->Bind( wxEVT_TEXT,
70 [this]( wxCommandEvent& aEvent )
71 {
72 m_nameIsDefaulted = false;
73 } );
74
75 m_checkTransferUserFields->Connect( wxEVT_CHECKBOX,
77 nullptr, this );
78
79 // Trigger the event handler to show/hide the info bar message.
80 wxCommandEvent dummyEvent;
81 onParentSymbolSelect( dummyEvent );
82
83 // Trigger the event handler to handle other check boxes
84 onPowerCheckBox( dummyEvent );
85 onCheckTransferUserFields( dummyEvent );
86
87 // initial focus should be on first editable field.
88 m_textName->SetFocus();
89
91
92 // Now all widgets have the size fixed, call FinishDialogSettings
94}
95
96
98{
99 m_comboInheritanceSelect->Disconnect( FILTERED_ITEM_SELECTED,
100 wxCommandEventHandler( DIALOG_LIB_NEW_SYMBOL::onParentSymbolSelect ),
101 nullptr, this );
102 m_checkTransferUserFields->Disconnect( wxEVT_CHECKBOX,
104 nullptr, this );
105}
106
107
109{
110 if( !m_inheritFromSymbolName.IsEmpty() )
111 {
114 }
115
116 return true;
117}
118
119
124
125
127{
128 const wxString parent = m_comboInheritanceSelect->GetValue();
129
130 if( !parent.IsEmpty() )
131 {
132 m_infoBar->RemoveAllButtons();
133 m_infoBar->ShowMessage( wxString::Format( _( "Deriving from symbol '%s'." ), UnescapeString( parent ) ),
134 wxICON_INFORMATION );
135 }
136 else
137 {
138 m_infoBar->Dismiss();
139 }
140
141 if( m_textName->IsEmpty() || m_nameIsDefaulted )
142 {
143 m_textName->SetValue( getDerivativeName( parent ) );
144 m_textName->SetInsertionPointEnd();
145 m_nameIsDefaulted = true;
146 }
147
148 syncControls( !parent.IsEmpty() );
149}
150
151
152void DIALOG_LIB_NEW_SYMBOL::syncControls( bool aIsDerivedPart )
153{
154 m_staticTextDes->Enable( !aIsDerivedPart );
155 m_textReference->Enable( !aIsDerivedPart );
156 m_staticTextUnits->Enable( !aIsDerivedPart );
157 m_spinPartCount->Enable( !aIsDerivedPart );
158 m_checkUnitsInterchangeable->Enable( !aIsDerivedPart );
159 m_checkHasAlternateBodyStyle->Enable( !aIsDerivedPart );
160 m_checkIsPowerSymbol->Enable( !aIsDerivedPart );
161 m_excludeFromBomCheckBox->Enable( !aIsDerivedPart );
162 m_excludeFromBoardCheckBox->Enable( !aIsDerivedPart );
163 m_staticPinTextPositionLabel->Enable( !aIsDerivedPart );
164 m_textPinTextPosition->Enable( !aIsDerivedPart );
165 m_staticPinTextPositionUnits->Enable( !aIsDerivedPart );
166
167 m_checkShowPinNumber->Enable( !aIsDerivedPart );
168 m_checkShowPinName->Enable( !aIsDerivedPart );
169 m_checkShowPinNameInside->Enable( !aIsDerivedPart );
170
171 m_checkKeepDatasheet->Enable( aIsDerivedPart );
172 m_checkKeepFootprint->Enable( aIsDerivedPart );
173 m_checkTransferUserFields->Enable( aIsDerivedPart );
174 m_checkKeepContentUserFields->Enable( aIsDerivedPart );
175}
176
177
178void DIALOG_LIB_NEW_SYMBOL::onPowerCheckBox( wxCommandEvent& aEvent )
179{
180 if( m_checkIsPowerSymbol->IsChecked() )
181 {
182 m_excludeFromBomCheckBox->SetValue( true );
183 m_excludeFromBoardCheckBox->SetValue( true );
184 m_excludeFromBomCheckBox->Enable( false );
185 m_excludeFromBoardCheckBox->Enable( false );
186 }
187 else
188 {
189 m_excludeFromBomCheckBox->Enable( true );
190 m_excludeFromBoardCheckBox->Enable( true );
191 }
192}
193
194
196{
197 bool checked = m_checkTransferUserFields->IsChecked();
198 m_checkKeepContentUserFields->Enable( checked );
199}
constexpr EDA_IU_SCALE schIUScale
Definition base_units.h:114
DIALOG_LIB_NEW_SYMBOL_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("New Symbol"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
SYMBOL_FILTER_COMBOBOX * m_comboInheritanceSelect
DIALOG_LIB_NEW_SYMBOL(EDA_DRAW_FRAME *aParent, const wxArrayString &aSymbolNames, const wxString &aInheritFromSymbolName, std::function< bool(const wxString &newName)> aValidator)
wxString GetName() const override
std::function< bool(const wxString &newName)> m_validator
void syncControls(bool aIsDerivedPart)
virtual void onCheckTransferUserFields(wxCommandEvent &aEvent) override
virtual void onPowerCheckBox(wxCommandEvent &aEvent) override
void onParentSymbolSelect(wxCommandEvent &aEvent)
void SetupStandardButtons(std::map< int, wxString > aLabels={})
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
The base class for create windows for drawing purpose.
A text control validator used for validating the text allowed in fields.
Definition validators.h:142
#define DEFAULT_PIN_NAME_OFFSET
The intersheets references prefix string.
static wxString getDerivativeName(const wxString &aParentName)
#define _(s)
STL namespace.
Definitions of control validators for schematic dialogs.
wxString UnescapeString(const wxString &aSource)
@ REFERENCE
Field Reference of part, i.e. "IC21".
@ VALUE
Field Value of part, i.e. "3.3K".