KiCad PCB EDA Suite
Loading...
Searching...
No Matches
footprint_edit_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) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2015 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
6 * Copyright (C) 2015-2016 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 modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation, either version 3 of the License, or (at your
12 * option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program. If not, see <http://www.gnu.org/licenses/>.
21 */
22
23#include "tool/embed_tool.h"
24#include "tools/convert_tool.h"
25#include "tools/drawing_tool.h"
26#include "tools/edit_tool.h"
29#include "tools/pad_tool.h"
30#include "tools/pcb_actions.h"
31#include "tools/pcb_control.h"
39#include <bitmaps.h>
40#include <board.h>
41#include <footprint.h>
42#include <confirm.h>
45#include <footprint_info_impl.h>
46#include <fp_lib_table.h>
48#include <kiface_base.h>
49#include <kiplatform/app.h>
50#include <kiway.h>
51#include <macros.h>
52#include <pcbnew_id.h>
53#include <pgm_base.h>
54#include <project.h>
55#include <project_pcb.h>
57#include <tool/action_toolbar.h>
58#include <tool/common_control.h>
59#include <tool/common_tools.h>
61#include <tool/selection.h>
64#include <tool/tool_manager.h>
65#include <tool/zoom_tool.h>
66#include <tools/array_tool.h>
73#include <widgets/lib_tree.h>
80
81#include <wx/filedlg.h>
82#include <wx/hyperlink.h>
83
84BEGIN_EVENT_TABLE( FOOTPRINT_EDIT_FRAME, PCB_BASE_FRAME )
85 EVT_MENU( wxID_CLOSE, FOOTPRINT_EDIT_FRAME::CloseFootprintEditor )
86 EVT_MENU( wxID_EXIT, FOOTPRINT_EDIT_FRAME::OnExitKiCad )
87
89
92
94
95 // Drop files event
96 EVT_DROP_FILES( FOOTPRINT_EDIT_FRAME::OnDropFiles )
97
98END_EVENT_TABLE()
99
100
101FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent ) :
102 PCB_BASE_EDIT_FRAME( aKiway, aParent, FRAME_FOOTPRINT_EDITOR, wxEmptyString,
103 wxDefaultPosition, wxDefaultSize,
106{
107 m_showBorderAndTitleBlock = false; // true to show the frame references
108 m_aboutTitle = _HKI( "KiCad Footprint Editor" );
109 m_editorSettings = nullptr;
110
111 // Give an icon
112 wxIcon icon;
113 wxIconBundle icon_bundle;
114
115 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 48 ) );
116 icon_bundle.AddIcon( icon );
117 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 128 ) );
118 icon_bundle.AddIcon( icon );
119 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 256 ) );
120 icon_bundle.AddIcon( icon );
121 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit_32 ) );
122 icon_bundle.AddIcon( icon );
123 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit_16 ) );
124 icon_bundle.AddIcon( icon );
125
126 SetIcons( icon_bundle );
127
128 // Create GAL canvas
130
131 PCB_DRAW_PANEL_GAL* drawPanel = new PCB_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
133 SetCanvas( drawPanel );
134
136
137 SetBoard( new BOARD() );
138
139 // This board will only be used to hold a footprint for editing
141
142 // In Footprint Editor, the default net clearance is not known (it depends on the actual
143 // board). So we do not show the default clearance, by setting it to 0. The footprint or
144 // pad specific clearance will be shown.
146
147 // Don't show the default board solder mask expansion in the footprint editor. Only the
148 // footprint or pad mask expansions settings should be shown.
150
151 // Ensure all layers and items are visible:
152 // In footprint editor, some layers have no meaning or cannot be used, but we show all of
153 // them, at least to be able to edit a bad layer
155
156 GetGalDisplayOptions().m_axesEnabled = true;
157
158 // In Footprint Editor, set the default paper size to A4 for plot/print
160 SetScreen( new PCB_SCREEN( GetPageSettings().GetSizeIU( pcbIUScale.IU_PER_MILS ) ) );
161
162 // Create the manager and dispatcher & route draw panel events to the dispatcher
163 setupTools();
165
167 m_treePane = new FOOTPRINT_TREE_PANE( this );
168
172 ReCreateLayerBox( false );
173
175
177 m_appearancePanel = new APPEARANCE_CONTROLS( this, GetCanvas(), true );
178 m_propertiesPanel = new PCB_PROPERTIES_PANEL( this, this );
179
180 // LoadSettings() *after* creating m_LayersManager, because LoadSettings() initialize
181 // parameters in m_LayersManager
182 // NOTE: KifaceSettings() will return PCBNEW_SETTINGS if we started from pcbnew
184
186
187 float proportion = GetFootprintEditorSettings()->m_AuiPanels.properties_splitter;
188 m_propertiesPanel->SetSplitterProportion( proportion );
189
191
192 // Fetch a COPY of the config as a lot of these initializations are going to overwrite our
193 // data.
194 int libWidth = 0;
196
198 {
199 libWidth = cfg->m_LibWidth;
200 aui_cfg = cfg->m_AuiPanels;
201 }
202 else
203 {
204 // keep gcc quiet about uninitalized vars:
205 aui_cfg.appearance_panel_tab = 0;
206 aui_cfg.right_panel_width = -1;
207 }
208
209 m_auimgr.SetManagedWindow( this );
210
211 unsigned int auiFlags = wxAUI_MGR_DEFAULT;
212#if !defined( _WIN32 )
213 // Windows cannot redraw the UI fast enough during a live resize and may lead to all kinds
214 // of graphical glitches
215 auiFlags |= wxAUI_MGR_LIVE_RESIZE;
216#endif
217 m_auimgr.SetFlags( auiFlags );
218
219 // Rows; layers 4 - 6
220 m_auimgr.AddPane( m_tbTopMain, EDA_PANE().HToolbar().Name( "TopMainToolbar" )
221 .Top().Layer( 6 ) );
222
223 m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" )
224 .Bottom().Layer( 6 ) );
225
226 // Columns; layers 1 - 3
227 m_auimgr.AddPane( m_treePane, EDA_PANE().Palette().Name( "Footprints" )
228 .Left().Layer( 4 )
229 .Caption( _( "Libraries" ) )
230 .MinSize( FromDIP( 250 ), -1 ).BestSize( FromDIP( 250 ), -1 ) );
232 .Left().Layer( 3 )
233 .Caption( _( "Properties" ) ).PaneBorder( false )
234 .MinSize( FromDIP( wxSize( 240, 60 ) ) ).BestSize( FromDIP( wxSize( 300, 200 ) ) ) );
235 m_auimgr.AddPane( m_tbLeft, EDA_PANE().VToolbar().Name( "LeftToolbar" )
236 .Left().Layer( 2 ) );
237
238 m_auimgr.AddPane( m_tbRight, EDA_PANE().VToolbar().Name( "RightToolbar" )
239 .Right().Layer(2) );
240 m_auimgr.AddPane( m_appearancePanel, EDA_PANE().Name( "LayersManager" )
241 .Right().Layer( 3 )
242 .Caption( _( "Appearance" ) ).PaneBorder( false )
243 .MinSize( FromDIP( 180 ), -1 ).BestSize( FromDIP( 180 ), -1 ) );
244 m_auimgr.AddPane( m_selectionFilterPanel, EDA_PANE().Palette().Name( "SelectionFilter" )
245 .Right().Layer( 3 ).Position( 2 )
246 .Caption( _( "Selection Filter" ) ).PaneBorder( false )
247 .MinSize( FromDIP( 180 ), -1 ).BestSize( FromDIP( 180 ), -1 ) );
248
249 // Center
250 m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" )
251 .Center() );
252
254
255 m_auimgr.GetPane( "LayersManager" ).Show( m_show_layer_manager_tools );
256 m_auimgr.GetPane( "SelectionFilter" ).Show( m_show_layer_manager_tools );
257 m_auimgr.GetPane( PropertiesPaneName() ).Show( GetSettings()->m_AuiPanels.show_properties );
258
259 // The selection filter doesn't need to grow in the vertical direction when docked
260 m_auimgr.GetPane( "SelectionFilter" ).dock_proportion = 0;
261
264 DragAcceptFiles( true );
265
267
268 // Apply saved visibility stuff at the end
269 wxAuiPaneInfo& treePane = m_auimgr.GetPane( "Footprints" );
270 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( "LayersManager" );
271
272 if( libWidth > 0 )
273 SetAuiPaneSize( m_auimgr, treePane, libWidth, -1 );
274
275 if( aui_cfg.right_panel_width > 0 )
276 SetAuiPaneSize( m_auimgr, layersManager, aui_cfg.right_panel_width, -1 );
277
278 m_appearancePanel->SetTabIndex( aui_cfg.appearance_panel_tab );
279
281 {
282 m_appearancePanel->SetUserLayerPresets( cfg->m_LayerPresets );
283 m_appearancePanel->ApplyLayerPreset( cfg->m_ActiveLayerPreset );
284 }
285
286 // restore the last footprint from the project, if any, after the library has been init'ed
287 // N.B. This needs to happen after the AUI manager has been initialized so that we can
288 // properly call the WX_INFOBAR without crashing on some systems.
290
291 // This displays the last footprint loaded, if any, so it must be done after restoreLastFootprint()
293
294 GetToolManager()->PostAction( ACTIONS::zoomFitScreen );
295 UpdateTitle();
297
299
300 // Default shutdown reason until a file is loaded
301 KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Footprint changes are unsaved" ) );
302
303 // Catch unhandled accelerator command characters that were no handled by the library tree
304 // panel.
306 Bind( wxEVT_CHAR_HOOK, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
307
308 // Ensure the window is on top
309 Raise();
310 Show( true );
311
312 // Register a call to update the toolbar sizes. It can't be done immediately because
313 // it seems to require some sizes calculated that aren't yet (at least on GTK).
314 CallAfter(
315 [this]()
316 {
317 // Ensure the controls on the toolbars all are correctly sized
319 m_treePane->FocusSearchFieldIfExists();
320
321 // Update the angle snap mode toolbar button to reflect the current preference
323 } );
324}
325
326
328{
329 // Shutdown all running tools
330 if( m_toolManager )
331 m_toolManager->ShutdownAllTools();
332
333 // save the footprint in the PROJECT
335
336 // Clear the watched file
337 setFPWatcher( nullptr );
338
339 // We passed ownership of these to wxAuiManager.
340 // delete m_selectionFilterPanel;
341 // delete m_appearancePanel;
342 // delete m_treePane;
343}
344
345
347{
349
350 FOOTPRINT* fp = static_cast<FOOTPRINT*>( GetModel() );
351
352 if( fp )
353 {
354 std::vector<MSG_PANEL_ITEM> msgItems;
355 fp->GetMsgPanelInfo( this, msgItems );
356 SetMsgPanel( msgItems );
357 }
358}
359
360
366
367
369{
370 return m_toolManager->GetTool<PCB_SELECTION_TOOL>()->GetSelection();
371}
372
373
375{
376 // switches currently used canvas (Cairo / OpenGL).
377 PCB_BASE_FRAME::SwitchCanvas( aCanvasType );
378
379 GetCanvas()->GetGAL()->SetAxesEnabled( true );
380
381 // The base class method *does not reinit* the layers manager. We must update the layer
382 // widget to match board visibility states, both layers and render columns, and and some
383 // settings dependent on the canvas.
385}
386
387
393
394
396{
397 wxAuiPaneInfo& treePane = m_auimgr.GetPane( m_treePane );
398 treePane.Show( !IsLibraryTreeShown() );
399
400 if( IsLibraryTreeShown() )
401 {
402 // SetAuiPaneSize also updates m_auimgr
403 SetAuiPaneSize( m_auimgr, treePane, m_editorSettings->m_LibWidth, -1 );
404 }
405 else
406 {
407 m_editorSettings->m_LibWidth = m_treePane->GetSize().x;
408 m_auimgr.Update();
409 }
410}
411
412
414{
415 m_treePane->FocusSearchFieldIfExists();
416}
417
418
420{
422 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( "LayersManager" );
423 wxAuiPaneInfo& selectionFilter = m_auimgr.GetPane( "SelectionFilter" );
424
425 // show auxiliary Vertical layers and visibility manager toolbar
427 layersManager.Show( m_show_layer_manager_tools );
428 selectionFilter.Show( m_show_layer_manager_tools );
429
431 {
432 SetAuiPaneSize( m_auimgr, layersManager, settings->m_AuiPanels.right_panel_width, -1 );
433 }
434 else
435 {
436 settings->m_AuiPanels.right_panel_width = m_appearancePanel->GetSize().x;
437 m_auimgr.Update();
438 }
439}
440
441
443{
444 return const_cast<wxAuiManager&>( m_auimgr ).GetPane( m_treePane ).IsShown();
445}
446
447
452
453
455{
456 LIB_ID id;
457
458 if( IsLibraryTreeShown() )
460
461 if( id.GetLibNickname().empty() )
462 id = GetLoadedFPID();
463
464 return id;
465}
466
467
469{
470 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
471
472 if( footprint )
473 return LIB_ID( footprint->GetFPID().GetLibNickname(), m_footprintNameWhenLoaded );
474 else
475 return LIB_ID();
476}
477
478
480{
481 if( GetBoard()->GetFirstFootprint() )
482 {
485 }
486
487 GetScreen()->SetContentModified( false );
488}
489
490
492{
493 // If we've already vetted closing this window, then we have no FP anymore
494 if( m_isClosing || !GetBoard() )
495 return false;
496
497 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
498
499 return ( footprint && footprint->GetLink() != niluuid );
500}
501
502
504{
505 LIB_ID id = GetLoadedFPID();
506
507 if( id.IsValid() )
508 {
510 Prj().SetRString( PROJECT::PCB_FOOTPRINT_EDITOR_FP_NAME, id.GetLibItemName() );
511 }
512}
513
514
516{
517 const wxString& footprintName = Prj().GetRString( PROJECT::PCB_FOOTPRINT_EDITOR_FP_NAME );
518 const wxString& libNickname = Prj().GetRString( PROJECT::PCB_FOOTPRINT_EDITOR_LIB_NICKNAME );
519
520 if( libNickname.Length() && footprintName.Length() )
521 {
522 LIB_ID id;
523 id.SetLibNickname( libNickname );
524 id.SetLibItemName( footprintName );
525
526 FOOTPRINT* footprint = loadFootprint( id );
527
528 if( footprint )
529 AddFootprintToBoard( footprint );
530 }
531}
532
533
535{
536 FOOTPRINT* footprint = static_cast<FOOTPRINT*>( GetModel() );
537 BOARD& board = *GetBoard();
538
539 // All FPs have these layers enabled
540 LSET enabledLayers = LSET::AllTechMask() | LSET::UserMask();
541
542 const auto configureStackup = [&]( FOOTPRINT_STACKUP aMode, const LSET& aLayerSet )
543 {
544 const LSET cuLayers = aLayerSet & LSET::AllCuMask();
545 board.SetCopperLayerCount( cuLayers.count() );
546
547 switch( aMode )
548 {
550 {
551 enabledLayers |= LSET{ F_Cu, In1_Cu, B_Cu };
552 enabledLayers |= LSET::UserDefinedLayersMask( 4 );
553 board.SetLayerName( In1_Cu, _( "Inner layers" ) );
554 break;
555 }
557 {
558 // Nothing extra to add
559
560 // Clear layer name defaults
561 board.SetLayerName( In1_Cu, wxEmptyString );
562 break;
563 }
564 }
565
566 enabledLayers |= aLayerSet;
567 };
568
569 if( footprint )
570 {
571 configureStackup( footprint->GetStackupMode(), footprint->GetStackupLayers() );
572 }
573 else
574 {
575 // If no footprint is loaded, we assume the default stackup mode
576 configureStackup( FOOTPRINT_STACKUP::EXPAND_INNER_LAYERS, LSET{} );
577 }
578
580 {
581 m_originalFootprintCopy->RunOnChildren(
582 [&]( BOARD_ITEM* child )
583 {
584 LSET childLayers = child->GetLayerSet() & LSET::UserDefinedLayersMask();
585
586 for( PCB_LAYER_ID layer : childLayers )
587 enabledLayers.set( layer );
588 },
590 }
591
592 // Enable any layers that the user has gone to the trouble to name
594 {
595 for( const PCB_LAYER_ID& user : LSET::UserDefinedLayersMask() )
596 {
597 if( cfg->m_DesignSettings.m_UserLayerNames.contains( LSET::Name( user ).ToStdString() ) )
598 enabledLayers.set( user );
599 }
600 }
601
602 board.SetEnabledLayers( enabledLayers );
603
604 // Footprint Editor layer visibility is kept in the view, not the board (because the board
605 // just delegates to the project file, which we don't have).
606 for( const PCB_LAYER_ID& layer : GetBoard()->GetEnabledLayers() )
607 GetCanvas()->GetView()->SetLayerVisible( layer, true );
608}
609
610
612{
614
615 m_originalFootprintCopy.reset( static_cast<FOOTPRINT*>( aFootprint->Clone() ) );
616 m_originalFootprintCopy->SetParent( nullptr );
617
619
621 // Ensure item UUIDs are valid
622 // ("old" footprints can have null uuids that create issues in fp editor)
623 aFootprint->FixUuids();
624
626
627 const wxString libName = aFootprint->GetFPID().GetLibNickname();
628
630 {
631 const wxString msg = wxString::Format( _( "Editing %s from board. Saving will update the board only." ),
632 aFootprint->GetReference() );
633 const wxString openLibLink = wxString::Format( _( "Open in library %s" ),
634 UnescapeString( libName ) );
635
636 const auto openLibraryCopy =
637 [this]( wxHyperlinkEvent& aEvent )
638 {
640 };
641
642 if( WX_INFOBAR* infobar = GetInfoBar() )
643 {
644 wxHyperlinkCtrl* button = new wxHyperlinkCtrl( infobar, wxID_ANY, openLibLink,
645 wxEmptyString );
646 button->Bind( wxEVT_COMMAND_HYPERLINK, openLibraryCopy );
647
648 infobar->RemoveAllButtons();
649 infobar->AddButton( button );
650 infobar->AddCloseButton();
651 infobar->ShowMessage( msg, wxICON_INFORMATION );
652 }
653 }
654 // An empty libname is OK - you get that when creating a new footprint from the main menu
655 // In that case. treat is as editable, and the user will be prompted for save-as when saving.
656 else if( !libName.empty()
657 && !PROJECT_PCB::PcbFootprintLibs( &Prj() )->IsFootprintLibWritable( libName ) )
658 {
659 wxString msg = wxString::Format( _( "Editing footprint from read-only library %s." ),
660 UnescapeString( libName ) );
661
662 if( WX_INFOBAR* infobar = GetInfoBar() )
663 {
664 wxString link = _( "Save as editable copy" );
665
666 const auto saveAsEditableCopy =
667 [this, aFootprint]( wxHyperlinkEvent& aEvent )
668 {
669 SaveFootprintAs( aFootprint );
670 };
671
672 wxHyperlinkCtrl* button = new wxHyperlinkCtrl( infobar, wxID_ANY, link, wxEmptyString );
673 button->Bind( wxEVT_COMMAND_HYPERLINK, saveAsEditableCopy );
674
675 infobar->RemoveAllButtons();
676 infobar->AddButton( button );
677 infobar->AddCloseButton();
678 infobar->ShowMessage( msg, wxICON_INFORMATION );
679 }
680 }
681 else
682 {
683 if( WX_INFOBAR* infobar = GetInfoBar() )
684 infobar->Dismiss();
685 }
686
689}
690
691
693{
694 ReloadFootprint( aFootprint );
695
697 setFPWatcher( nullptr );
698 else
699 setFPWatcher( aFootprint );
700}
701
702
707
708
713
714
716{
717 wxFAIL_MSG( wxT( "Plotting not supported in Footprint Editor" ) );
718
720}
721
722
724{
725 wxFAIL_MSG( wxT( "Plotting not supported in Footprint Editor" ) );
726}
727
728
736
737
745
746
748{
749 // Get our own settings; aCfg will be the PCBNEW_SETTINGS because we're part of the pcbnew
750 // compile unit
752
753 if( cfg )
754 {
756
758
761
763 m_selectionFilterPanel->SetCheckboxesFromFilter( cfg->m_SelectionFilter );
764
766
767 for( auto& [source_name, dest_name] : cfg->m_DesignSettings.m_UserLayerNames )
768 {
769 wxString wx_source_name = source_name;
770 PCB_LAYER_ID layer = static_cast<PCB_LAYER_ID>( LSET::NameToLayer( wx_source_name ) );
771
772 if( IsUserLayer( layer ) )
773 GetBoard()->SetLayerName( layer, dest_name );
774 }
775
776 }
777}
778
779
781{
782 // Load canvas type from the FOOTPRINT_EDITOR_SETTINGS:
784
785 // If we had an OpenGL failure this session, use the fallback GAL but don't update the
786 // user preference silently:
787
790}
791
792
794{
796
797 // Get our own settings; aCfg will be the PCBNEW_SETTINGS because we're part of the pcbnew
798 // compile unit
800
801 if( cfg )
802 {
804
807 cfg->m_LibWidth = m_treePane->GetSize().x;
809
811
813 {
814 cfg->m_AuiPanels.show_properties = m_propertiesPanel->IsShownOnScreen();
816 cfg->m_AuiPanels.properties_splitter = m_propertiesPanel->SplitterProportion();
817 }
818
820
822 {
825 cfg->m_LayerPresets = m_appearancePanel->GetUserLayerPresets();
826 cfg->m_ActiveLayerPreset = m_appearancePanel->GetActiveLayerPreset();
827 }
828 }
829}
830
831
832
834{
835 FOOTPRINT_EDITOR_SETTINGS* cfg = const_cast<FOOTPRINT_EDIT_FRAME*>( this )->GetSettings();
836
837 return cfg ? cfg->m_RotationAngle : ANGLE_90;
838}
839
840
841
843{
845 return ::GetColorSettings( cfg ? cfg->m_ColorTheme : DEFAULT_THEME );
846}
847
848
850{
851 static MAGNETIC_SETTINGS fallback;
852
854 return &cfg->m_MagneticItems;
855
856 return &fallback;
857}
858
859
860const BOX2I FOOTPRINT_EDIT_FRAME::GetDocumentExtents( bool aIncludeAllVisible ) const
861{
862 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
863
864 if( footprint )
865 {
866 bool hasGraphicalItem = footprint->Pads().size() || footprint->Zones().size();
867
868 if( !hasGraphicalItem )
869 {
870 for( const BOARD_ITEM* item : footprint->GraphicalItems() )
871 {
872 if( item->Type() == PCB_TEXT_T || item->Type() == PCB_TEXTBOX_T )
873 continue;
874
875 hasGraphicalItem = true;
876 break;
877 }
878 }
879
880 if( hasGraphicalItem )
881 {
882 return footprint->GetBoundingBox( false );
883 }
884 else
885 {
886 BOX2I newFootprintBB( { 0, 0 }, { 0, 0 } );
887 newFootprintBB.Inflate( pcbIUScale.mmToIU( 12 ) );
888 return newFootprintBB;
889 }
890 }
891
892 return GetBoardBoundingBox( false );
893}
894
895
897{
898 if( IsContentModified() )
899 {
900 wxString footprintName = GetBoard()->GetFirstFootprint()->GetReference();
901 wxString msg = _( "Save changes to '%s' before closing?" );
902
903 if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
904 [&]() -> bool
905 {
906 return SaveFootprint( GetBoard()->GetFirstFootprint() );
907 } ) )
908 {
909 return false;
910 }
911 }
912
913 if( doClose )
914 {
915 GetInfoBar()->ShowMessageFor( wxEmptyString, 1 );
916 Clear_Pcb( false );
917 UpdateTitle();
918 }
919
920 return true;
921}
922
923
924bool FOOTPRINT_EDIT_FRAME::canCloseWindow( wxCloseEvent& aEvent )
925{
926 if( IsContentModified() )
927 {
928 // Shutdown blocks must be determined and vetoed as early as possible
930 aEvent.GetId() == wxEVT_QUERY_END_SESSION )
931 {
932 aEvent.Veto();
933 return false;
934 }
935
936 wxString footprintName = GetBoard()->GetFirstFootprint()->GetFPID().GetLibItemName();
937
939 footprintName = GetBoard()->GetFirstFootprint()->GetReference();
940
941 wxString msg = _( "Save changes to '%s' before closing?" );
942
943 if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
944 [&]() -> bool
945 {
946 return SaveFootprint( GetBoard()->GetFirstFootprint() );
947 } ) )
948 {
949 aEvent.Veto();
950 return false;
951 }
952 }
953
954 PAD_TOOL* padTool = m_toolManager->GetTool<PAD_TOOL>();
955
956 if( padTool->InPadEditMode() )
957 padTool->ExitPadEditMode();
958
959 // Save footprint tree column widths
960 m_adapter->SaveSettings();
961
963}
964
965
967{
968 // No more vetos
969 GetCanvas()->SetEventDispatcher( nullptr );
971
972 if( GetLibTree() )
974
975 // Do not show the layer manager during closing to avoid flicker
976 // on some platforms (Windows) that generate useless redraw of items in
977 // the Layer Manager
978 m_auimgr.GetPane( wxT( "LayersManager" ) ).Show( false );
979 m_auimgr.GetPane( wxT( "SelectionFilter" ) ).Show( false );
980
981 Clear_Pcb( false );
982
984
985 if( mgr->IsProjectOpen() && wxFileName::IsDirWritable( Prj().GetProjectPath() ) )
986 {
987 GFootprintList.WriteCacheToFile( Prj().GetProjectPath() + wxT( "fp-info-cache" ) );
988 }
989}
990
991
992void FOOTPRINT_EDIT_FRAME::OnExitKiCad( wxCommandEvent& event )
993{
994 Kiway().OnKiCadExit();
995}
996
997
999{
1000 Close();
1001}
1002
1003
1005{
1006 // call my base class
1008
1009 // We have 2 panes to update.
1010 // For some obscure reason, the AUI manager hides the first modified pane.
1011 // So force show panes
1012 wxAuiPaneInfo& tree_pane_info = m_auimgr.GetPane( m_treePane );
1013 bool tree_shown = tree_pane_info.IsShown();
1014 tree_pane_info.Caption( _( "Libraries" ) );
1015
1016 wxAuiPaneInfo& lm_pane_info = m_auimgr.GetPane( m_appearancePanel );
1017 bool lm_shown = lm_pane_info.IsShown();
1018 lm_pane_info.Caption( _( "Appearance" ) );
1019 wxAuiPaneInfo& sf_pane_info = m_auimgr.GetPane( m_selectionFilterPanel );
1020 sf_pane_info.Caption( _( "Selection Filter" ) );
1021
1022 // update the layer manager
1024
1025 // Now restore the visibility:
1026 lm_pane_info.Show( lm_shown );
1027 tree_pane_info.Show( tree_shown );
1028 m_auimgr.Update();
1029
1031
1032 UpdateTitle();
1033}
1034
1035
1037{
1039
1040 if( m_isClosing )
1041 return;
1042
1043 Update3DView( true, true );
1045
1046 if( !GetTitle().StartsWith( wxT( "*" ) ) )
1047 UpdateTitle();
1048}
1049
1050
1052{
1053 wxString title;
1054 LIB_ID fpid = GetLoadedFPID();
1055 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
1056 bool writable = true;
1057
1058 if( IsCurrentFPFromBoard() )
1059 {
1060 if( IsContentModified() )
1061 title = wxT( "*" );
1062
1063 title += footprint->GetReference();
1064 title += wxS( " " ) + wxString::Format( _( "[from %s]" ), Prj().GetProjectName()
1065 + wxT( "." )
1066 + FILEEXT::PcbFileExtension );
1067 }
1068 else if( fpid.IsValid() )
1069 {
1070 try
1071 {
1073 }
1074 catch( const IO_ERROR& )
1075 {
1076 // best efforts...
1077 }
1078
1079 // Note: don't used GetLoadedFPID(); footprint name may have been edited
1080 if( IsContentModified() )
1081 title = wxT( "*" );
1082
1083 title += From_UTF8( footprint->GetFPID().Format().c_str() );
1084
1085 if( !writable )
1086 title += wxS( " " ) + _( "[Read Only]" );
1087 }
1088 else if( !fpid.GetLibItemName().empty() )
1089 {
1090 // Note: don't used GetLoadedFPID(); footprint name may have been edited
1091 if( IsContentModified() )
1092 title = wxT( "*" );
1093
1094 title += From_UTF8( footprint->GetFPID().GetLibItemName().c_str() );
1095 title += wxS( " " ) + _( "[Unsaved]" );
1096 }
1097 else
1098 {
1099 title = _( "[no footprint loaded]" );
1100 }
1101
1102 title += wxT( " \u2014 " ) + _( "Footprint Editor" );
1103
1104 SetTitle( title );
1105}
1106
1107
1109{
1110 m_appearancePanel->OnBoardChanged();
1111}
1112
1113
1115{
1119 m_propertiesPanel->UpdateData();
1120 UpdateTitle();
1121}
1122
1123
1125{
1127
1128 WX_PROGRESS_REPORTER progressReporter( this, _( "Load Footprint Libraries" ), 1, PR_CAN_ABORT );
1129
1130 if( GFootprintList.GetCount() == 0 )
1131 GFootprintList.ReadCacheFromFile( Prj().GetProjectPath() + wxT( "fp-info-cache" ) );
1132
1133 GFootprintList.ReadFootprintFiles( fpTable, nullptr, &progressReporter );
1134 progressReporter.Show( false );
1135
1136 if( GFootprintList.GetErrorCount() )
1137 GFootprintList.DisplayErrors( this );
1138
1140 auto adapter = static_cast<FP_TREE_SYNCHRONIZING_ADAPTER*>( m_adapter.get() );
1141
1142 adapter->AddLibraries( this );
1143}
1144
1145
1147{
1149 auto adapter = static_cast<FP_TREE_SYNCHRONIZING_ADAPTER*>( m_adapter.get() );
1150 LIB_ID target = GetTargetFPID();
1151 bool targetSelected = ( target == GetLibTree()->GetSelectedLibId() );
1152
1153 // Sync FOOTPRINT_INFO list to the libraries on disk
1154 if( aProgress )
1155 {
1156 WX_PROGRESS_REPORTER progressReporter( this, _( "Update Footprint Libraries" ), 1, PR_CAN_ABORT );
1157 GFootprintList.ReadFootprintFiles( fpTable, nullptr, &progressReporter );
1158 progressReporter.Show( false );
1159 }
1160 else
1161 {
1162 GFootprintList.ReadFootprintFiles( fpTable, nullptr, nullptr );
1163 }
1164
1165 // Unselect before syncing to avoid null reference in the adapter
1166 // if a selected item is removed during the sync
1167 GetLibTree()->Unselect();
1168
1169 // Sync the LIB_TREE to the FOOTPRINT_INFO list
1170 adapter->Sync( fpTable );
1171
1172 GetLibTree()->Regenerate( true );
1173
1174 if( target.IsValid() )
1175 {
1176 if( adapter->FindItem( target ) )
1177 {
1178 if( targetSelected )
1179 GetLibTree()->SelectLibId( target );
1180 else
1181 GetLibTree()->CenterLibId( target );
1182 }
1183 else
1184 {
1185 // Try to focus on parent
1186 target.SetLibItemName( wxEmptyString );
1187 GetLibTree()->CenterLibId( target );
1188 }
1189 }
1190}
1191
1192
1197
1198
1200{
1201 GetLibTree()->SelectLibId( aLibID );
1202}
1203
1204
1206{
1207 m_appearancePanel->UpdateDisplayOptions();
1208}
1209
1210
1212{
1213 // Create the manager and dispatcher & route draw panel events to the dispatcher
1215 m_toolManager->SetEnvironment( GetBoard(), GetCanvas()->GetView(),
1216 GetCanvas()->GetViewControls(), config(), this );
1217 m_actions = new PCB_ACTIONS();
1219
1221
1222 m_toolManager->RegisterTool( new COMMON_CONTROL );
1223 m_toolManager->RegisterTool( new COMMON_TOOLS );
1224 m_toolManager->RegisterTool( new PCB_SELECTION_TOOL );
1225 m_toolManager->RegisterTool( new ZOOM_TOOL );
1226 m_toolManager->RegisterTool( new EDIT_TOOL );
1227 m_toolManager->RegisterTool( new PCB_EDIT_TABLE_TOOL );
1228 m_toolManager->RegisterTool( new PAD_TOOL );
1229 m_toolManager->RegisterTool( new DRAWING_TOOL );
1230 m_toolManager->RegisterTool( new PCB_POINT_EDITOR );
1231 m_toolManager->RegisterTool( new PCB_CONTROL ); // copy/paste
1232 m_toolManager->RegisterTool( new LIBRARY_EDITOR_CONTROL );
1233 m_toolManager->RegisterTool( new FOOTPRINT_EDITOR_CONTROL );
1234 m_toolManager->RegisterTool( new ALIGN_DISTRIBUTE_TOOL );
1235 m_toolManager->RegisterTool( new PCB_PICKER_TOOL );
1236 m_toolManager->RegisterTool( new POSITION_RELATIVE_TOOL );
1237 m_toolManager->RegisterTool( new ARRAY_TOOL );
1238 m_toolManager->RegisterTool( new PCB_VIEWER_TOOLS );
1239 m_toolManager->RegisterTool( new PCB_GROUP_TOOL );
1240 m_toolManager->RegisterTool( new CONVERT_TOOL );
1241 m_toolManager->RegisterTool( new SCRIPTING_TOOL );
1242 m_toolManager->RegisterTool( new PROPERTIES_TOOL );
1243 m_toolManager->RegisterTool( new EMBED_TOOL );
1244
1245 for( TOOL_BASE* tool : m_toolManager->Tools() )
1246 {
1247 if( PCB_TOOL_BASE* pcbTool = dynamic_cast<PCB_TOOL_BASE*>( tool ) )
1248 pcbTool->SetIsFootprintEditor( true );
1249 }
1250
1251 m_toolManager->GetTool<PCB_VIEWER_TOOLS>()->SetFootprintFrame( true );
1252 m_toolManager->InitTools();
1253
1254 m_toolManager->InvokeTool( "common.InteractiveSelection" );
1255
1256 // Load or reload wizard plugins in case they changed since the last time the frame opened
1257 // Because the board editor has also a plugin python menu,
1258 // call the PCB_EDIT_FRAME RunAction() if the board editor is running
1259 // Otherwise run the current RunAction().
1260 PCB_EDIT_FRAME* pcbframe = static_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
1261
1262 if( pcbframe )
1264 else
1266}
1267
1268
1270{
1272
1273 ACTION_MANAGER* mgr = m_toolManager->GetActionManager();
1274 PCB_EDITOR_CONDITIONS cond( this );
1275
1276 wxASSERT( mgr );
1277
1278#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
1279#define CHECK( x ) ACTION_CONDITIONS().Check( x )
1280
1281 auto haveFootprintCond =
1282 [this]( const SELECTION& )
1283 {
1284 return GetBoard() && GetBoard()->GetFirstFootprint() != nullptr;
1285 };
1286
1287 auto footprintTargettedCond =
1288 [this]( const SELECTION& )
1289 {
1290 return !GetTargetFPID().GetLibItemName().empty();
1291 };
1292
1293 const auto footprintFromBoardCond =
1294 [this]( const SELECTION& )
1295 {
1296 return IsCurrentFPFromBoard();
1297 };
1298
1299 auto pcbFrameExistsCond =
1300 [this]( const SELECTION& )
1301 {
1302 PCB_EDIT_FRAME* frame = dynamic_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
1303
1304 return ( frame != nullptr );
1305 };
1306
1307 auto boardFootprintExistsCond =
1308 [this]( const SELECTION& )
1309 {
1310 PCB_EDIT_FRAME* frame = dynamic_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
1311
1312 FOOTPRINT* editorFootprint = GetBoard()->GetFirstFootprint();
1313 bool canInsert = frame && editorFootprint && editorFootprint->GetLink() == niluuid;
1314
1315 // If the source was deleted, the footprint can inserted but not updated in the board.
1316 if( frame && editorFootprint && editorFootprint->GetLink() != niluuid )
1317 {
1318 BOARD* mainpcb = frame->GetBoard();
1319 canInsert = true;
1320
1321 // search if the source footprint was not deleted:
1322 for( FOOTPRINT* candidate : mainpcb->Footprints() )
1323 {
1324 if( editorFootprint->GetLink() == candidate->m_Uuid )
1325 {
1326 canInsert = false;
1327 break;
1328 }
1329 }
1330 }
1331
1332 return canInsert;
1333 };
1334
1335 // clang-format off
1336 mgr->SetConditions( ACTIONS::saveAs, ENABLE( footprintTargettedCond ) );
1339 mgr->SetConditions( PCB_ACTIONS::editLibFpInFpEditor,ENABLE( footprintFromBoardCond ) );
1340
1341 mgr->SetConditions( PCB_ACTIONS::saveFpToBoard, ENABLE( boardFootprintExistsCond ) );
1342 mgr->SetConditions( PCB_ACTIONS::loadFpFromBoard, ENABLE( pcbFrameExistsCond ) );
1343
1346
1349
1350 mgr->SetConditions( ACTIONS::cut, ENABLE( cond.HasItems() ) );
1351 mgr->SetConditions( ACTIONS::copy, ENABLE( cond.HasItems() ) );
1358
1365
1369
1372 // clang-format on
1373
1374 auto highContrastCond =
1375 [this]( const SELECTION& )
1376 {
1378 };
1379
1380 auto boardFlippedCond =
1381 [this]( const SELECTION& )
1382 {
1383 return GetCanvas() && GetCanvas()->GetView()->IsMirroredX();
1384 };
1385
1386 auto libraryTreeCond =
1387 [this](const SELECTION& )
1388 {
1389 return IsLibraryTreeShown();
1390 };
1391
1392 auto layerManagerCond =
1393 [this]( const SELECTION& )
1394 {
1395 return m_auimgr.GetPane( "LayersManager" ).IsShown();
1396 };
1397
1398 auto propertiesCond =
1399 [this] ( const SELECTION& )
1400 {
1401 return m_auimgr.GetPane( PropertiesPaneName() ).IsShown();
1402 };
1403
1404 mgr->SetConditions( ACTIONS::highContrastMode, CHECK( highContrastCond ) );
1405 mgr->SetConditions( PCB_ACTIONS::flipBoard, CHECK( boardFlippedCond ) );
1407
1408 mgr->SetConditions( ACTIONS::showLibraryTree, CHECK( libraryTreeCond ) );
1409 mgr->SetConditions( PCB_ACTIONS::showLayersManager, CHECK( layerManagerCond ) );
1410 mgr->SetConditions( ACTIONS::showProperties, CHECK( propertiesCond ) );
1411
1412 mgr->SetConditions( ACTIONS::print, ENABLE( haveFootprintCond ) );
1413 mgr->SetConditions( PCB_ACTIONS::exportFootprint, ENABLE( haveFootprintCond ) );
1414 mgr->SetConditions( PCB_ACTIONS::placeImportedGraphics, ENABLE( haveFootprintCond ) );
1415
1416 mgr->SetConditions( PCB_ACTIONS::footprintProperties, ENABLE( haveFootprintCond ) );
1417 mgr->SetConditions( PCB_ACTIONS::padTable, ENABLE( haveFootprintCond ) );
1418 mgr->SetConditions( PCB_ACTIONS::editTextAndGraphics, ENABLE( haveFootprintCond ) );
1419 mgr->SetConditions( PCB_ACTIONS::checkFootprint, ENABLE( haveFootprintCond ) );
1420 mgr->SetConditions( PCB_ACTIONS::repairFootprint, ENABLE( haveFootprintCond ) );
1421 mgr->SetConditions( PCB_ACTIONS::cleanupGraphics, ENABLE( haveFootprintCond ) );
1422 mgr->SetConditions( ACTIONS::showDatasheet, ENABLE( haveFootprintCond ) );
1423
1424 const auto isArcKeepCenterMode =
1425 [this]( const SELECTION& )
1426 {
1428 };
1429
1430 const auto isArcKeepEndpointMode =
1431 [this]( const SELECTION& )
1432 {
1434 };
1435
1436 const auto isArcKeepRadiusMode =
1437 [this]( const SELECTION& )
1438 {
1440 };
1441
1442 // clang-format off
1443 mgr->SetConditions( ACTIONS::pointEditorArcKeepCenter, CHECK( isArcKeepCenterMode ) );
1444 mgr->SetConditions( ACTIONS::pointEditorArcKeepEndpoint, CHECK( isArcKeepEndpointMode ) );
1445 mgr->SetConditions( ACTIONS::pointEditorArcKeepRadius, CHECK( isArcKeepRadiusMode ) );
1446 // clang-format on
1447
1448// Only enable a tool if the part is edtable
1449#define CURRENT_EDIT_TOOL( action ) \
1450 mgr->SetConditions( action, ACTION_CONDITIONS().Enable( haveFootprintCond ) \
1451 .Check( cond.CurrentTool( action ) ) )
1452
1477
1478#undef CURRENT_EDIT_TOOL
1479#undef ENABLE
1480#undef CHECK
1481}
1482
1483
1485{
1487
1488 // Be sure the axis are enabled
1489 GetCanvas()->GetGAL()->SetAxesEnabled( true );
1490
1491 UpdateView();
1492
1493 // Ensure the m_Layers settings are using the canvas type:
1495}
1496
1497
1499{
1501
1503 {
1504 GetGalDisplayOptions().ReadWindowSettings( cfg->m_Window );
1505
1506 GetBoard()->GetDesignSettings() = cfg->m_DesignSettings;
1508 }
1509
1513
1515
1516 if( aFlags & ENVVARS_CHANGED )
1517 SyncLibraryTree( true );
1518
1519 Layout();
1520 SendSizeEvent();
1521}
1522
1523
1524std::unique_ptr<GRID_HELPER> FOOTPRINT_EDIT_FRAME::MakeGridHelper()
1525{
1526 return std::make_unique<PCB_GRID_HELPER>( m_toolManager, GetMagneticItemsSettings() );
1527}
1528
1529
1531{
1532 LIB_ID id = GetLoadedFPID();
1533
1534 if( id.empty() )
1535 {
1536 DisplayErrorMessage( this, _( "No footprint selected." ) );
1537 return;
1538 }
1539
1540 wxFileName fn( id.GetLibItemName() );
1541 fn.SetExt( wxT( "png" ) );
1542
1543 wxString projectPath = wxPathOnly( Prj().GetProjectFullName() );
1544
1545 wxFileDialog dlg( this, _( "Export View as PNG" ), projectPath, fn.GetFullName(),
1546 FILEEXT::PngFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1547
1548 if( dlg.ShowModal() == wxID_CANCEL || dlg.GetPath().IsEmpty() )
1549 return;
1550
1551 // calling wxYield is mandatory under Linux, after closing the file selector dialog
1552 // to refresh the screen before creating the PNG or JPEG image from screen
1553 wxYield();
1554 this->SaveCanvasImageToFile( dlg.GetPath(), BITMAP_TYPE::PNG );
1555}
@ KEEP_ENDPOINTS_OR_START_DIRECTION
Whe editing endpoints, the other end remains in place.
@ KEEP_CENTER_ENDS_ADJUST_ANGLE
When editing endpoints, only the angle is adjusted.
@ KEEP_CENTER_ADJUST_ANGLE_RADIUS
When editing endpoints, the angle and radius are adjusted.
constexpr EDA_IU_SCALE pcbIUScale
Definition base_units.h:112
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
@ icon_modedit_32
@ icon_modedit_16
@ FPHOLDER
Definition board.h:314
@ NORMAL
Inactive layers are shown normally (no high-contrast mode)
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
static TOOL_ACTION toggleGrid
Definition actions.h:197
static TOOL_ACTION paste
Definition actions.h:80
static TOOL_ACTION unselectAll
Definition actions.h:83
static TOOL_ACTION revert
Definition actions.h:62
static TOOL_ACTION showLibraryTree
Definition actions.h:163
static TOOL_ACTION saveAs
Definition actions.h:59
static TOOL_ACTION copy
Definition actions.h:78
static TOOL_ACTION pluginsReload
Definition actions.h:295
static TOOL_ACTION group
Definition actions.h:238
static TOOL_ACTION pasteSpecial
Definition actions.h:81
static TOOL_ACTION showDatasheet
Definition actions.h:266
static TOOL_ACTION pointEditorArcKeepCenter
Definition actions.h:274
static TOOL_ACTION ungroup
Definition actions.h:239
static TOOL_ACTION toggleBoundingBoxes
Definition actions.h:156
static TOOL_ACTION pointEditorArcKeepRadius
Definition actions.h:276
static TOOL_ACTION undo
Definition actions.h:75
static TOOL_ACTION duplicate
Definition actions.h:84
static TOOL_ACTION highContrastMode
Definition actions.h:154
static TOOL_ACTION embeddedFiles
Definition actions.h:298
static TOOL_ACTION measureTool
Definition actions.h:251
static TOOL_ACTION doDelete
Definition actions.h:85
static TOOL_ACTION selectionTool
Definition actions.h:250
static TOOL_ACTION save
Definition actions.h:58
static TOOL_ACTION zoomFitScreen
Definition actions.h:141
static TOOL_ACTION redo
Definition actions.h:76
static TOOL_ACTION deleteTool
Definition actions.h:86
static TOOL_ACTION zoomTool
Definition actions.h:145
static TOOL_ACTION print
Definition actions.h:64
static TOOL_ACTION showProperties
Definition actions.h:265
static TOOL_ACTION cut
Definition actions.h:77
static TOOL_ACTION gridSetOrigin
Definition actions.h:194
static TOOL_ACTION ddAddLibrary
Definition actions.h:67
static TOOL_ACTION toggleGridOverrides
Definition actions.h:198
static TOOL_ACTION selectAll
Definition actions.h:82
static TOOL_ACTION pointEditorArcKeepEndpoint
Definition actions.h:275
Manage TOOL_ACTION objects.
void SetConditions(const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
Set the conditions the UI elements for activating a specific tool action should use for determining t...
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
wxString m_ColorTheme
Active color theme name.
The array tool.
Definition array_tool.h:48
bool IsContentModified() const
Definition base_screen.h:60
void SetContentModified(bool aModified=true)
Definition base_screen.h:59
BASE_SET & set(size_t pos)
Definition base_set.h:116
Container for design settings for a BOARD object.
std::shared_ptr< NET_SETTINGS > m_NetSettings
std::map< std::string, wxString > m_UserLayerNames
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
virtual LSET GetLayerSet() const
Return a std::bitset of all layers on which the item physically resides.
Definition board_item.h:252
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:322
void SetBoardUse(BOARD_USE aUse)
Set what the board is going to be used for.
Definition board.h:334
bool SetLayerName(PCB_LAYER_ID aLayer, const wxString &aLayerName)
Changes the name of the layer given by aLayer.
Definition board.cpp:710
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
const FOOTPRINTS & Footprints() const
Definition board.h:363
void SetCopperLayerCount(int aCount)
Definition board.cpp:882
void DeleteAllFootprints()
Remove all footprints from the deque and free the memory associated with them.
Definition board.cpp:1722
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition board.cpp:1041
void SetEnabledLayers(const LSET &aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
Definition board.cpp:944
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.
Tool responsible for drawing graphical elements like lines, arcs, circles, etc.
void CommonSettingsChanged(int aFlags) override
Notification event that some of the common (suite-wide) settings have changed.
void ShowChangedLanguage() override
Redraw the menus and what not in current language.
virtual void setupUIConditions()
Setup the UI conditions for the various actions and their controls in this frame.
virtual void UpdateToolbarControlSizes()
Update the sizes of any controls in the toolbars of the frame.
ACTION_TOOLBAR * m_tbRight
TOOLBAR_SETTINGS * m_toolbarSettings
wxAuiManager m_auimgr
virtual void RecreateToolbars()
ACTION_TOOLBAR * m_tbLeft
virtual void OnSize(wxSizeEvent &aEvent)
virtual bool canCloseWindow(wxCloseEvent &aCloseEvent)
virtual void OnDropFiles(wxDropFilesEvent &aEvent)
Handle event fired when a file is dropped to the window.
std::map< const wxString, TOOL_ACTION * > m_acceptedExts
Associate file extensions with action to execute.
ACTION_TOOLBAR * m_tbTopMain
wxString m_aboutTitle
bool m_isClosing
Set by the close window event handler after frames are asked if they can close.
void ReCreateMenuBar()
Recreate the menu bar.
WX_INFOBAR * GetInfoBar()
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
The current canvas type.
void OnSelectGrid(wxCommandEvent &event)
Command event handler for selecting grid sizes.
void setupUnits(APP_SETTINGS_BASE *aCfg)
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
bool SaveCanvasImageToFile(const wxString &aFileName, BITMAP_TYPE aBitmapType)
Save the current view as an image file.
virtual void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Change the current rendering backend.
virtual void OnSelectZoom(wxCommandEvent &event)
Set the zoom factor when selected by the zoom list box in the main tool bar.
GAL_DISPLAY_OPTIONS_IMPL & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
static bool m_openGLFailureOccured
Has any failure occurred when switching to OpenGL in any EDA_DRAW_FRAME?
static const wxString PropertiesPaneName()
EDA_MSG_PANEL * m_messagePanel
void SetCanvas(EDA_DRAW_PANEL_GAL *aPanel)
virtual void SetScreen(BASE_SCREEN *aScreen)
virtual void UpdateMsgPanel()
Redraw the message panel.
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting()
Return the canvas type stored in the application settings.
PROPERTIES_PANEL * m_propertiesPanel
bool m_showBorderAndTitleBlock
static constexpr GAL_TYPE GAL_FALLBACK
void StopDrawing()
Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.
void ForceRefresh()
Force a redraw.
@ GAL_TYPE_OPENGL
OpenGL implementation.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Set a dispatcher that processes events and forwards them to tools.
Specialization of the wxAuiPaneInfo class for KiCad panels.
SELECTION_CONDITION NoActiveTool()
Create a functor testing if there are no tools active in the frame.
SELECTION_CONDITION BoundingBoxes()
SELECTION_CONDITION RedoAvailable()
Create a functor that tests if there are any items in the redo queue.
SELECTION_CONDITION CurrentTool(const TOOL_ACTION &aTool)
Create a functor testing if the specified tool is the current active tool in the frame.
virtual SELECTION_CONDITION UndoAvailable()
Create a functor that tests if there are any items in the undo queue.
SELECTION_CONDITION GridVisible()
Create a functor testing if the grid is visible in a frame.
SELECTION_CONDITION ContentModified()
Create a functor that tests if the content of the frame is modified.
SELECTION_CONDITION GridOverrides()
Create a functor testing if the grid overrides wires is enabled in a frame.
Module editor specific tools.
BOARD_DESIGN_SETTINGS m_DesignSettings
Only some of these settings are actually used for footprint editing.
std::vector< LAYER_PRESET > m_LayerPresets
PCB_SELECTION_FILTER_OPTIONS m_SelectionFilter
void CloseFootprintEditor(wxCommandEvent &Event)
BOARD_DESIGN_SETTINGS & GetDesignSettings() const override
Return the BOARD_DESIGN_SETTINGS for the open project.
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
void HardRedraw() override
Refresh the library tree and redraw the window.
static const wxChar * GetFootprintEditorFrameName()
void SyncLibraryTree(bool aProgress)
Synchronize the footprint library tree to the current state of the footprint library table.
void OnSaveFootprintAsPng(wxCommandEvent &event)
bool SaveFootprintAs(FOOTPRINT *aFootprint)
void FocusLibraryTreeInput() override
BOARD_ITEM_CONTAINER * GetModel() const override
void ReCreateLayerBox(bool aForceResizeToolbar=true)
Re create the layer Box by clearing the old list, and building a new one from the new layers names an...
LIB_TREE * GetLibTree() const override
bool canCloseWindow(wxCloseEvent &Event) override
void UpdateMsgPanel() override
Redraw the message panel.
LIB_ID GetTargetFPID() const
Return the LIB_ID of the part selected in the footprint tree, or the loaded part if there is no selec...
LIB_ID GetLoadedFPID() const
Return the LIB_ID of the part being edited.
APP_SETTINGS_BASE * config() const override
Return the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
void SetPlotSettings(const PCB_PLOT_PARAMS &aSettings) override
bool SaveFootprint(FOOTPRINT *aFootprint)
Save in an existing library a given footprint.
void initLibraryTree()
Make sure the footprint info list is loaded (with a progress dialog) and then initialize the footprin...
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
void ShowChangedLanguage() override
Update visible items after a language change.
void resolveCanvasType() override
Determines the Canvas type to load (with prompt if required) and initializes m_canvasType.
void CommonSettingsChanged(int aFlags) override
Called after the preferences dialog is run.
bool IsContentModified() const override
Get if any footprints or libraries have been modified but not saved.
void UpdateUserInterface()
Update the layer manager and other widgets from the board setup (layer and items visibility,...
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > m_adapter
bool IsLibraryTreeShown() const override
FOOTPRINT_EDITOR_SETTINGS * m_editorSettings
const BOX2I GetDocumentExtents(bool aIncludeAllVisible=true) const override
Return bounding box of document with option to not include some items.
bool Clear_Pcb(bool doAskAboutUnsavedChanges)
Delete all and reinitialize the current board.
Definition initpcb.cpp:108
FOOTPRINT_EDIT_FRAME(KIWAY *aKiway, wxWindow *aParent)
protected so only friend PCB::IFACE::CreateWindow() can act as sole factory.
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
bool CanCloseFPFromBoard(bool doClose)
void SetActiveLayer(PCB_LAYER_ID aLayer) override
void AddFootprintToBoard(FOOTPRINT *aFootprint) override
Override from PCB_BASE_EDIT_FRAME which adds a footprint to the editor's dummy board,...
void OnModify() override
Must be called after a footprint change in order to set the "modify" flag of the current screen and p...
FOOTPRINT_TREE_PANE * m_treePane
std::unique_ptr< GRID_HELPER > MakeGridHelper() override
void OnDisplayOptionsChanged() override
void FocusOnLibID(const LIB_ID &aLibID)
const PCB_PLOT_PARAMS & GetPlotSettings() const override
Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.
std::unique_ptr< FOOTPRINT > m_originalFootprintCopy
void ReloadFootprint(FOOTPRINT *aFootprint) override
Override from PCB_BASE_FRAME which reloads the footprint from the library without setting the footpri...
EDA_ANGLE GetRotationAngle() const override
Return the angle used for rotate operations.
void RefreshLibraryTree()
Redisplay the library tree.
void OnExitKiCad(wxCommandEvent &aEvent)
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
MAGNETIC_SETTINGS * GetMagneticItemsSettings() override
FOOTPRINT_EDITOR_SETTINGS * GetSettings()
void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType) override
Switch the currently used canvas (Cairo / OpenGL).
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
Footprint Editor pane with footprint library tree.
bool FixUuids()
Old footprints do not always have a valid UUID (some can be set to null uuid) However null UUIDs,...
ZONES & Zones()
Definition footprint.h:230
EDA_ITEM * Clone() const override
Invoke a function on all children.
std::deque< PAD * > & Pads()
Definition footprint.h:224
const LIB_ID & GetFPID() const
Definition footprint.h:269
const LSET & GetStackupLayers() const
Definition footprint.h:325
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
KIID GetLink() const
Definition footprint.h:886
const wxString & GetReference() const
Definition footprint.h:661
FOOTPRINT_STACKUP GetStackupMode() const
Definition footprint.h:318
DRAWINGS & GraphicalItems()
Definition footprint.h:227
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
bool IsFootprintLibWritable(const wxString &aNickname)
Return true if the library given by aNickname is writable.
void AddLibraries(EDA_BASE_FRAME *aParent)
static wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > Create(FOOTPRINT_EDIT_FRAME *aFrame, FP_LIB_TABLE *aLibs)
void ReadWindowSettings(WINDOW_SETTINGS &aCfg)
Read GAL config options from application-level config.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
bool m_axesEnabled
Crosshair drawing mode.
void SetAxesEnabled(bool aAxesEnabled)
Enable drawing the axes.
void UpdateAllLayersColor()
Apply the new coloring scheme to all layers.
Definition view.cpp:775
void SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
Definition view.h:400
bool IsMirroredX() const
Return true if view is flipped across the X axis.
Definition view.h:250
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition view.h:639
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:286
void OnKiCadExit()
Definition kiway.cpp:717
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
Module editor specific tools.
A logical library item identifier and consists of various portions much like a URI.
Definition lib_id.h:49
int SetLibItemName(const UTF8 &aLibItemName)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition lib_id.cpp:111
bool IsValid() const
Check if this LID_ID is valid.
Definition lib_id.h:172
int SetLibNickname(const UTF8 &aLibNickname)
Override the logical library name portion of the LIB_ID to aLibNickname.
Definition lib_id.cpp:100
UTF8 Format() const
Definition lib_id.cpp:119
const wxString GetUniStringLibItemName() const
Get strings for display messages in dialogs.
Definition lib_id.h:112
const UTF8 & GetLibItemName() const
Definition lib_id.h:102
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition lib_id.h:87
void RefreshLibTree()
Refresh the tree (mainly to update highlighting and asterisking)
Definition lib_tree.cpp:472
void CenterLibId(const LIB_ID &aLibId)
Ensure that an item is visible (preferably centered).
Definition lib_tree.cpp:381
void ShutdownPreviews()
Definition lib_tree.cpp:287
void ShowChangedLanguage()
Definition lib_tree.cpp:304
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
Definition lib_tree.cpp:375
LIB_TREE_MODEL_ADAPTER::SORT_MODE GetSortMode() const
Definition lib_tree.h:155
void Unselect()
Unselect currently selected item in wxDataViewCtrl.
Definition lib_tree.cpp:387
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit symbols, if the user selects the symbol itself rather than picking an individual unit,...
Definition lib_tree.cpp:314
void Regenerate(bool aKeepState)
Regenerate the tree.
Definition lib_tree.cpp:454
void SetSortMode(LIB_TREE_MODEL_ADAPTER::SORT_MODE aMode)
Save/restore the sorting mode.
Definition lib_tree.h:154
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
static const LSET & UserMask()
Definition lset.cpp:673
static int NameToLayer(wxString &aName)
Return the layer number from a layer name.
Definition lset.cpp:117
static const LSET & AllTechMask()
Return a mask holding all technical layers (no CU layer) on both side.
Definition lset.cpp:659
static LSET UserDefinedLayersMask(int aUserDefinedLayerCount=MAX_USER_DEFINED_LAYERS)
Return a mask with the requested number of user defined layers.
Definition lset.cpp:687
static LSET AllCuMask()
return AllCuMask( MAX_CU_LAYERS );
Definition lset.cpp:591
static wxString Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
Definition lset.cpp:188
void SetClearance(int aClearance)
Definition netclass.h:119
std::shared_ptr< NETCLASS > GetDefaultNetclass()
Gets the default netclass for the project.
void ExitPadEditMode()
Definition pad_tool.cpp:834
bool InPadEditMode()
Definition pad_tool.h:63
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition page_info.h:79
Gather all the actions that are shared by tools.
Definition pcb_actions.h:51
static TOOL_ACTION drawRuleArea
static TOOL_ACTION drawBezier
static TOOL_ACTION placeText
static TOOL_ACTION drawOrthogonalDimension
static TOOL_ACTION drawRectangle
static TOOL_ACTION setAnchor
static TOOL_ACTION padDisplayMode
static TOOL_ACTION placeReferenceImage
static TOOL_ACTION showLayersManager
static TOOL_ACTION drawCircle
static TOOL_ACTION mirrorH
Mirroring of selected items.
static TOOL_ACTION exportFootprint
static TOOL_ACTION drawTable
static TOOL_ACTION drawTextBox
static TOOL_ACTION drawPolygon
static TOOL_ACTION placePad
Activation of the drawing tool (placing a PAD)
static TOOL_ACTION drawRadialDimension
static TOOL_ACTION padTable
static TOOL_ACTION editTextAndGraphics
static TOOL_ACTION drawLeader
static TOOL_ACTION angleSnapModeChanged
Notification event when angle mode changes.
static TOOL_ACTION ddImportFootprint
static TOOL_ACTION placeImportedGraphics
static TOOL_ACTION drawArc
static TOOL_ACTION graphicsOutlines
Display footprint graphics as outlines.
static TOOL_ACTION loadFpFromBoard
static TOOL_ACTION drawCenterDimension
static TOOL_ACTION footprintProperties
static TOOL_ACTION flipBoard
static TOOL_ACTION textOutlines
Display texts as lines.
static TOOL_ACTION checkFootprint
static TOOL_ACTION placeBarcode
static TOOL_ACTION placePoint
static TOOL_ACTION editLibFpInFpEditor
static TOOL_ACTION mirrorV
static TOOL_ACTION repairFootprint
static TOOL_ACTION saveFpToBoard
static TOOL_ACTION drawLine
static TOOL_ACTION cleanupGraphics
static TOOL_ACTION rotateCw
Rotation of selected objects.
static TOOL_ACTION rotateCcw
static TOOL_ACTION drawAlignedDimension
virtual void SetBoard(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr) override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
void configureToolbars() override
PCB_BASE_EDIT_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
APPEARANCE_CONTROLS * m_appearancePanel
PANEL_SELECTION_FILTER * m_selectionFilterPanel
void ActivateGalCanvas() override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
virtual const PCB_PLOT_PARAMS & GetPlotSettings() const
Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Display options control the way tracks, vias, outlines and other things are shown (for instance solid...
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
void setFPWatcher(FOOTPRINT *aFootprint)
Create or removes a watcher on the specified footprint.
void OnModify() override
Must be called after a change in order to set the "modify" flag and update other data structures and ...
FOOTPRINT * loadFootprint(const LIB_ID &aFootprintId)
Attempt to load aFootprintId from the footprint library table.
const PAGE_INFO & GetPageSettings() const override
BOX2I GetBoardBoundingBox(bool aBoardEdgesOnly=false) const
Calculate the bounding box containing all board items (or board edge segments).
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void SetPageSettings(const PAGE_INFO &aPageSettings) override
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
BOARD * GetBoard() const
virtual void AddFootprintToBoard(FOOTPRINT *aFootprint)
Add the given footprint to the board.
PCB_DISPLAY_OPTIONS m_displayOptions
FOOTPRINT_EDITOR_SETTINGS * GetFootprintEditorSettings() const
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
HIGH_CONTRAST_MODE m_ContrastModeDisplay
How inactive layers are displayed.
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.
Group generic conditions for PCB editor states.
SELECTION_CONDITION PadFillDisplay()
Create a functor that tests if the frame fills the pads.
SELECTION_CONDITION HasItems()
Create a functor that tests if there are items in the board.
SELECTION_CONDITION GraphicsFillDisplay()
Create a functor that tests if the frame fills graphics items.
SELECTION_CONDITION TextFillDisplay()
Create a functor that tests if the frame fills text items.
The main frame for Pcbnew.
Generic tool for picking an item.
Parameters and options when plotting/printing a board.
Tool that displays edit points allowing to modify items by dragging the points.
The selection tool: currently supports:
Tool useful for viewing footprints.
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition pgm_base.h:125
The interactive edit tool.
static FP_LIB_TABLE * PcbFootprintLibs(PROJECT *aProject)
Return the table of footprint libraries without Kiway.
@ PCB_FOOTPRINT_EDITOR_FP_NAME
Definition project.h:231
@ PCB_FOOTPRINT_EDITOR_LIB_NICKNAME
Definition project.h:232
virtual void SetRString(RSTRING_T aStringId, const wxString &aString)
Store a "retained string", which is any session and project specific string identified in enum RSTRIN...
Definition project.cpp:334
virtual const wxString & GetRString(RSTRING_T aStringId)
Return a "retained string", which is any session and project specific string identified in enum RSTRI...
Definition project.cpp:345
Action handler for the Properties panel.
Tool relating to pads and pad settings.
static SELECTION_CONDITION HasType(KICAD_T aType)
Create a functor that tests if among the selected items there is at least one of a given type.
static bool NotEmpty(const SELECTION &aSelection)
Test if there are any items selected.
static bool Idle(const SELECTION &aSelection)
Test if there no items selected or being edited.
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
T * GetAppSettings(const char *aFilename)
Return a handle to the a given settings by type.
bool IsProjectOpen() const
Helper for checking if we have a project open.
TOOL_MANAGER * m_toolManager
TOOL_DISPATCHER * m_toolDispatcher
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
ACTIONS * m_actions
Base abstract interface for all kinds of tools.
Definition tool_base.h:66
@ MODEL_RELOAD
Model changes (the sheet for a schematic)
Definition tool_base.h:80
virtual void DispatchWxEvent(wxEvent &aEvent)
Process wxEvents (mostly UI events), translate them to TOOL_EVENTs, and make tools handle those.
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.
bool empty() const
Definition utf8.h:110
const char * c_str() const
Definition utf8.h:109
A modified version of the wxInfoBar class that allows us to:
Definition wx_infobar.h:76
void ShowMessageFor(const wxString &aMessage, int aTime, int aFlags=wxICON_INFORMATION, MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
Show the infobar with the provided message and icon for a specific period of time.
Multi-thread safe progress reporter dialog, intended for use of tasks that parallel reporting back of...
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition confirm.cpp:129
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition confirm.cpp:194
This file is part of the common library.
#define CHECK(x)
#define ENABLE(x)
static bool empty(const wxTextEntryBase *aCtrl)
#define _(s)
Declaration of the eda_3d_viewer class.
static constexpr EDA_ANGLE ANGLE_90
Definition eda_angle.h:413
#define KICAD_DEFAULT_DRAWFRAME_STYLE
#define FOOTPRINT_EDIT_FRAME_NAME
@ RECURSE
Definition eda_item.h:51
FOOTPRINT_STACKUP
Definition footprint.h:91
@ EXPAND_INNER_LAYERS
The 'normal' stackup handling, where there is a single inner layer (In1) and rule areas using it expa...
Definition footprint.h:96
@ CUSTOM_LAYERS
Stackup handling where the footprint can have any number of copper layers, and objects on those layer...
Definition footprint.h:101
#define CURRENT_EDIT_TOOL(action)
FOOTPRINT_LIST_IMPL GFootprintList
The global footprint info table.
Definition cvpcb.cpp:156
@ FRAME_PCB_EDITOR
Definition frame_type.h:42
@ FRAME_FOOTPRINT_EDITOR
Definition frame_type.h:43
a few functions useful in geometry calculations.
static const std::string KiCadFootprintLibPathExtension
static const std::string KiCadFootprintFileExtension
static wxString PngFileWildcard()
@ ID_ON_GRID_SELECT
Definition id.h:114
@ ID_ON_ZOOM_SELECT
Definition id.h:112
PROJECT & Prj()
Definition kicad.cpp:612
KIID niluuid(0)
bool IsUserLayer(PCB_LAYER_ID aLayerId)
Test whether a layer is a non copper and a non tech layer.
Definition layer_ids.h:758
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:60
@ B_Cu
Definition layer_ids.h:65
@ F_SilkS
Definition layer_ids.h:100
@ In1_Cu
Definition layer_ids.h:66
@ F_Cu
Definition layer_ids.h:64
This file contains miscellaneous commonly used macros and functions.
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
Definition definitions.h:38
void SetShutdownBlockReason(wxWindow *aWindow, const wxString &aReason)
Sets the block reason why the window/application is preventing OS shutdown.
Definition unix/app.cpp:90
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
Definition unix/app.cpp:79
#define _HKI(x)
Definition page_info.cpp:44
@ ID_FPEDIT_SAVE_PNG
Definition pcbnew_id.h:80
SETTINGS_MANAGER * GetSettingsManager()
BOARD * GetBoard()
PGM_BASE & Pgm()
The global program "get" accessor.
Definition pgm_base.cpp:913
see class PGM_BASE
#define DEFAULT_THEME
T * GetToolbarSettings(const wxString &aFilename)
T * GetAppSettings(const char *aFilename)
KIWAY Kiway(KFCTL_STANDALONE)
wxString UnescapeString(const wxString &aSource)
wxString From_UTF8(const char *cstring)
#define EDIT_TOOL(tool)
#define ENVVARS_CHANGED
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
Definition typeinfo.h:111
@ PCB_TEXTBOX_T
class PCB_TEXTBOX, wrapped text on a layer
Definition typeinfo.h:93
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition typeinfo.h:92
Definition of file extensions used in Kicad.
void SetAuiPaneSize(wxAuiManager &aManager, wxAuiPaneInfo &aPane, int aWidth, int aHeight)
Sets the size of an AUI pane, working around http://trac.wxwidgets.org/ticket/13180.
#define PR_CAN_ABORT