KiCad PCB EDA Suite
Loading...
Searching...
No Matches
footprint_wizard_frame.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) 2012-2015 Miguel Angel Ajo Pelayo <[email protected]>
5 * Copyright (C) 2012-2019 Jean-Pierre Charras, jp.charras at wanadoo.fr
6 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
7 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27#include <kiface_base.h>
28#include <pcb_draw_panel_gal.h>
29#include <pcb_edit_frame.h>
32#include <widgets/msgpanel.h>
33#include <bitmaps.h>
34#include <grid_tricks.h>
35#include <board.h>
38#include <pcbnew_id.h>
40#include <wx/listbox.h>
41#include <wx/statline.h>
42
43#include <nlohmann/json.hpp>
44#include <wx/tokenzr.h>
45#include <wx/numformatter.h>
46#include <wx/wupdlock.h>
47#include <pgm_base.h>
50#include <tool/tool_manager.h>
52#include <tool/action_toolbar.h>
53#include <tool/common_tools.h>
55#include <tools/pcb_control.h>
56#include <tools/pcb_actions.h>
61
62
64
65 // Window events
68
69 // Toolbar events
72
73 // listbox events
76 FOOTPRINT_WIZARD_FRAME::ParametersUpdated )
77END_EVENT_TABLE()
78
79
80// Note: our FOOTPRINT_WIZARD_FRAME is always modal.
81
82FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_FRAME( KIWAY* aKiway, wxWindow* aParent,
83 FRAME_T aFrameType ) :
84 PCB_BASE_EDIT_FRAME( aKiway, aParent, aFrameType, _( "Footprint Wizard" ),
85 wxDefaultPosition, wxDefaultSize,
86 aParent ? KICAD_DEFAULT_DRAWFRAME_STYLE | wxFRAME_FLOAT_ON_PARENT
87 : KICAD_DEFAULT_DRAWFRAME_STYLE | wxSTAY_ON_TOP,
89 m_wizardListShown( false )
90{
91 wxASSERT( aFrameType == FRAME_FOOTPRINT_WIZARD );
92
93 // This frame is always show modal:
94 SetModal( true );
95
96 // Give an icon
97 wxIcon icon;
98 icon.CopyFromBitmap( KiBitmap( BITMAPS::module_wizard ) );
99 SetIcon( icon );
100
101 m_wizardName.Empty();
102
103 // Create the GAL canvas.
104 // Must be created before calling LoadSettings() that needs a valid GAL canvas
105 PCB_DRAW_PANEL_GAL* gal_drawPanel = new PCB_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ),
106 m_frameSize,
107 GetGalDisplayOptions(),
109 SetCanvas( gal_drawPanel );
110
111 SetBoard( new BOARD() );
112
113 // Ensure all layers and items are visible:
115 SetScreen( new PCB_SCREEN( GetPageSizeIU() ) );
116 GetScreen()->m_Center = true; // Center coordinate origins on screen.
117
118 LoadSettings( config() );
119
120 SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
121
122 // Set some display options here, because the FOOTPRINT_WIZARD_FRAME
123 // does not have a config menu to do that:
124
125 // the footprint wizard frame has no config menu. so use some settings
126 // from the caller, or force some options:
127 PCB_BASE_FRAME* caller = dynamic_cast<PCB_BASE_FRAME*>( aParent );
128
129 if( caller )
130 SetUserUnits( caller->GetUserUnits() );
131
132 // In viewer, the default net clearance is not known (it depends on the actual board).
133 // So we do not show the default clearance, by setting it to 0
134 // The footprint or pad specific clearance will be shown
136
137 // Create the manager and dispatcher & route draw panel events to the dispatcher
138 m_toolManager = new TOOL_MANAGER;
139 m_toolManager->SetEnvironment( GetBoard(), gal_drawPanel->GetView(),
140 gal_drawPanel->GetViewControls(), config(), this );
141 m_actions = new PCB_ACTIONS();
142 m_toolDispatcher = new TOOL_DISPATCHER( m_toolManager );
143 gal_drawPanel->SetEventDispatcher( m_toolDispatcher );
144
145 m_toolManager->RegisterTool( new PCB_CONTROL );
146 m_toolManager->RegisterTool( new PCB_SELECTION_TOOL ); // for std context menus (zoom & grid)
147 m_toolManager->RegisterTool( new SCRIPTING_TOOL );
148 m_toolManager->RegisterTool( new COMMON_TOOLS );
149 m_toolManager->RegisterTool( new FOOTPRINT_WIZARD_TOOLS );
150 m_toolManager->InitTools();
151
152 // Run the control tool, it is supposed to be always active
153 m_toolManager->InvokeTool( "common.InteractiveSelection" );
154
155 // Create the toolbars
156 m_toolbarSettings = GetToolbarSettings<FOOTPRINT_WIZARD_TOOLBAR_SETTINGS>( "fpwizard-toolbars" );
157 configureToolbars();
158 RecreateToolbars();
159
160 // Create the parameters panel
161 m_parametersPanel = new wxPanel( this, wxID_ANY );
162
163 m_pageList = new wxListBox( m_parametersPanel, ID_FOOTPRINT_WIZARD_PAGE_LIST,
164 wxDefaultPosition, wxDefaultSize, 0, nullptr,
165 wxLB_HSCROLL | wxNO_BORDER );
166
167 auto divider = new wxStaticLine( m_parametersPanel, wxID_ANY,
168 wxDefaultPosition, wxDefaultSize, wxLI_VERTICAL );
169
170 m_parameterGrid = new WX_GRID( m_parametersPanel, ID_FOOTPRINT_WIZARD_PARAMETER_LIST );
171 initParameterGrid();
172 m_parameterGrid->PushEventHandler( new GRID_TRICKS( m_parameterGrid ) );
173
174 ReCreatePageList();
175
176 wxBoxSizer* parametersSizer = new wxBoxSizer( wxHORIZONTAL );
177 parametersSizer->Add( m_pageList, 0, wxEXPAND, 5 );
178 parametersSizer->Add( divider, 0, wxEXPAND, 5 );
179 parametersSizer->Add( m_parameterGrid, 1, wxEXPAND, 5 );
180 m_parametersPanel->SetSizer( parametersSizer );
181 m_parametersPanel->Layout();
182
183 // Create the build message box
184 m_buildMessageBox = new wxTextCtrl( this, wxID_ANY, wxEmptyString,
185 wxDefaultPosition, wxDefaultSize,
186 wxTE_MULTILINE | wxTE_READONLY | wxNO_BORDER );
187
188 DisplayWizardInfos();
189
190 m_auimgr.SetManagedWindow( this );
191
192 m_auimgr.AddPane( m_tbTopMain, EDA_PANE().HToolbar().Name( "TopMainToolbar" ).Top().Layer(6) );
193 m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom().Layer(6)
194 .BestSize( -1, m_msgFrameHeight ) );
195
196 m_auimgr.AddPane( m_parametersPanel, EDA_PANE().Palette().Name( "Params" ).Left().Position(0)
197 .Caption( _( "Parameters" ) ).MinSize( 360, 180 ) );
198 m_auimgr.AddPane( m_buildMessageBox, EDA_PANE().Palette().Name( "Output" ).Left().Position(1)
199 .CaptionVisible( false ).MinSize( 360, -1 ) );
200
201 m_auimgr.AddPane( GetCanvas(), wxAuiPaneInfo().Name( "DrawFrame" ).CentrePane() );
202
203 auto& galOpts = GetGalDisplayOptions();
204 galOpts.SetCursorMode( KIGFX::CROSS_HAIR_MODE::FULLSCREEN_CROSS );
205 galOpts.m_forceDisplayCursor = true;
206 galOpts.m_axesEnabled = true;
207
208 // Switch to the canvas type set in config
209 resolveCanvasType();
210 GetCanvas()->SwitchBackend( m_canvasType );
211 ActivateGalCanvas();
212
213 updateView();
214
215 SetActiveLayer( F_Cu );
216 GetToolManager()->PostAction( ACTIONS::zoomFitScreen );
217
218 // Do not Run a dialog here: on some Window Managers, it creates issues.
219 // Reason: the FOOTPRINT_WIZARD_FRAME is run as modal;
220 // It means the call to FOOTPRINT_WIZARD_FRAME::ShowModal will change the
221 // Event Loop Manager, and stop the one created by the dialog.
222 // It does not happen on all W.M., perhaps due to the way the order events are called
223 // See the call in onActivate instead
224}
225
226
228{
229 // Delete the GRID_TRICKS.
230 m_parameterGrid->PopEventHandler( true );
231
233 // Be sure any event cannot be fired after frame deletion:
234 GetCanvas()->SetEvtHandlerEnabled( false );
235
236 // Be sure a active tool (if exists) is deactivated:
237 if( m_toolManager )
238 m_toolManager->DeactivateTool();
239
240 EDA_3D_VIEWER_FRAME* draw3DFrame = Get3DViewerFrame();
241
242 if( draw3DFrame )
243 draw3DFrame->Destroy();
244
245 // Now this frame can be deleted
246}
247
248
250{
251 SaveSettings( config() );
252
253 if( IsModal() )
254 {
255 // Only dismiss a modal frame once, so that the return values set by
256 // the prior DismissModal() are not bashed for ShowModal().
257 if( !IsDismissed() )
258 DismissModal( false );
259 }
260}
261
262
264{
265 DismissModal( true );
266 Close();
267}
268
269
270void FOOTPRINT_WIZARD_FRAME::OnGridSize( wxSizeEvent& aSizeEvent )
271{
272 // Resize the parameter columns
274
275 aSizeEvent.Skip();
276}
277
278
279void FOOTPRINT_WIZARD_FRAME::OnSize( wxSizeEvent& SizeEv )
280{
281 if( m_auimgr.GetManagedWindow() )
282 m_auimgr.Update();
283
284 SizeEv.Skip();
285}
286
287
289{
291 return ::GetColorSettings( cfg ? cfg->m_ColorTheme : DEFAULT_THEME );
292}
293
294
303
304
306{
307 BOARD_ITEM* footprint = GetBoard()->GetFirstFootprint();
308
309 if( footprint )
310 {
311 std::vector<MSG_PANEL_ITEM> items;
312
313 footprint->GetMsgPanelInfo( this, items );
314 SetMsgPanel( items );
315 }
316 else
317 {
319 }
320}
321
322
324{
326
327 // Prepare the grid where parameters are displayed
328
329 m_parameterGrid->CreateGrid( 0, 3 );
330
331 m_parameterGrid->SetColLabelValue( WIZ_COL_NAME, _( "Parameter" ) );
332 m_parameterGrid->SetColLabelValue( WIZ_COL_VALUE, _( "Value" ) );
333 m_parameterGrid->SetColLabelValue( WIZ_COL_UNITS, _( "Units" ) );
334
335 m_parameterGrid->SetColLabelSize( 22 );
336 m_parameterGrid->SetColLabelAlignment( wxALIGN_LEFT, wxALIGN_CENTRE );
337 m_parameterGrid->AutoSizeColumns();
338
339 m_parameterGrid->AutoSizeRows();
340 m_parameterGrid->SetRowLabelSize( 0 );
341
342 m_parameterGrid->DisableDragGridSize();
343 m_parameterGrid->DisableDragColSize();
344
345 m_parameterGrid->Connect( wxEVT_SIZE,
346 wxSizeEventHandler( FOOTPRINT_WIZARD_FRAME::OnGridSize ),
347 nullptr, this );
348}
349
350
352{
353 if( m_pageList == nullptr )
354 return;
355
356 FOOTPRINT_WIZARD* footprintWizard = GetMyWizard();
357
358 if( !footprintWizard )
359 return;
360
361 m_pageList->Clear();
362 int max_page = footprintWizard->GetNumParameterPages();
363
364 for( int i = 0; i < max_page; i++ )
365 {
366 wxString name = footprintWizard->GetParameterPageName( i );
367 m_pageList->Append( name );
368 }
369
370 m_pageList->SetSelection( 0, true );
371
375 GetCanvas()->Refresh();
376}
377
378
380{
381 if( m_parameterGrid == nullptr )
382 return;
383
384 FOOTPRINT_WIZARD* footprintWizard = GetMyWizard();
385
386 if( footprintWizard == nullptr )
387 return;
388
389 wxWindowUpdateLocker updateLock( m_parameterGrid );
390
391 m_parameterGrid->ClearGrid();
392 m_parameterGridPage = m_pageList->GetSelection();
393
394 if( m_parameterGridPage < 0 ) // Should not happen
395 return;
396
397 // Get the list of names, values, types, hints and designators
398 wxArrayString designatorsList = footprintWizard->GetParameterDesignators( m_parameterGridPage );
399 wxArrayString namesList = footprintWizard->GetParameterNames( m_parameterGridPage );
400 wxArrayString valuesList = footprintWizard->GetParameterValues( m_parameterGridPage );
401 wxArrayString typesList = footprintWizard->GetParameterTypes( m_parameterGridPage );
402 wxArrayString hintsList = footprintWizard->GetParameterHints( m_parameterGridPage );
403
404 // Dimension the wxGrid
405 m_parameterGrid->ClearRows();
406 m_parameterGrid->AppendRows( namesList.size() );
407
408 wxString designator, name, value, units, hint;
409
410 for( unsigned int i = 0; i < namesList.size(); i++ )
411 {
412 designator = designatorsList[i];
413 name = namesList[i];
414 value = valuesList[i];
415 units = typesList[i];
416 hint = hintsList[i];
417
418 m_parameterGrid->SetRowLabelValue( i, designator );
419
420 // Set the 'Name'
421 m_parameterGrid->SetCellValue( i, WIZ_COL_NAME, name );
422 m_parameterGrid->SetReadOnly( i, WIZ_COL_NAME );
423
424 // Boolean parameters are displayed using a checkbox
425 if( units == WIZARD_PARAM_UNITS_BOOL )
426 {
427 // Set to ReadOnly as we delegate interactivity to GRID_TRICKS
428 m_parameterGrid->SetReadOnly( i, WIZ_COL_VALUE );
429 m_parameterGrid->SetCellRenderer( i, WIZ_COL_VALUE, new wxGridCellBoolRenderer );
430 }
431 // Parameters that can be selected from a list of multiple options
432 else if( units.Contains( "," ) ) // Indicates list of available options
433 {
434 wxStringTokenizer tokenizer( units, "," );
435 wxArrayString options;
436
437 while( tokenizer.HasMoreTokens() )
438 options.Add( tokenizer.GetNextToken() );
439
440 m_parameterGrid->SetCellEditor( i, WIZ_COL_VALUE, new wxGridCellChoiceEditor( options ) );
441
442 units = wxT( "" );
443 }
444 else if( units == WIZARD_PARAM_UNITS_INTEGER ) // Integer parameters
445 {
446 m_parameterGrid->SetCellEditor( i, WIZ_COL_VALUE, new wxGridCellNumberEditor );
447 }
448 else if( ( units == WIZARD_PARAM_UNITS_MM ) ||
449 ( units == WIZARD_PARAM_UNITS_MILS ) ||
450 ( units == WIZARD_PARAM_UNITS_FLOAT ) ||
451 ( units == WIZARD_PARAM_UNITS_RADIANS ) ||
452 ( units == WIZARD_PARAM_UNITS_DEGREES ) ||
453 ( units == WIZARD_PARAM_UNITS_PERCENT ) )
454 {
455 // Non-integer numerical parameters
456 m_parameterGrid->SetCellEditor( i, WIZ_COL_VALUE, new wxGridCellFloatEditor );
457
458 // Convert separators to the locale-specific character
459 value.Replace( ",", wxNumberFormatter::GetDecimalSeparator() );
460 value.Replace( ".", wxNumberFormatter::GetDecimalSeparator() );
461 }
462
463 // Set the 'Units'
464 m_parameterGrid->SetCellValue( i, WIZ_COL_UNITS, units );
465 m_parameterGrid->SetReadOnly( i, WIZ_COL_UNITS );
466
467 // Set the 'Value'
468 m_parameterGrid->SetCellValue( i, WIZ_COL_VALUE, value );
469 }
470
472}
473
475{
476 // Parameter grid is not yet configured
477 if( ( m_parameterGrid == nullptr ) || ( m_parameterGrid->GetNumberCols() == 0 ) )
478 return;
479
480 // first auto-size the columns to ensure enough space around text
481 m_parameterGrid->AutoSizeColumns();
482
483 // Auto-size the value column
484 int width = m_parameterGrid->GetClientSize().GetWidth() -
485 m_parameterGrid->GetRowLabelSize() -
486 m_parameterGrid->GetColSize( WIZ_COL_NAME ) -
487 m_parameterGrid->GetColSize( WIZ_COL_UNITS );
488
489 if( width > m_parameterGrid->GetColMinimalAcceptableWidth() )
490 {
491 m_parameterGrid->SetColSize( WIZ_COL_VALUE, width );
492 }
493}
494
495
496void FOOTPRINT_WIZARD_FRAME::ClickOnPageList( wxCommandEvent& event )
497{
498 if( m_pageList->GetSelection() >= 0 )
499 {
501 GetCanvas()->Refresh();
503 }
504}
505
506
508{
509 PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( aCfg );
510 wxCHECK( cfg, /*void*/ );
511
513
516}
517
518
520{
521 PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( aCfg );
522 wxCHECK( cfg, /*void*/ );
523
525
526#if wxCHECK_VERSION( 3, 3, 0 )
527 {
528 WX_AUI_JSON_SERIALIZER serializer( m_auimgr );
529 nlohmann::json state = serializer.Serialize();
530
531 if( state.is_null() || state.empty() )
532 cfg->m_FootprintViewer.aui_state = nlohmann::json();
533 else
534 cfg->m_FootprintViewer.aui_state = state;
535
536 cfg->m_FootprintViewer.perspective.clear();
537 }
538#else
539 cfg->m_FootprintViewer.perspective = m_auimgr.SavePerspective().ToStdString();
540 cfg->m_FootprintViewer.aui_state = nlohmann::json();
541#endif
542}
543
544
546{
547 if( PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( aCfg ) )
548 return &cfg->m_FootprintWizard;
549
550 wxFAIL_MSG( wxT( "FOOTPRINT_CHOOSER not running with PCBNEW_SETTINGS" ) );
551 return &aCfg->m_Window; // non-null fail-safe
552}
553
554
555void FOOTPRINT_WIZARD_FRAME::OnActivate( wxActivateEvent& event )
556{
557 // Ensure we do not have old selection:
558 if( !event.GetActive() )
559 return;
560
561 if( !m_wizardListShown )
562 {
563 m_wizardListShown = true;
564 wxPostEvent( this, wxCommandEvent( wxEVT_TOOL, ID_FOOTPRINT_WIZARD_SELECT_WIZARD ) );
565 }
566#if 0
567 // Currently, we do not have a way to see if a Python wizard has changed,
568 // therefore the lists of parameters and option has to be rebuilt
569 // This code could be enabled when this way exists
570 bool footprintWizardsChanged = false;
571
572 if( footprintWizardsChanged )
573 {
574 // If we are here, the library list has changed, rebuild it
577 }
578#endif
579}
580
581
582void FOOTPRINT_WIZARD_FRAME::Update3DView( bool aMarkDirty, bool aRefresh, const wxString* aTitle )
583{
584 wxString frm3Dtitle;
585 frm3Dtitle.Printf( _( "ModView: 3D Viewer [%s]" ), m_wizardName );
586 PCB_BASE_FRAME::Update3DView( aMarkDirty, aRefresh, &frm3Dtitle );
587}
588
589
594
595
597{
598 // Reload the Python plugins
599 // Because the board editor has also a plugin python menu,
600 // call the PCB_EDIT_FRAME RunAction() if the board editor is running
601 // Otherwise run the current RunAction().
602 PCB_EDIT_FRAME* pcbframe = static_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
603
604 if( pcbframe )
606 else
608}
const char * name
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition bitmap.cpp:104
static TOOL_ACTION pluginsReload
Definition actions.h:295
static TOOL_ACTION zoomFitScreen
Definition actions.h:141
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
WINDOW_SETTINGS m_Window
wxString m_ColorTheme
Active color theme name.
std::shared_ptr< NET_SETTINGS > m_NetSettings
Abstract interface for BOARD_ITEMs capable of storing other items inside.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:79
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition board.h:505
void SetVisibleAlls()
Change the bit-mask of visible element categories and layers.
Definition board.cpp:973
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition board.cpp:1041
Color settings are a bit different than most of the settings objects in that there can be more than o...
Handles action that are shared between different applications.
Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.
wxAuiManager m_auimgr
virtual void ClearMsgPanel()
Clear all messages from the message panel.
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
virtual void ReCreateHToolbar()
static constexpr GAL_TYPE GAL_FALLBACK
void StopDrawing()
Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Set a dispatcher that processes events and forwards them to tools.
virtual void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
Definition eda_item.h:220
Specialization of the wxAuiPaneInfo class for KiCad panels.
BOARD_ITEM_CONTAINER * GetModel() const override
void PythonPluginsReload()
Reload the Python plugins if they are newer than the already loaded, and load new plugins if any.
void initParameterGrid()
Prepare the grid where parameters are displayed.
void OnSize(wxSizeEvent &event) override
Recalculate the size of toolbars and display panel when the frame size changes.
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
int m_parameterGridPage
the page currently displayed by m_parameterGrid it is most of time the m_pageList selection,...
wxListBox * m_pageList
The list of pages.
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
void ReCreateParameterList()
Create the list of parameters for the current page.
void DisplayWizardInfos()
Show all the details about the current wizard.
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
wxString m_wizardName
name of the current wizard
void SelectCurrentWizard(wxCommandEvent &aDummy)
bool m_wizardListShown
A show-once flag for the wizard list.
void updateView()
Rebuild the GAL view (reint tool manager, colors and drawings) must be run after any footprint change...
void Update3DView(bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr) override
Update the 3D view, if the viewer is opened by this frame.
void ClickOnPageList(wxCommandEvent &event)
WX_GRID * m_parameterGrid
The list of parameters.
FOOTPRINT_WIZARD * GetMyWizard()
Reloads the wizard by name.
void ResizeParamColumns()
Expand the 'Value' column to fill available.
void UpdateMsgPanel() override
Redraw the message panel.
void ReCreatePageList()
Create or recreate the list of parameter pages for the current wizard.
wxString m_auiPerspective
Encoded string describing the AUI layout.
void ExportSelectedFootprint(wxCommandEvent &aEvent)
Will let the caller exit from the wait loop, and get the built footprint.
void OnGridSize(wxSizeEvent &aSizeEvent)
WINDOW_SETTINGS * GetWindowSettings(APP_SETTINGS_BASE *aCfg) override
Return a pointer to the window settings for this frame.
void OnActivate(wxActivateEvent &event)
Called when the frame frame is activate to reload the libraries and component lists that can be chang...
Tool useful for viewing footprints.
The parent class from where any footprint wizard class must derive.
virtual wxArrayString GetParameterHints(int aPage)=0
virtual wxArrayString GetParameterNames(int aPage)=0
virtual wxArrayString GetParameterValues(int aPage)=0
virtual wxString GetParameterPageName(int aPage)=0
virtual wxArrayString GetParameterTypes(int aPage)=0
virtual int GetNumParameterPages()=0
virtual wxArrayString GetParameterDesignators(int aPage)=0
Add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.
Definition grid_tricks.h:61
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
void DismissModal(bool aRetVal, const wxString &aResult=wxEmptyString)
bool IsModal() const override
Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame...
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:286
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition kiway.cpp:395
void SetClearance(int aClearance)
Definition netclass.h:119
std::shared_ptr< NETCLASS > GetDefaultNetclass()
Gets the default netclass for the project.
WINDOW_SETTINGS m_FootprintViewer
Gather all the actions that are shared by tools.
Definition pcb_actions.h:51
Common, abstract interface for edit frames.
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
BOARD * GetBoard() const
FOOTPRINT_EDITOR_SETTINGS * GetFootprintEditorSettings() const
EDA_3D_VIEWER_FRAME * Get3DViewerFrame()
virtual void Update3DView(bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr)
Update the 3D view, if the viewer is opened by this frame.
Handle actions that are shared between different frames in PcbNew.
Definition pcb_control.h:47
void UpdateColors()
Update the color settings in the painter and GAL.
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
void DisplayBoard(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr)
Add all items from the current board to the VIEW, so they can be displayed by GAL.
The main frame for Pcbnew.
The selection tool: currently supports:
Tool relating to pads and pad settings.
TOOL_MANAGER * m_toolManager
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
@ MODEL_RELOAD
Model changes (the sheet for a schematic)
Definition tool_base.h:80
Master controller class:
bool RunAction(const std::string &aActionName, T aParam)
Run the specified action immediately, pausing the current action to run the new one.
void SetEnvironment(EDA_ITEM *aModel, KIGFX::VIEW *aView, KIGFX::VIEW_CONTROLS *aViewControls, APP_SETTINGS_BASE *aSettings, TOOLS_HOLDER *aFrame)
Set the work environment (model, view, view controls and the parent window).
EDA_UNITS GetUserUnits() const
nlohmann::json Serialize() const
#define _(s)
Declaration of the eda_3d_viewer class.
#define KICAD_DEFAULT_DRAWFRAME_STYLE
#define FOOTPRINT_WIZARD_FRAME_NAME
const wxString WIZARD_PARAM_UNITS_PERCENT
const wxString WIZARD_PARAM_UNITS_RADIANS
const wxString WIZARD_PARAM_UNITS_MM
const wxString WIZARD_PARAM_UNITS_INTEGER
const wxString WIZARD_PARAM_UNITS_BOOL
const wxString WIZARD_PARAM_UNITS_FLOAT
const wxString WIZARD_PARAM_UNITS_MILS
const wxString WIZARD_PARAM_UNITS_DEGREES
EVT_GRID_CMD_CELL_CHANGED(ID_FOOTPRINT_WIZARD_PARAMETER_LIST, FOOTPRINT_WIZARD_FRAME::ParametersUpdated) FOOTPRINT_WIZARD_FRAME
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition frame_type.h:33
@ FRAME_PCB_EDITOR
Definition frame_type.h:42
@ FRAME_FOOTPRINT_WIZARD
Definition frame_type.h:46
@ F_Cu
Definition layer_ids.h:64
Message panel definition file.
@ ID_FOOTPRINT_WIZARD_DONE
Definition pcbnew_id.h:89
@ ID_FOOTPRINT_WIZARD_SELECT_WIZARD
Definition pcbnew_id.h:92
@ ID_FOOTPRINT_WIZARD_PARAMETER_LIST
Definition pcbnew_id.h:91
@ ID_FOOTPRINT_WIZARD_PAGE_LIST
Definition pcbnew_id.h:90
BOARD * GetBoard()
see class PGM_BASE
#define DEFAULT_THEME
T * GetToolbarSettings(const wxString &aFilename)
KIWAY Kiway(KFCTL_STANDALONE)
Store the common settings that are saved and loaded for each window / frame.
nlohmann::json aui_state
wxString perspective