KiCad PCB EDA Suite
dialog_update_pcb.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) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#include <pcb_edit_frame.h>
25#include <pcbnew_settings.h>
26#include <dialog_update_pcb.h>
31#include <tool/tool_manager.h>
32#include <tools/pcb_actions.h>
33#include <kiface_base.h>
34#include <kiplatform/ui.h>
35
36
38 DIALOG_UPDATE_PCB_BASE( aParent ),
39 m_frame( aParent ),
40 m_netlist( aNetlist ),
41 m_initialized( false )
42{
43 auto cfg = m_frame->GetPcbNewSettings();
44
45 m_cbRelinkFootprints->SetValue( cfg->m_NetlistDialog.associate_by_ref_sch );
46 m_cbUpdateFootprints->SetValue( cfg->m_NetlistDialog.update_footprints );
47 m_cbDeleteExtraFootprints->SetValue( cfg->m_NetlistDialog.delete_extra_footprints );
48
49 m_messagePanel->SetLabel( _("Changes To Be Applied") );
50 m_messagePanel->SetFileName( Prj().GetProjectPath() + wxT( "report.txt" ) );
53
54 m_messagePanel->SetVisibleSeverities( cfg->m_NetlistDialog.report_filter );
55
56 m_messagePanel->GetSizer()->SetSizeHints( this );
57 m_messagePanel->Layout();
58
59 SetupStandardButtons( { { wxID_OK, _( "Update PCB" ) },
60 { wxID_CANCEL, _( "Close" ) } } );
61
63
64 m_initialized = true;
65 PerformUpdate( true );
66}
67
68
70{
71 auto cfg = m_frame->GetPcbNewSettings();
72
74 cfg->m_NetlistDialog.update_footprints = m_cbUpdateFootprints->GetValue();
75 cfg->m_NetlistDialog.delete_extra_footprints = m_cbDeleteExtraFootprints->GetValue();
76 cfg->m_NetlistDialog.report_filter = m_messagePanel->GetVisibleSeverities();
77
79 {
81 controls->SetCursorPosition( controls->GetMousePosition() );
83 }
84}
85
86
88{
90
91 REPORTER& reporter = m_messagePanel->Reporter();
92
93 m_runDragCommand = false;
94
97
98 if( !aDryRun )
99 {
102 }
103
105 updater.SetReporter ( &reporter );
106 updater.SetIsDryRun( aDryRun );
107 updater.SetLookupByTimestamp( !m_cbRelinkFootprints->GetValue() );
109 updater.SetReplaceFootprints( m_cbUpdateFootprints->GetValue() );
110 updater.UpdateNetlist( *m_netlist );
111
112 m_messagePanel->Flush( true );
113
114 if( aDryRun )
115 return;
116
118}
119
120
121void DIALOG_UPDATE_PCB::OnOptionChanged( wxCommandEvent& event )
122{
123 if( m_initialized )
124 {
125 PerformUpdate( true );
126 m_sdbSizer1OK->Enable( true );
127 m_sdbSizer1OK->SetDefault();
128 }
129}
130
131
132void DIALOG_UPDATE_PCB::OnUpdateClick( wxCommandEvent& event )
133{
134 m_messagePanel->SetLabel( _( "Changes Applied to PCB" ) );
135 PerformUpdate( false );
136
137 m_sdbSizer1Cancel->SetDefault();
138 // Widgets has a tendency to keep both buttons highlighted without the following:
139 m_sdbSizer1OK->Enable( false );
140}
Update the BOARD with a new netlist.
void SetReporter(REPORTER *aReporter)
Enable dry run mode (just report, no changes to PCB).
bool UpdateNetlist(NETLIST &aNetlist)
Update the board's components according to the new netlist.
void SetIsDryRun(bool aEnabled)
void SetDeleteUnusedFootprints(bool aEnabled)
void SetReplaceFootprints(bool aEnabled)
void SetLookupByTimestamp(bool aEnabled)
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...
Class DIALOG_UPDATE_PCB_BASE.
WX_HTML_REPORT_PANEL * m_messagePanel
void PerformUpdate(bool aDryRun)
void OnOptionChanged(wxCommandEvent &event) override
void OnUpdateClick(wxCommandEvent &event) override
DIALOG_UPDATE_PCB(PCB_EDIT_FRAME *aParent, NETLIST *aNetlist)
PCB_EDIT_FRAME * m_frame
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
An interface for classes handling user events controlling the view behavior such as zooming,...
virtual VECTOR2D GetMousePosition(bool aWorldCoordinates=true) const =0
Return the current mouse pointer position.
virtual void SetCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true, bool aTriggeredByArrows=false, long aArrowCommand=0)=0
Move cursor to the requested position expressed in world coordinates.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Store information read from a netlist along with the flags used to update the NETLIST in the BOARD.
Definition: pcb_netlist.h:213
void SetReplaceFootprints(bool aReplace)
Definition: pcb_netlist.h:276
void SetFindByTimeStamp(bool aFindByTimeStamp)
Definition: pcb_netlist.h:273
void SortByReference()
DIALOG_NETLIST m_NetlistDialog
static TOOL_ACTION selectionClear
Clear the current selection.
Definition: pcb_actions.h:59
static TOOL_ACTION move
move or drag an item
Definition: pcb_actions.h:110
PCBNEW_SETTINGS * GetPcbNewSettings() const
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
BOARD * GetBoard() const
The main frame for Pcbnew.
void OnNetlistChanged(BOARD_NETLIST_UPDATER &aUpdater, bool *aRunDragCommand)
Called after netlist is updated.
Definition: netlist.cpp:84
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:142
void DeactivateTool()
Deactivate the currently active tool.
void Clear()
return the number of messages matching the given severity mask.
void SetLazyUpdate(bool aLazyUpdate)
Forces updating the HTML page, after the report is built in lazy mode If aSort = true,...
void SetLabel(const wxString &aLabel) override
Sets the lazy update.
void SetFileName(const wxString &aReportFileName)
void SetVisibleSeverities(int aSeverities)
void Flush(bool aSort=false)
Set the visible severity filter.
#define _(s)
Class that computes missing connections on a PCB.