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>
54#include <tool/common_control.h>
56#include <tools/pcb_control.h>
57#include <tools/pcb_actions.h>
62
63
65
66 // Window events
69
70 // Toolbar events
73
74 // listbox events
77 FOOTPRINT_WIZARD_FRAME::ParametersUpdated )
78END_EVENT_TABLE()
79
80
81// Note: our FOOTPRINT_WIZARD_FRAME is always modal.
82
83FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_FRAME( KIWAY* aKiway, wxWindow* aParent,
84 FRAME_T aFrameType ) :
85 PCB_BASE_EDIT_FRAME( aKiway, aParent, aFrameType, _( "Footprint Wizard" ),
86 wxDefaultPosition, wxDefaultSize,
87 aParent ? KICAD_DEFAULT_DRAWFRAME_STYLE | wxFRAME_FLOAT_ON_PARENT
88 : KICAD_DEFAULT_DRAWFRAME_STYLE | wxSTAY_ON_TOP,
90 m_wizardListShown( false )
91{
92 wxASSERT( aFrameType == FRAME_FOOTPRINT_WIZARD );
93
94 // This frame is always show modal:
95 SetModal( true );
96
97 // Give an icon
98 wxIcon icon;
99 icon.CopyFromBitmap( KiBitmap( BITMAPS::module_wizard ) );
100 SetIcon( icon );
101
102 m_wizardName.Empty();
103
104 // Create the GAL canvas.
105 // Must be created before calling LoadSettings() that needs a valid GAL canvas
106 PCB_DRAW_PANEL_GAL* gal_drawPanel = new PCB_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ),
107 m_frameSize,
108 GetGalDisplayOptions(),
110 SetCanvas( gal_drawPanel );
111
112 SetBoard( new BOARD() );
113
114 // Ensure all layers and items are visible:
116 SetScreen( new PCB_SCREEN( GetPageSizeIU() ) );
117 GetScreen()->m_Center = true; // Center coordinate origins on screen.
118
119 LoadSettings( config() );
120
121 SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
122
123 // Set some display options here, because the FOOTPRINT_WIZARD_FRAME
124 // does not have a config menu to do that:
125
126 // the footprint wizard frame has no config menu. so use some settings
127 // from the caller, or force some options:
128 PCB_BASE_FRAME* caller = dynamic_cast<PCB_BASE_FRAME*>( aParent );
129
130 if( caller )
131 SetUserUnits( caller->GetUserUnits() );
132
133 // In viewer, the default net clearance is not known (it depends on the actual board).
134 // So we do not show the default clearance, by setting it to 0
135 // The footprint or pad specific clearance will be shown
137
138 // Create the manager and dispatcher & route draw panel events to the dispatcher
139 m_toolManager = new TOOL_MANAGER;
140 m_toolManager->SetEnvironment( GetBoard(), gal_drawPanel->GetView(),
141 gal_drawPanel->GetViewControls(), config(), this );
142 m_actions = new PCB_ACTIONS();
143 m_toolDispatcher = new TOOL_DISPATCHER( m_toolManager );
144 gal_drawPanel->SetEventDispatcher( m_toolDispatcher );
145
146 m_toolManager->RegisterTool( new PCB_CONTROL );
147 m_toolManager->RegisterTool( new PCB_SELECTION_TOOL ); // for std context menus (zoom & grid)
148 m_toolManager->RegisterTool( new SCRIPTING_TOOL );
149 m_toolManager->RegisterTool( new COMMON_TOOLS );
150 m_toolManager->RegisterTool( new COMMON_CONTROL );
151 m_toolManager->RegisterTool( new FOOTPRINT_WIZARD_TOOLS );
152 m_toolManager->InitTools();
153
154 // Run the control tool, it is supposed to be always active
155 m_toolManager->InvokeTool( "common.InteractiveSelection" );
156
157 // Create the toolbars
158 m_toolbarSettings = GetToolbarSettings<FOOTPRINT_WIZARD_TOOLBAR_SETTINGS>( "fpwizard-toolbars" );
159 configureToolbars();
160 RecreateToolbars();
161
162 // Create the parameters panel
163 m_parametersPanel = new wxPanel( this, wxID_ANY );
164
165 m_pageList = new wxListBox( m_parametersPanel, ID_FOOTPRINT_WIZARD_PAGE_LIST,
166 wxDefaultPosition, wxDefaultSize, 0, nullptr,
167 wxLB_HSCROLL | wxNO_BORDER );
168
169 auto divider = new wxStaticLine( m_parametersPanel, wxID_ANY,
170 wxDefaultPosition, wxDefaultSize, wxLI_VERTICAL );
171
172 m_parameterGrid = new WX_GRID( m_parametersPanel, ID_FOOTPRINT_WIZARD_PARAMETER_LIST );
173 initParameterGrid();
174 m_parameterGrid->PushEventHandler( new GRID_TRICKS( m_parameterGrid ) );
175
176 ReCreatePageList();
177
178 wxBoxSizer* parametersSizer = new wxBoxSizer( wxHORIZONTAL );
179 parametersSizer->Add( m_pageList, 0, wxEXPAND, 5 );
180 parametersSizer->Add( divider, 0, wxEXPAND, 5 );
181 parametersSizer->Add( m_parameterGrid, 1, wxEXPAND, 5 );
182 m_parametersPanel->SetSizer( parametersSizer );
183 m_parametersPanel->Layout();
184
185 // Create the build message box
186 m_buildMessageBox = new wxTextCtrl( this, wxID_ANY, wxEmptyString,
187 wxDefaultPosition, wxDefaultSize,
188 wxTE_MULTILINE | wxTE_READONLY | wxNO_BORDER );
189
190 DisplayWizardInfos();
191
192 m_auimgr.SetManagedWindow( this );
193
194 m_auimgr.AddPane( m_tbTopMain, EDA_PANE().HToolbar().Name( "TopMainToolbar" ).Top().Layer(6) );
195 m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom().Layer(6)
196 .BestSize( -1, m_msgFrameHeight ) );
197
198 m_auimgr.AddPane( m_parametersPanel, EDA_PANE().Palette().Name( "Params" ).Left().Position(0)
199 .Caption( _( "Parameters" ) ).MinSize( 360, 180 ) );
200 m_auimgr.AddPane( m_buildMessageBox, EDA_PANE().Palette().Name( "Output" ).Left().Position(1)
201 .CaptionVisible( false ).MinSize( 360, -1 ) );
202
203 m_auimgr.AddPane( GetCanvas(), wxAuiPaneInfo().Name( "DrawFrame" ).CentrePane() );
204
205 auto& galOpts = GetGalDisplayOptions();
206 galOpts.SetCursorMode( KIGFX::CROSS_HAIR_MODE::FULLSCREEN_CROSS );
207 galOpts.m_forceDisplayCursor = true;
208 galOpts.m_axesEnabled = true;
209
210 // Switch to the canvas type set in config
211 resolveCanvasType();
212 GetCanvas()->SwitchBackend( m_canvasType );
213 ActivateGalCanvas();
214
215 updateView();
216
217 SetActiveLayer( F_Cu );
218 GetToolManager()->PostAction( ACTIONS::zoomFitScreen );
219
220 // Do not Run a dialog here: on some Window Managers, it creates issues.
221 // Reason: the FOOTPRINT_WIZARD_FRAME is run as modal;
222 // It means the call to FOOTPRINT_WIZARD_FRAME::ShowModal will change the
223 // Event Loop Manager, and stop the one created by the dialog.
224 // It does not happen on all W.M., perhaps due to the way the order events are called
225 // See the call in onActivate instead
226}
227
228
230{
231 // Delete the GRID_TRICKS.
232 m_parameterGrid->PopEventHandler( true );
233
235 // Be sure any event cannot be fired after frame deletion:
236 GetCanvas()->SetEvtHandlerEnabled( false );
237
238 // Be sure a active tool (if exists) is deactivated:
239 if( m_toolManager )
240 m_toolManager->DeactivateTool();
241
242 EDA_3D_VIEWER_FRAME* draw3DFrame = Get3DViewerFrame();
243
244 if( draw3DFrame )
245 draw3DFrame->Destroy();
246
247 // Now this frame can be deleted
248}
249
250
252{
253 SaveSettings( config() );
254
255 if( IsModal() )
256 {
257 // Only dismiss a modal frame once, so that the return values set by
258 // the prior DismissModal() are not bashed for ShowModal().
259 if( !IsDismissed() )
260 DismissModal( false );
261 }
262}
263
264
266{
267 DismissModal( true );
268 Close();
269}
270
271
272void FOOTPRINT_WIZARD_FRAME::OnGridSize( wxSizeEvent& aSizeEvent )
273{
274 // Resize the parameter columns
276
277 aSizeEvent.Skip();
278}
279
280
281void FOOTPRINT_WIZARD_FRAME::OnSize( wxSizeEvent& SizeEv )
282{
283 if( m_auimgr.GetManagedWindow() )
284 m_auimgr.Update();
285
286 SizeEv.Skip();
287}
288
289
291{
293 return ::GetColorSettings( cfg ? cfg->m_ColorTheme : DEFAULT_THEME );
294}
295
296
305
306
308{
309 BOARD_ITEM* footprint = GetBoard()->GetFirstFootprint();
310
311 if( footprint )
312 {
313 std::vector<MSG_PANEL_ITEM> items;
314
315 footprint->GetMsgPanelInfo( this, items );
316 SetMsgPanel( items );
317 }
318 else
319 {
321 }
322}
323
324
326{
328
329 // Prepare the grid where parameters are displayed
330
331 m_parameterGrid->CreateGrid( 0, 3 );
332
333 m_parameterGrid->SetColLabelValue( WIZ_COL_NAME, _( "Parameter" ) );
334 m_parameterGrid->SetColLabelValue( WIZ_COL_VALUE, _( "Value" ) );
335 m_parameterGrid->SetColLabelValue( WIZ_COL_UNITS, _( "Units" ) );
336
337 m_parameterGrid->SetColLabelSize( 22 );
338 m_parameterGrid->SetColLabelAlignment( wxALIGN_LEFT, wxALIGN_CENTRE );
339 m_parameterGrid->AutoSizeColumns();
340
341 m_parameterGrid->AutoSizeRows();
342 m_parameterGrid->SetRowLabelSize( 0 );
343
344 m_parameterGrid->DisableDragGridSize();
345 m_parameterGrid->DisableDragColSize();
346
347 m_parameterGrid->Connect( wxEVT_SIZE,
348 wxSizeEventHandler( FOOTPRINT_WIZARD_FRAME::OnGridSize ),
349 nullptr, this );
350}
351
352
354{
355 if( m_pageList == nullptr )
356 return;
357
358 FOOTPRINT_WIZARD* footprintWizard = GetMyWizard();
359
360 if( !footprintWizard )
361 return;
362
363 m_pageList->Clear();
364 int max_page = footprintWizard->GetNumParameterPages();
365
366 for( int i = 0; i < max_page; i++ )
367 {
368 wxString name = footprintWizard->GetParameterPageName( i );
369 m_pageList->Append( name );
370 }
371
372 m_pageList->SetSelection( 0, true );
373
377 GetCanvas()->Refresh();
378}
379
380
382{
383 if( m_parameterGrid == nullptr )
384 return;
385
386 FOOTPRINT_WIZARD* footprintWizard = GetMyWizard();
387
388 if( footprintWizard == nullptr )
389 return;
390
391 wxWindowUpdateLocker updateLock( m_parameterGrid );
392
393 m_parameterGrid->ClearGrid();
394 m_parameterGridPage = m_pageList->GetSelection();
395
396 if( m_parameterGridPage < 0 ) // Should not happen
397 return;
398
399 // Get the list of names, values, types, hints and designators
400 wxArrayString designatorsList = footprintWizard->GetParameterDesignators( m_parameterGridPage );
401 wxArrayString namesList = footprintWizard->GetParameterNames( m_parameterGridPage );
402 wxArrayString valuesList = footprintWizard->GetParameterValues( m_parameterGridPage );
403 wxArrayString typesList = footprintWizard->GetParameterTypes( m_parameterGridPage );
404 wxArrayString hintsList = footprintWizard->GetParameterHints( m_parameterGridPage );
405
406 // Dimension the wxGrid
407 m_parameterGrid->ClearRows();
408 m_parameterGrid->AppendRows( namesList.size() );
409
410 wxString designator, name, value, units, hint;
411
412 for( unsigned int i = 0; i < namesList.size(); i++ )
413 {
414 designator = designatorsList[i];
415 name = namesList[i];
416 value = valuesList[i];
417 units = typesList[i];
418 hint = hintsList[i];
419
420 m_parameterGrid->SetRowLabelValue( i, designator );
421
422 // Set the 'Name'
423 m_parameterGrid->SetCellValue( i, WIZ_COL_NAME, name );
424 m_parameterGrid->SetReadOnly( i, WIZ_COL_NAME );
425
426 // Boolean parameters are displayed using a checkbox
427 if( units == WIZARD_PARAM_UNITS_BOOL )
428 {
429 // Set to ReadOnly as we delegate interactivity to GRID_TRICKS
430 m_parameterGrid->SetReadOnly( i, WIZ_COL_VALUE );
431 m_parameterGrid->SetCellRenderer( i, WIZ_COL_VALUE, new wxGridCellBoolRenderer );
432 }
433 // Parameters that can be selected from a list of multiple options
434 else if( units.Contains( "," ) ) // Indicates list of available options
435 {
436 wxStringTokenizer tokenizer( units, "," );
437 wxArrayString options;
438
439 while( tokenizer.HasMoreTokens() )
440 options.Add( tokenizer.GetNextToken() );
441
442 m_parameterGrid->SetCellEditor( i, WIZ_COL_VALUE, new wxGridCellChoiceEditor( options ) );
443
444 units = wxT( "" );
445 }
446 else if( units == WIZARD_PARAM_UNITS_INTEGER ) // Integer parameters
447 {
448 m_parameterGrid->SetCellEditor( i, WIZ_COL_VALUE, new wxGridCellNumberEditor );
449 }
450 else if( ( units == WIZARD_PARAM_UNITS_MM ) ||
451 ( units == WIZARD_PARAM_UNITS_MILS ) ||
452 ( units == WIZARD_PARAM_UNITS_FLOAT ) ||
453 ( units == WIZARD_PARAM_UNITS_RADIANS ) ||
454 ( units == WIZARD_PARAM_UNITS_DEGREES ) ||
455 ( units == WIZARD_PARAM_UNITS_PERCENT ) )
456 {
457 // Non-integer numerical parameters
458 m_parameterGrid->SetCellEditor( i, WIZ_COL_VALUE, new wxGridCellFloatEditor );
459
460 // Convert separators to the locale-specific character
461 value.Replace( ",", wxNumberFormatter::GetDecimalSeparator() );
462 value.Replace( ".", wxNumberFormatter::GetDecimalSeparator() );
463 }
464
465 // Set the 'Units'
466 m_parameterGrid->SetCellValue( i, WIZ_COL_UNITS, units );
467 m_parameterGrid->SetReadOnly( i, WIZ_COL_UNITS );
468
469 // Set the 'Value'
470 m_parameterGrid->SetCellValue( i, WIZ_COL_VALUE, value );
471 }
472
474}
475
477{
478 // Parameter grid is not yet configured
479 if( ( m_parameterGrid == nullptr ) || ( m_parameterGrid->GetNumberCols() == 0 ) )
480 return;
481
482 // first auto-size the columns to ensure enough space around text
483 m_parameterGrid->AutoSizeColumns();
484
485 // Auto-size the value column
486 int width = m_parameterGrid->GetClientSize().GetWidth() -
487 m_parameterGrid->GetRowLabelSize() -
488 m_parameterGrid->GetColSize( WIZ_COL_NAME ) -
489 m_parameterGrid->GetColSize( WIZ_COL_UNITS );
490
491 if( width > m_parameterGrid->GetColMinimalAcceptableWidth() )
492 {
493 m_parameterGrid->SetColSize( WIZ_COL_VALUE, width );
494 }
495}
496
497
498void FOOTPRINT_WIZARD_FRAME::ClickOnPageList( wxCommandEvent& event )
499{
500 if( m_pageList->GetSelection() >= 0 )
501 {
503 GetCanvas()->Refresh();
505 }
506}
507
508
510{
511 PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( aCfg );
512 wxCHECK( cfg, /*void*/ );
513
515
518}
519
520
522{
523 PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( aCfg );
524 wxCHECK( cfg, /*void*/ );
525
527
528#if wxCHECK_VERSION( 3, 3, 0 )
529 {
530 WX_AUI_JSON_SERIALIZER serializer( m_auimgr );
531 nlohmann::json state = serializer.Serialize();
532
533 if( state.is_null() || state.empty() )
534 cfg->m_FootprintViewer.aui_state = nlohmann::json();
535 else
536 cfg->m_FootprintViewer.aui_state = state;
537
538 cfg->m_FootprintViewer.perspective.clear();
539 }
540#else
541 cfg->m_FootprintViewer.perspective = m_auimgr.SavePerspective().ToStdString();
542 cfg->m_FootprintViewer.aui_state = nlohmann::json();
543#endif
544}
545
546
548{
549 if( PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( aCfg ) )
550 return &cfg->m_FootprintWizard;
551
552 wxFAIL_MSG( wxT( "FOOTPRINT_CHOOSER not running with PCBNEW_SETTINGS" ) );
553 return &aCfg->m_Window; // non-null fail-safe
554}
555
556
557void FOOTPRINT_WIZARD_FRAME::OnActivate( wxActivateEvent& event )
558{
559 // Ensure we do not have old selection:
560 if( !event.GetActive() )
561 return;
562
563 if( !m_wizardListShown )
564 {
565 m_wizardListShown = true;
566 wxPostEvent( this, wxCommandEvent( wxEVT_TOOL, ID_FOOTPRINT_WIZARD_SELECT_WIZARD ) );
567 }
568#if 0
569 // Currently, we do not have a way to see if a Python wizard has changed,
570 // therefore the lists of parameters and option has to be rebuilt
571 // This code could be enabled when this way exists
572 bool footprintWizardsChanged = false;
573
574 if( footprintWizardsChanged )
575 {
576 // If we are here, the library list has changed, rebuild it
579 }
580#endif
581}
582
583
584void FOOTPRINT_WIZARD_FRAME::Update3DView( bool aMarkDirty, bool aRefresh, const wxString* aTitle )
585{
586 wxString frm3Dtitle;
587 frm3Dtitle.Printf( _( "ModView: 3D Viewer [%s]" ), m_wizardName );
588 PCB_BASE_FRAME::Update3DView( aMarkDirty, aRefresh, &frm3Dtitle );
589}
590
591
596
597
599{
600 // Reload the Python plugins
601 // Because the board editor has also a plugin python menu,
602 // call the PCB_EDIT_FRAME RunAction() if the board editor is running
603 // Otherwise run the current RunAction().
604 PCB_EDIT_FRAME* pcbframe = static_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
605
606 if( pcbframe )
608 else
610}
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:294
static TOOL_ACTION zoomFitScreen
Definition actions.h:142
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:83
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition board.h:530
void SetVisibleAlls()
Change the bit-mask of visible element categories and layers.
Definition board.cpp:1015
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition board.cpp:1081
Color settings are a bit different than most of the settings objects in that there can be more than o...
Handle actions that are shared between different applications.
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:226
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:294
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition kiway.cpp:403
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:90
@ ID_FOOTPRINT_WIZARD_SELECT_WIZARD
Definition pcbnew_id.h:93
@ ID_FOOTPRINT_WIZARD_PARAMETER_LIST
Definition pcbnew_id.h:92
@ ID_FOOTPRINT_WIZARD_PAGE_LIST
Definition pcbnew_id.h:91
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