KiCad PCB EDA Suite
Loading...
Searching...
No Matches
dialog_schematic_setup.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) 2020-2023 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or (at your
9 * option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#include <confirm.h>
21#include <sch_edit_frame.h>
22#include <schematic.h>
23#include <kiface_base.h>
29#include <panel_setup_pinmap.h>
30#include <erc/erc_item.h>
32#include <panel_bom_presets.h>
38
39
41 PAGED_DIALOG( aFrame, _( "Schematic Setup" ), true, false,
42 _( "Import Settings from Another Project..." ), wxSize( 920, 460 ) ),
43 m_frame( aFrame )
44{
45 SetEvtHandlerEnabled( false );
46
48
49 /*
50 * WARNING: If you change page names you MUST update calls to ShowSchematicSetupDialog().
51 */
52
53 m_treebook->AddPage( new wxPanel( GetTreebook() ), _( "General" ) );
54
55 m_formattingPage = m_treebook->GetPageCount();
57 [this]( wxWindow* aParent ) -> wxWindow*
58 {
59 return new PANEL_SETUP_FORMATTING( aParent, m_frame );
60 }, _( "Formatting" ) );
61
62 m_fieldNameTemplatesPage = m_treebook->GetPageCount();
64 [this]( wxWindow* aParent ) -> wxWindow*
65 {
67 return new PANEL_TEMPLATE_FIELDNAMES( aParent, &settings.m_TemplateFieldNames );
68 }, _( "Field Name Templates" ) );
69
70 m_bomPresetsPage = m_treebook->GetPageCount();
72 [this]( wxWindow* aParent ) -> wxWindow*
73 {
75 return new PANEL_BOM_PRESETS( aParent, settings );
76 }, _( "BOM Presets" ) );
77
78
79 m_treebook->AddPage( new wxPanel( GetTreebook() ), _( "Electrical Rules" ) );
80
81 m_severitiesPage = m_treebook->GetPageCount();
83 [this]( wxWindow* aParent ) -> wxWindow*
84 {
85 ERC_SETTINGS& ercSettings = m_frame->Schematic().ErcSettings();
87 ercSettings.m_ERCSeverities,
88 m_pinToPinError.get() );
89 }, _( "Violation Severity" ) );
90
91 m_pinMapPage = m_treebook->GetPageCount();
93 [this]( wxWindow* aParent ) -> wxWindow*
94 {
95 return new PANEL_SETUP_PINMAP( aParent, m_frame );
96 }, _( "Pin Conflicts Map" ) );
97
98 m_treebook->AddPage( new wxPanel( GetTreebook() ), _( "Project" ) );
99
100 m_netclassesPage = m_treebook->GetPageCount();
102 [this]( wxWindow* aParent ) -> wxWindow*
103 {
104 SCHEMATIC& schematic = m_frame->Schematic();
105 return new PANEL_SETUP_NETCLASSES( aParent, m_frame,
108 true );
109 }, _( "Net Classes" ) );
110
111 m_busesPage = m_treebook->GetPageCount();
113 [this]( wxWindow* aParent ) -> wxWindow*
114 {
115 return new PANEL_SETUP_BUSES( aParent, m_frame );
116 }, _( "Bus Alias Definitions" ) );
117
119 [this]( wxWindow* aParent ) -> wxWindow*
120 {
121 return new PANEL_TEXT_VARIABLES( aParent, &Prj() );
122 }, _( "Text Variables" ) );
123
124 for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
125 m_treebook->ExpandNode( i );
126
127 SetEvtHandlerEnabled( true );
128
130
131 if( Prj().IsReadOnly() )
132 {
133 m_infoBar->ShowMessage( _( "Project is missing or read-only. Settings will not be "
134 "editable." ), wxICON_WARNING );
135 }
136
137 wxBookCtrlEvent evt( wxEVT_TREEBOOK_PAGE_CHANGED, wxID_ANY, 0 );
138
139 wxQueueEvent( m_treebook, evt.Clone() );
140}
141
142
144{
145}
146
147
148void DIALOG_SCHEMATIC_SETUP::onPageChanged( wxBookCtrlEvent& aEvent )
149{
151
152 int page = aEvent.GetSelection();
153
154 if( Prj().IsReadOnly() )
155 KIUI::Disable( m_treebook->GetPage( page ) );
156}
157
158
159void DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction( wxCommandEvent& event )
160{
161 DIALOG_SCH_IMPORT_SETTINGS importDlg( this, m_frame );
162
163 if( importDlg.ShowModal() == wxID_CANCEL )
164 return;
165
166 wxFileName projectFn( importDlg.GetFilePath() );
167 bool alreadyLoaded = false;
168
169 if( m_frame->GetSettingsManager()->GetProject( projectFn.GetFullPath() ) )
170 {
171 alreadyLoaded = true;
172 }
173 else if( !m_frame->GetSettingsManager()->LoadProject( projectFn.GetFullPath(), false ) )
174 {
175 wxString msg = wxString::Format( _( "Error importing settings from project:\n"
176 "Project file %s could not be loaded." ),
177 projectFn.GetFullPath() );
178 DisplayErrorMessage( this, msg );
179
180 return;
181 }
182
183 PROJECT* otherPrj = m_frame->GetSettingsManager()->GetProject( projectFn.GetFullPath() );
184 SCHEMATIC otherSch( otherPrj );
185 PROJECT_FILE& file = otherPrj->GetProjectFile();
186
187 wxASSERT( file.m_SchematicSettings );
188
190
191 if( importDlg.m_FormattingOpt->GetValue() )
192 {
194 ->ImportSettingsFrom( *file.m_SchematicSettings );
195 }
196
197 if( importDlg.m_FieldNameTemplatesOpt->GetValue() )
198 {
200 ->ImportSettingsFrom( &otherSch.Settings().m_TemplateFieldNames );
201 }
202
203 if( importDlg.m_PinMapOpt->GetValue() )
204 {
206 ->ImportSettingsFrom( file.m_ErcSettings->m_PinMap );
207 }
208
209 if( importDlg.m_SeveritiesOpt->GetValue() )
210 {
212 ->ImportSettingsFrom( file.m_ErcSettings->m_ERCSeverities );
213 }
214
215 if( importDlg.m_NetClassesOpt->GetValue() )
216 {
218 ->ImportSettingsFrom( file.m_NetSettings );
219 }
220
221 if( importDlg.m_BomPresetsOpt->GetValue() )
222 {
224 ->ImportBomPresetsFrom( *file.m_SchematicSettings );
225 }
226
227 if( importDlg.m_BomFmtPresetsOpt->GetValue() )
228 {
230 ->ImportBomFmtPresetsFrom( *file.m_SchematicSettings );
231 }
232
233 if( !alreadyLoaded )
234 m_frame->GetSettingsManager()->UnloadProject( otherPrj, false );
235}
void onPageChanged(wxBookCtrlEvent &aEvent) override
DIALOG_SCHEMATIC_SETUP(SCH_EDIT_FRAME *aFrame)
std::shared_ptr< ERC_ITEM > m_pinToPinError
void onAuxiliaryAction(wxCommandEvent &aEvent) override
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
SETTINGS_MANAGER * GetSettingsManager() const
static std::shared_ptr< ERC_ITEM > Create(int aErrorCode)
Constructs an ERC_ITEM for the given error code.
Definition: erc_item.cpp:262
static std::vector< std::reference_wrapper< RC_ITEM > > GetItemsWithSeverities()
Definition: erc_item.h:76
Container for ERC settings.
Definition: erc_settings.h:122
std::map< int, SEVERITY > m_ERCSeverities
Definition: erc_settings.h:181
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:185
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
bool LoadFromFile(const wxString &aDirectory="") override
Loads the JSON document from the parent and then calls Load()
WX_TREEBOOK * GetTreebook()
Definition: paged_dialog.h:39
WX_INFOBAR * m_infoBar
Definition: paged_dialog.h:72
WX_TREEBOOK * m_treebook
Definition: paged_dialog.h:68
virtual void onPageChanged(wxBookCtrlEvent &aEvent)
The backing store for a PROJECT, in JSON format.
Definition: project_file.h:70
ERC_SETTINGS * m_ErcSettings
Eeschema params.
Definition: project_file.h:132
SCHEMATIC_SETTINGS * m_SchematicSettings
Definition: project_file.h:135
std::shared_ptr< NET_SETTINGS > & NetSettings()
Definition: project_file.h:101
std::shared_ptr< NET_SETTINGS > m_NetSettings
Net settings for this project (owned here)
Definition: project_file.h:173
Container for project specific data.
Definition: project.h:62
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:166
These are loaded from Eeschema settings but then overwritten by the project settings.
Holds all the data relating to one schematic.
Definition: schematic.h:75
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:289
std::set< wxString > GetNetClassAssignmentCandidates()
Return the set of netname candidates for netclass assignment.
Definition: schematic.cpp:400
ERC_SETTINGS & ErcSettings() const
Definition: schematic.cpp:296
Schematic editor (Eeschema) main window.
SCHEMATIC & Schematic() const
bool LoadProject(const wxString &aFullPath, bool aSetActive=true)
Loads a project or sets up a new project with a specified path.
PROJECT * GetProject(const wxString &aFullPath) const
Retrieves a loaded project by name.
bool UnloadProject(PROJECT *aProject, bool aSave=true)
Saves, unloads and unregisters the given PROJECT.
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Definition: wx_infobar.cpp:154
wxWindow * ResolvePage(size_t aPage)
bool AddLazySubPage(std::function< wxWindow *(wxWindow *aParent)> aLazyCtor, const wxString &text, bool bSelect=false, int imageId=NO_IMAGE)
Definition: wx_treebook.cpp:96
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:195
This file is part of the common library.
#define _(s)
@ ERCE_PIN_TO_PIN_WARNING
Definition: erc_settings.h:93
KICOMMON_API void Disable(wxWindow *aWindow)
Makes a window read-only.
Definition: ui_common.cpp:323