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>
47#include <kiface_base.h>
48#include <kiplatform/app.h>
49#include <kiplatform/ui.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>
79
80#include <wx/filedlg.h>
81#include <wx/hyperlink.h>
82
83BEGIN_EVENT_TABLE( FOOTPRINT_EDIT_FRAME, PCB_BASE_FRAME )
84 EVT_MENU( wxID_CLOSE, FOOTPRINT_EDIT_FRAME::CloseFootprintEditor )
85 EVT_MENU( wxID_EXIT, FOOTPRINT_EDIT_FRAME::OnExitKiCad )
86
88
91
93
94 // Drop files event
95 EVT_DROP_FILES( FOOTPRINT_EDIT_FRAME::OnDropFiles )
96
97END_EVENT_TABLE()
98
99
100FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent ) :
101 PCB_BASE_EDIT_FRAME( aKiway, aParent, FRAME_FOOTPRINT_EDITOR, wxEmptyString,
102 wxDefaultPosition, wxDefaultSize,
105{
106 m_showBorderAndTitleBlock = false; // true to show the frame references
107 m_aboutTitle = _HKI( "KiCad Footprint Editor" );
108 m_editorSettings = nullptr;
109
110 // Give an icon
111 wxIcon icon;
112 wxIconBundle icon_bundle;
113
114 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 48 ) );
115 icon_bundle.AddIcon( icon );
116 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 128 ) );
117 icon_bundle.AddIcon( icon );
118 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 256 ) );
119 icon_bundle.AddIcon( icon );
120 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit_32 ) );
121 icon_bundle.AddIcon( icon );
122 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit_16 ) );
123 icon_bundle.AddIcon( icon );
124
125 SetIcons( icon_bundle );
126
127 // Create GAL canvas
129
130 PCB_DRAW_PANEL_GAL* drawPanel = new PCB_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
132 SetCanvas( drawPanel );
133
135
136 SetBoard( new BOARD() );
137
138 // This board will only be used to hold a footprint for editing
140
141 // In Footprint Editor, the default net clearance is not known (it depends on the actual
142 // board). So we do not show the default clearance, by setting it to 0. The footprint or
143 // pad specific clearance will be shown.
145
146 // Don't show the default board solder mask expansion in the footprint editor. Only the
147 // footprint or pad mask expansions settings should be shown.
149
150 // Ensure all layers and items are visible:
151 // In footprint editor, some layers have no meaning or cannot be used, but we show all of
152 // them, at least to be able to edit a bad layer
154
155 GetGalDisplayOptions().m_axesEnabled = true;
156
157 // In Footprint Editor, set the default paper size to A4 for plot/print
159 SetScreen( new PCB_SCREEN( GetPageSettings().GetSizeIU( pcbIUScale.IU_PER_MILS ) ) );
160
161 // Create the manager and dispatcher & route draw panel events to the dispatcher
162 setupTools();
164
166 m_treePane = new FOOTPRINT_TREE_PANE( this );
167
171 ReCreateLayerBox( false );
172
174
176 m_appearancePanel = new APPEARANCE_CONTROLS( this, GetCanvas(), true );
177 m_propertiesPanel = new PCB_PROPERTIES_PANEL( this, this );
178
179 // LoadSettings() *after* creating m_LayersManager, because LoadSettings() initialize
180 // parameters in m_LayersManager
181 // NOTE: KifaceSettings() will return PCBNEW_SETTINGS if we started from pcbnew
183
185
186 float proportion = GetFootprintEditorSettings()->m_AuiPanels.properties_splitter;
187 m_propertiesPanel->SetSplitterProportion( proportion );
188
190
191 // Fetch a COPY of the config as a lot of these initializations are going to overwrite our
192 // data.
193 int libWidth = 0;
195
197 {
198 libWidth = cfg->m_LibWidth;
199 aui_cfg = cfg->m_AuiPanels;
200 }
201 else
202 {
203 // keep gcc quiet about uninitalized vars:
204 aui_cfg.appearance_panel_tab = 0;
205 aui_cfg.right_panel_width = -1;
206 }
207
208 m_auimgr.SetManagedWindow( this );
209
210 unsigned int auiFlags = wxAUI_MGR_DEFAULT;
211#if !defined( _WIN32 )
212 // Windows cannot redraw the UI fast enough during a live resize and may lead to all kinds
213 // of graphical glitches
214 auiFlags |= wxAUI_MGR_LIVE_RESIZE;
215#endif
216 m_auimgr.SetFlags( auiFlags );
217
218 // Rows; layers 4 - 6
219 m_auimgr.AddPane( m_tbTopMain, EDA_PANE().HToolbar().Name( "TopMainToolbar" )
220 .Top().Layer( 6 ) );
221
222 m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" )
223 .Bottom().Layer( 6 ) );
224
225 // Columns; layers 1 - 3
226 m_auimgr.AddPane( m_treePane, EDA_PANE().Palette().Name( "Footprints" )
227 .Left().Layer( 4 )
228 .Caption( _( "Libraries" ) )
229 .MinSize( FromDIP( 250 ), -1 ).BestSize( FromDIP( 250 ), -1 ) );
231 .Left().Layer( 3 )
232 .Caption( _( "Properties" ) ).PaneBorder( false )
233 .MinSize( FromDIP( wxSize( 240, 60 ) ) ).BestSize( FromDIP( wxSize( 300, 200 ) ) ) );
234 m_auimgr.AddPane( m_tbLeft, EDA_PANE().VToolbar().Name( "LeftToolbar" )
235 .Left().Layer( 2 ) );
236
237 m_auimgr.AddPane( m_tbRight, EDA_PANE().VToolbar().Name( "RightToolbar" )
238 .Right().Layer(2) );
239 m_auimgr.AddPane( m_appearancePanel, EDA_PANE().Name( "LayersManager" )
240 .Right().Layer( 3 )
241 .Caption( _( "Appearance" ) ).PaneBorder( false )
242 .MinSize( FromDIP( 180 ), -1 ).BestSize( FromDIP( 180 ), -1 ) );
243 m_auimgr.AddPane( m_selectionFilterPanel, EDA_PANE().Palette().Name( "SelectionFilter" )
244 .Right().Layer( 3 ).Position( 2 )
245 .Caption( _( "Selection Filter" ) ).PaneBorder( false )
246 .MinSize( FromDIP( 180 ), -1 ).BestSize( FromDIP( 180 ), -1 ) );
247
248 // Center
249 m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" )
250 .Center() );
251
253
254 m_auimgr.GetPane( "LayersManager" ).Show( m_show_layer_manager_tools );
255 m_auimgr.GetPane( "SelectionFilter" ).Show( m_show_layer_manager_tools );
256 m_auimgr.GetPane( PropertiesPaneName() ).Show( GetSettings()->m_AuiPanels.show_properties );
257
258 // The selection filter doesn't need to grow in the vertical direction when docked
259 m_auimgr.GetPane( "SelectionFilter" ).dock_proportion = 0;
260
263 DragAcceptFiles( true );
264
266
267 // Apply saved visibility stuff at the end
268 wxAuiPaneInfo& treePane = m_auimgr.GetPane( "Footprints" );
269 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( "LayersManager" );
270
271 if( libWidth > 0 )
272 SetAuiPaneSize( m_auimgr, treePane, libWidth, -1 );
273
274 if( aui_cfg.right_panel_width > 0 )
275 SetAuiPaneSize( m_auimgr, layersManager, aui_cfg.right_panel_width, -1 );
276
277 m_appearancePanel->SetTabIndex( aui_cfg.appearance_panel_tab );
278
280 {
281 m_appearancePanel->SetUserLayerPresets( cfg->m_LayerPresets );
282 m_appearancePanel->ApplyLayerPreset( cfg->m_ActiveLayerPreset );
283 }
284
285 // restore the last footprint from the project, if any, after the library has been init'ed
286 // N.B. This needs to happen after the AUI manager has been initialized so that we can
287 // properly call the WX_INFOBAR without crashing on some systems.
289
290 // This displays the last footprint loaded, if any, so it must be done after restoreLastFootprint()
292
293 GetToolManager()->PostAction( ACTIONS::zoomFitScreen );
294 UpdateTitle();
296
298
299 // Default shutdown reason until a file is loaded
300 KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Footprint changes are unsaved" ) );
301
302 // Catch unhandled accelerator command characters that were no handled by the library tree
303 // panel.
305 Bind( wxEVT_CHAR_HOOK, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
306
307 // Ensure the window is on top
308 Raise();
309 Show( true );
310
311 // Register a call to update the toolbar sizes. It can't be done immediately because
312 // it seems to require some sizes calculated that aren't yet (at least on GTK).
313 CallAfter(
314 [this]()
315 {
316 // Ensure the controls on the toolbars all are correctly sized
318 m_treePane->FocusSearchFieldIfExists();
319
320 // Update the angle snap mode toolbar button to reflect the current preference
322 } );
323}
324
325
327{
328 // Shutdown all running tools
329 if( m_toolManager )
330 m_toolManager->ShutdownAllTools();
331
332 // save the footprint in the PROJECT
334
335 // Clear the watched file
336 setFPWatcher( nullptr );
337
338 // We passed ownership of these to wxAuiManager.
339 // delete m_selectionFilterPanel;
340 // delete m_appearancePanel;
341 // delete m_treePane;
342}
343
344
346{
348
349 FOOTPRINT* fp = static_cast<FOOTPRINT*>( GetModel() );
350
351 if( fp )
352 {
353 std::vector<MSG_PANEL_ITEM> msgItems;
354 fp->GetMsgPanelInfo( this, msgItems );
355 SetMsgPanel( msgItems );
356 }
357}
358
359
365
366
368{
369 return m_toolManager->GetTool<PCB_SELECTION_TOOL>()->GetSelection();
370}
371
372
374{
375 // switches currently used canvas (Cairo / OpenGL).
376 PCB_BASE_FRAME::SwitchCanvas( aCanvasType );
377
378 GetCanvas()->GetGAL()->SetAxesEnabled( true );
379
380 // The base class method *does not reinit* the layers manager. We must update the layer
381 // widget to match board visibility states, both layers and render columns, and and some
382 // settings dependent on the canvas.
384}
385
386
392
393
395{
396 wxAuiPaneInfo& treePane = m_auimgr.GetPane( m_treePane );
397 treePane.Show( !IsLibraryTreeShown() );
398
399 if( IsLibraryTreeShown() )
400 {
401 // SetAuiPaneSize also updates m_auimgr
402 SetAuiPaneSize( m_auimgr, treePane, m_editorSettings->m_LibWidth, -1 );
403 }
404 else
405 {
406 m_editorSettings->m_LibWidth = m_treePane->GetSize().x;
407 m_auimgr.Update();
408 }
409}
410
411
413{
414 m_treePane->FocusSearchFieldIfExists();
415}
416
417
419{
421 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( "LayersManager" );
422 wxAuiPaneInfo& selectionFilter = m_auimgr.GetPane( "SelectionFilter" );
423
424 // show auxiliary Vertical layers and visibility manager toolbar
426 layersManager.Show( m_show_layer_manager_tools );
427 selectionFilter.Show( m_show_layer_manager_tools );
428
430 {
431 SetAuiPaneSize( m_auimgr, layersManager, settings->m_AuiPanels.right_panel_width, -1 );
432 }
433 else
434 {
435 settings->m_AuiPanels.right_panel_width = m_appearancePanel->GetSize().x;
436 m_auimgr.Update();
437 }
438}
439
440
442{
443 return const_cast<wxAuiManager&>( m_auimgr ).GetPane( m_treePane ).IsShown();
444}
445
446
451
452
454{
455 LIB_ID id;
456
457 if( IsLibraryTreeShown() )
459
460 if( id.GetLibNickname().empty() )
461 id = GetLoadedFPID();
462
463 return id;
464}
465
466
468{
469 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
470
471 if( footprint )
472 return LIB_ID( footprint->GetFPID().GetLibNickname(), m_footprintNameWhenLoaded );
473 else
474 return LIB_ID();
475}
476
477
479{
480 if( GetBoard()->GetFirstFootprint() )
481 {
484 }
485
486 GetScreen()->SetContentModified( false );
487}
488
489
491{
492 // If we've already vetted closing this window, then we have no FP anymore
493 if( m_isClosing || !GetBoard() )
494 return false;
495
496 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
497
498 return ( footprint && footprint->GetLink() != niluuid );
499}
500
501
503{
504 LIB_ID id = GetLoadedFPID();
505
506 if( id.IsValid() )
507 {
509 Prj().SetRString( PROJECT::PCB_FOOTPRINT_EDITOR_FP_NAME, id.GetLibItemName() );
510 }
511}
512
513
515{
516 const wxString& footprintName = Prj().GetRString( PROJECT::PCB_FOOTPRINT_EDITOR_FP_NAME );
517 const wxString& libNickname = Prj().GetRString( PROJECT::PCB_FOOTPRINT_EDITOR_LIB_NICKNAME );
518
519 if( libNickname.Length() && footprintName.Length() )
520 {
521 LIB_ID id;
522 id.SetLibNickname( libNickname );
523 id.SetLibItemName( footprintName );
524
525 FOOTPRINT* footprint = loadFootprint( id );
526
527 if( footprint )
528 AddFootprintToBoard( footprint );
529 }
530}
531
532
534{
535 FOOTPRINT* footprint = static_cast<FOOTPRINT*>( GetModel() );
536 BOARD& board = *GetBoard();
537
538 // All FPs have these layers enabled
539 LSET enabledLayers = LSET::AllTechMask() | LSET::UserMask();
540
541 const auto configureStackup =
542 [&]( 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 board.SetLayerName( In1_Cu, _( "Inner layers" ) );
553 break;
554 }
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
567 enabledLayers |= aLayerSet;
568 };
569
570 if( footprint )
571 {
572 configureStackup( footprint->GetStackupMode(), footprint->GetStackupLayers() );
573 }
574 else
575 {
576 // If no footprint is loaded, we assume the default stackup mode
577 configureStackup( FOOTPRINT_STACKUP::EXPAND_INNER_LAYERS, LSET{} );
578 }
579
581 {
582 m_originalFootprintCopy->RunOnChildren(
583 [&]( BOARD_ITEM* child )
584 {
585 LSET childLayers = child->GetLayerSet() & LSET::UserDefinedLayersMask();
586
587 for( PCB_LAYER_ID layer : childLayers )
588 enabledLayers.set( layer );
589 },
591 }
592
593 // Enable the user-configured number of user layers, plus any specifically named layers
595 {
596 int userLayerCount = cfg->m_DesignSettings.GetUserDefinedLayerCount();
597 enabledLayers |= LSET::UserDefinedLayersMask( userLayerCount );
598
599 for( const PCB_LAYER_ID& user : LSET::UserDefinedLayersMask() )
600 {
601 if( cfg->m_DesignSettings.m_UserLayerNames.contains( LSET::Name( user ).ToStdString() ) )
602 enabledLayers.set( user );
603 }
604 }
605
606 board.SetEnabledLayers( enabledLayers );
607
608 // Footprint Editor layer visibility is kept in the view, not the board (because the board
609 // just delegates to the project file, which we don't have).
610 for( const PCB_LAYER_ID& layer : GetBoard()->GetEnabledLayers() )
611 GetCanvas()->GetView()->SetLayerVisible( layer, true );
612}
613
614
616{
618
619 m_originalFootprintCopy.reset( static_cast<FOOTPRINT*>( aFootprint->Clone() ) );
620 m_originalFootprintCopy->SetParent( nullptr );
621
623
625 // Ensure item UUIDs are valid
626 // ("old" footprints can have null uuids that create issues in fp editor)
627 aFootprint->FixUuids();
628
630
631 // Use CallAfter so that we update the canvas before waiting for the infobar animation
632 CallAfter(
633 [this]()
634 {
636 wxString libName = fp->GetFPID().GetLibNickname();
637 wxString msg, link;
638
640 {
641 msg.Printf( _( "Editing %s from board. Saving will update the board only." ), fp->GetReference() );
642 link.Printf( _( "Open in library %s" ), UnescapeString( libName ) );
643
644 const auto openLibraryCopy =
645 [this]( wxHyperlinkEvent& aEvent )
646 {
648 };
649
650 if( WX_INFOBAR* infobar = GetInfoBar() )
651 {
652 wxHyperlinkCtrl* button = new wxHyperlinkCtrl( infobar, wxID_ANY, link, wxEmptyString );
653 button->Bind( wxEVT_COMMAND_HYPERLINK, openLibraryCopy );
654
655 infobar->RemoveAllButtons();
656 infobar->AddButton( button );
657 infobar->AddCloseButton();
658 infobar->ShowMessage( msg, wxICON_INFORMATION );
659 }
660 }
661 // An empty libname is OK - you get that when creating a new footprint from the main menu
662 // In that case. treat is as editable, and the user will be prompted for save-as when saving.
663 else if( !libName.empty()
664 && !PROJECT_PCB::FootprintLibAdapter( &Prj() )->IsFootprintLibWritable( libName ) )
665 {
666 msg.Printf( _( "Editing footprint from read-only library %s." ), UnescapeString( libName ) );
667
668 if( WX_INFOBAR* infobar = GetInfoBar() )
669 {
670 link = _( "Save as editable copy" );
671
672 const auto saveAsEditableCopy =
673 [this]( wxHyperlinkEvent& aEvent )
674 {
675 SaveFootprintAs( GetBoard()->GetFirstFootprint() );
676 GetCanvas()->GetView()->Update( GetBoard()->GetFirstFootprint() );
677 ClearModify();
678
679 // Get rid of the save-will-update-board-only (or any other dismissable warning)
680 WX_INFOBAR* loc_infobar = GetInfoBar();
681
682 if( loc_infobar->IsShownOnScreen() && loc_infobar->HasCloseButton() )
683 loc_infobar->Dismiss();
684
686 SyncLibraryTree( true );
687 };
688
689 wxHyperlinkCtrl* button = new wxHyperlinkCtrl( infobar, wxID_ANY, link, wxEmptyString );
690 button->Bind( wxEVT_COMMAND_HYPERLINK, saveAsEditableCopy );
691
692 infobar->RemoveAllButtons();
693 infobar->AddButton( button );
694 infobar->AddCloseButton();
695 infobar->ShowMessage( msg, wxICON_INFORMATION );
696 }
697 }
698 else
699 {
700 if( WX_INFOBAR* infobar = GetInfoBar() )
701 infobar->Dismiss();
702 }
703 } );
704
707}
708
709
711{
712 ReloadFootprint( aFootprint );
713
715 setFPWatcher( nullptr );
716 else
717 setFPWatcher( aFootprint );
718}
719
720
725
726
731
732
734{
735 wxFAIL_MSG( wxT( "Plotting not supported in Footprint Editor" ) );
736
738}
739
740
742{
743 wxFAIL_MSG( wxT( "Plotting not supported in Footprint Editor" ) );
744}
745
746
754
755
763
764
766{
767 // Get our own settings; aCfg will be the PCBNEW_SETTINGS because we're part of the pcbnew
768 // compile unit
770
771 if( cfg )
772 {
774
776
779
781 m_selectionFilterPanel->SetCheckboxesFromFilter( cfg->m_SelectionFilter );
782
784
785 for( auto& [source_name, dest_name] : cfg->m_DesignSettings.m_UserLayerNames )
786 {
787 wxString wx_source_name = source_name;
788 PCB_LAYER_ID layer = static_cast<PCB_LAYER_ID>( LSET::NameToLayer( wx_source_name ) );
789
790 if( IsUserLayer( layer ) )
791 GetBoard()->SetLayerName( layer, dest_name );
792 }
793
794 }
795}
796
797
799{
800 // Load canvas type from the FOOTPRINT_EDITOR_SETTINGS:
802
803 // If we had an OpenGL failure this session, use the fallback GAL but don't update the
804 // user preference silently:
805
808}
809
810
812{
814
815 // Get our own settings; aCfg will be the PCBNEW_SETTINGS because we're part of the pcbnew
816 // compile unit
818
819 if( cfg )
820 {
822
825 cfg->m_LibWidth = m_treePane->GetSize().x;
827
829
831 {
832 cfg->m_AuiPanels.show_properties = m_propertiesPanel->IsShownOnScreen();
834 cfg->m_AuiPanels.properties_splitter = m_propertiesPanel->SplitterProportion();
835 }
836
838
840 {
843 cfg->m_LayerPresets = m_appearancePanel->GetUserLayerPresets();
844 cfg->m_ActiveLayerPreset = m_appearancePanel->GetActiveLayerPreset();
845 }
846 }
847}
848
849
850
852{
853 FOOTPRINT_EDITOR_SETTINGS* cfg = const_cast<FOOTPRINT_EDIT_FRAME*>( this )->GetSettings();
854
855 return cfg ? cfg->m_RotationAngle : ANGLE_90;
856}
857
858
859
861{
863 return ::GetColorSettings( cfg ? cfg->m_ColorTheme : DEFAULT_THEME );
864}
865
866
868{
869 static MAGNETIC_SETTINGS fallback;
870
872 return &cfg->m_MagneticItems;
873
874 return &fallback;
875}
876
877
878const BOX2I FOOTPRINT_EDIT_FRAME::GetDocumentExtents( bool aIncludeAllVisible ) const
879{
880 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
881
882 if( footprint )
883 {
884 bool hasGraphicalItem = footprint->Pads().size() || footprint->Zones().size();
885
886 if( !hasGraphicalItem )
887 {
888 for( const BOARD_ITEM* item : footprint->GraphicalItems() )
889 {
890 if( item->Type() == PCB_TEXT_T || item->Type() == PCB_TEXTBOX_T )
891 continue;
892
893 hasGraphicalItem = true;
894 break;
895 }
896 }
897
898 if( hasGraphicalItem )
899 {
900 return footprint->GetBoundingBox( false );
901 }
902 else
903 {
904 BOX2I newFootprintBB( { 0, 0 }, { 0, 0 } );
905 newFootprintBB.Inflate( pcbIUScale.mmToIU( 12 ) );
906 return newFootprintBB;
907 }
908 }
909
910 return GetBoardBoundingBox( false );
911}
912
913
915{
916 if( IsContentModified() )
917 {
918 wxString footprintName = GetBoard()->GetFirstFootprint()->GetReference();
919 wxString msg = _( "Save changes to '%s' before closing?" );
920
921 if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
922 [&]() -> bool
923 {
924 return SaveFootprint( GetBoard()->GetFirstFootprint() );
925 } ) )
926 {
927 return false;
928 }
929 }
930
931 if( doClose )
932 {
933 GetInfoBar()->ShowMessageFor( wxEmptyString, 1 );
934 Clear_Pcb( false );
935 UpdateTitle();
936 }
937
938 return true;
939}
940
941
942bool FOOTPRINT_EDIT_FRAME::canCloseWindow( wxCloseEvent& aEvent )
943{
944 if( IsContentModified() )
945 {
946 // Shutdown blocks must be determined and vetoed as early as possible
948 aEvent.GetId() == wxEVT_QUERY_END_SESSION )
949 {
950 aEvent.Veto();
951 return false;
952 }
953
954 wxString footprintName = GetBoard()->GetFirstFootprint()->GetFPID().GetLibItemName();
955
957 footprintName = GetBoard()->GetFirstFootprint()->GetReference();
958
959 wxString msg = _( "Save changes to '%s' before closing?" );
960
961 if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
962 [&]() -> bool
963 {
964 return SaveFootprint( GetBoard()->GetFirstFootprint() );
965 } ) )
966 {
967 aEvent.Veto();
968 return false;
969 }
970 }
971
972 PAD_TOOL* padTool = m_toolManager->GetTool<PAD_TOOL>();
973
974 if( padTool->InPadEditMode() )
975 padTool->ExitPadEditMode();
976
977 // Save footprint tree column widths
978 m_adapter->SaveSettings();
979
981}
982
983
985{
986 // No more vetos
987 GetCanvas()->SetEventDispatcher( nullptr );
989
990 if( GetLibTree() )
992
993 // Do not show the layer manager during closing to avoid flicker
994 // on some platforms (Windows) that generate useless redraw of items in
995 // the Layer Manager
996 m_auimgr.GetPane( wxT( "LayersManager" ) ).Show( false );
997 m_auimgr.GetPane( wxT( "SelectionFilter" ) ).Show( false );
998
999 Clear_Pcb( false );
1000}
1001
1002
1003void FOOTPRINT_EDIT_FRAME::OnExitKiCad( wxCommandEvent& event )
1004{
1005 Kiway().OnKiCadExit();
1006}
1007
1008
1010{
1011 Close();
1012}
1013
1014
1016{
1017 // call my base class
1019
1020 // We have 2 panes to update.
1021 // For some obscure reason, the AUI manager hides the first modified pane.
1022 // So force show panes
1023 wxAuiPaneInfo& tree_pane_info = m_auimgr.GetPane( m_treePane );
1024 bool tree_shown = tree_pane_info.IsShown();
1025 tree_pane_info.Caption( _( "Libraries" ) );
1026
1027 wxAuiPaneInfo& lm_pane_info = m_auimgr.GetPane( m_appearancePanel );
1028 bool lm_shown = lm_pane_info.IsShown();
1029 lm_pane_info.Caption( _( "Appearance" ) );
1030 wxAuiPaneInfo& sf_pane_info = m_auimgr.GetPane( m_selectionFilterPanel );
1031 sf_pane_info.Caption( _( "Selection Filter" ) );
1032
1033 // update the layer manager
1035
1036 // Now restore the visibility:
1037 lm_pane_info.Show( lm_shown );
1038 tree_pane_info.Show( tree_shown );
1039 m_auimgr.Update();
1040
1042
1043 UpdateTitle();
1044}
1045
1046
1048{
1050
1051 if( m_isClosing )
1052 return;
1053
1054 Update3DView( true, true );
1056
1057 if( !GetTitle().StartsWith( wxT( "*" ) ) )
1058 UpdateTitle();
1059}
1060
1061
1063{
1064 wxString title;
1065 LIB_ID fpid = GetLoadedFPID();
1066 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
1067 bool writable = true;
1068
1069 if( IsCurrentFPFromBoard() )
1070 {
1071 if( IsContentModified() )
1072 title = wxT( "*" );
1073
1074 title += footprint->GetReference();
1075 title += wxS( " " ) + wxString::Format( _( "[from %s]" ), Prj().GetProjectName()
1076 + wxT( "." )
1077 + FILEEXT::PcbFileExtension );
1078 }
1079 else if( fpid.IsValid() )
1080 {
1081 try
1082 {
1084 }
1085 catch( const IO_ERROR& )
1086 {
1087 // best efforts...
1088 }
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().Format().c_str() );
1095
1096 if( !writable )
1097 title += wxS( " " ) + _( "[Read Only]" );
1098 }
1099 else if( !fpid.GetLibItemName().empty() )
1100 {
1101 // Note: don't used GetLoadedFPID(); footprint name may have been edited
1102 if( IsContentModified() )
1103 title = wxT( "*" );
1104
1105 title += From_UTF8( footprint->GetFPID().GetLibItemName().c_str() );
1106 title += wxS( " " ) + _( "[Unsaved]" );
1107 }
1108 else
1109 {
1110 title = _( "[no footprint loaded]" );
1111 }
1112
1113 title += wxT( " \u2014 " ) + _( "Footprint Editor" );
1114
1115 SetTitle( title );
1116}
1117
1118
1120{
1121 m_appearancePanel->OnBoardChanged();
1122}
1123
1124
1126{
1130 m_propertiesPanel->UpdateData();
1131 UpdateTitle();
1132}
1133
1134
1136{
1138
1140 auto adapter = static_cast<FP_TREE_SYNCHRONIZING_ADAPTER*>( m_adapter.get() );
1141
1142 adapter->AddLibraries( this );
1143}
1144
1145
1146void FOOTPRINT_EDIT_FRAME::SyncLibraryTree( [[maybe_unused]] bool aProgress )
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 // Unselect before syncing to avoid null reference in the adapter
1154 // if a selected item is removed during the sync
1155 GetLibTree()->Unselect();
1156
1157 // Sync the LIB_TREE to the FOOTPRINT_INFO list
1158 adapter->Sync( footprints );
1159
1160 GetLibTree()->Regenerate( true );
1161
1162 if( target.IsValid() )
1163 {
1164 if( adapter->FindItem( target ) )
1165 {
1166 if( targetSelected )
1167 GetLibTree()->SelectLibId( target );
1168 else
1169 GetLibTree()->CenterLibId( target );
1170 }
1171 else
1172 {
1173 // Try to focus on parent
1174 target.SetLibItemName( wxEmptyString );
1175 GetLibTree()->CenterLibId( target );
1176 }
1177 }
1178}
1179
1180
1185
1186
1188{
1189 GetLibTree()->SelectLibId( aLibID );
1190}
1191
1192
1194{
1195 m_appearancePanel->UpdateDisplayOptions();
1196}
1197
1198
1200{
1201 // Create the manager and dispatcher & route draw panel events to the dispatcher
1203 m_toolManager->SetEnvironment( GetBoard(), GetCanvas()->GetView(),
1204 GetCanvas()->GetViewControls(), config(), this );
1205 m_actions = new PCB_ACTIONS();
1207
1209
1210 m_toolManager->RegisterTool( new COMMON_CONTROL );
1211 m_toolManager->RegisterTool( new COMMON_TOOLS );
1212 m_toolManager->RegisterTool( new PCB_SELECTION_TOOL );
1213 m_toolManager->RegisterTool( new ZOOM_TOOL );
1214 m_toolManager->RegisterTool( new EDIT_TOOL );
1215 m_toolManager->RegisterTool( new PCB_EDIT_TABLE_TOOL );
1216 m_toolManager->RegisterTool( new PAD_TOOL );
1217 m_toolManager->RegisterTool( new DRAWING_TOOL );
1218 m_toolManager->RegisterTool( new PCB_POINT_EDITOR );
1219 m_toolManager->RegisterTool( new PCB_CONTROL ); // copy/paste
1220 m_toolManager->RegisterTool( new LIBRARY_EDITOR_CONTROL );
1221 m_toolManager->RegisterTool( new FOOTPRINT_EDITOR_CONTROL );
1222 m_toolManager->RegisterTool( new ALIGN_DISTRIBUTE_TOOL );
1223 m_toolManager->RegisterTool( new PCB_PICKER_TOOL );
1224 m_toolManager->RegisterTool( new POSITION_RELATIVE_TOOL );
1225 m_toolManager->RegisterTool( new ARRAY_TOOL );
1226 m_toolManager->RegisterTool( new PCB_VIEWER_TOOLS );
1227 m_toolManager->RegisterTool( new PCB_GROUP_TOOL );
1228 m_toolManager->RegisterTool( new CONVERT_TOOL );
1229 m_toolManager->RegisterTool( new SCRIPTING_TOOL );
1230 m_toolManager->RegisterTool( new PROPERTIES_TOOL );
1231 m_toolManager->RegisterTool( new EMBED_TOOL );
1232
1233 for( TOOL_BASE* tool : m_toolManager->Tools() )
1234 {
1235 if( PCB_TOOL_BASE* pcbTool = dynamic_cast<PCB_TOOL_BASE*>( tool ) )
1236 pcbTool->SetIsFootprintEditor( true );
1237 }
1238
1239 m_toolManager->GetTool<PCB_VIEWER_TOOLS>()->SetFootprintFrame( true );
1240 m_toolManager->InitTools();
1241
1242 m_toolManager->InvokeTool( "common.InteractiveSelection" );
1243
1244 // Load or reload wizard plugins in case they changed since the last time the frame opened
1245 // Because the board editor has also a plugin python menu,
1246 // call the PCB_EDIT_FRAME RunAction() if the board editor is running
1247 // Otherwise run the current RunAction().
1248 PCB_EDIT_FRAME* pcbframe = static_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
1249
1250 if( pcbframe )
1252 else
1254}
1255
1256
1258{
1260
1261 ACTION_MANAGER* mgr = m_toolManager->GetActionManager();
1262 PCB_EDITOR_CONDITIONS cond( this );
1263
1264 wxASSERT( mgr );
1265
1266#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
1267#define CHECK( x ) ACTION_CONDITIONS().Check( x )
1268
1269 auto haveFootprintCond =
1270 [this]( const SELECTION& )
1271 {
1272 return GetBoard() && GetBoard()->GetFirstFootprint() != nullptr;
1273 };
1274
1275 auto footprintTargettedCond =
1276 [this]( const SELECTION& )
1277 {
1278 return !GetTargetFPID().GetLibItemName().empty();
1279 };
1280
1281 auto footprintSelectedInTreeCond =
1282 [this]( const SELECTION& )
1283 {
1285 return !sel.GetLibNickname().empty() && !sel.GetLibItemName().empty();
1286 };
1287
1288 const auto footprintFromBoardCond =
1289 [this]( const SELECTION& )
1290 {
1291 return IsCurrentFPFromBoard();
1292 };
1293
1294 auto pcbFrameExistsCond =
1295 [this]( const SELECTION& )
1296 {
1297 PCB_EDIT_FRAME* frame = dynamic_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
1298
1299 return ( frame != nullptr );
1300 };
1301
1302 auto boardFootprintExistsCond =
1303 [this]( const SELECTION& )
1304 {
1305 PCB_EDIT_FRAME* frame = dynamic_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
1306
1307 FOOTPRINT* editorFootprint = GetBoard()->GetFirstFootprint();
1308 bool canInsert = frame && editorFootprint && editorFootprint->GetLink() == niluuid;
1309
1310 // If the source was deleted, the footprint can inserted but not updated in the board.
1311 if( frame && editorFootprint && editorFootprint->GetLink() != niluuid )
1312 {
1313 BOARD* mainpcb = frame->GetBoard();
1314 canInsert = true;
1315
1316 // search if the source footprint was not deleted:
1317 for( FOOTPRINT* candidate : mainpcb->Footprints() )
1318 {
1319 if( editorFootprint->GetLink() == candidate->m_Uuid )
1320 {
1321 canInsert = false;
1322 break;
1323 }
1324 }
1325 }
1326
1327 return canInsert;
1328 };
1329
1330 // clang-format off
1331 mgr->SetConditions( ACTIONS::saveAs, ENABLE( footprintTargettedCond ) );
1334 mgr->SetConditions( PCB_ACTIONS::editLibFpInFpEditor,ENABLE( footprintFromBoardCond ) );
1335
1336 mgr->SetConditions( PCB_ACTIONS::saveFpToBoard, ENABLE( boardFootprintExistsCond ) );
1337 mgr->SetConditions( PCB_ACTIONS::loadFpFromBoard, ENABLE( pcbFrameExistsCond ) );
1338
1341
1344
1345 mgr->SetConditions( ACTIONS::cut, ENABLE( cond.HasItems() ) );
1346 mgr->SetConditions( ACTIONS::copy, ENABLE( cond.HasItems() ) );
1353
1360
1364
1367 // clang-format on
1368
1369 auto highContrastCond =
1370 [this]( const SELECTION& )
1371 {
1373 };
1374
1375 auto boardFlippedCond =
1376 [this]( const SELECTION& )
1377 {
1378 return GetCanvas() && GetCanvas()->GetView()->IsMirroredX();
1379 };
1380
1381 auto libraryTreeCond =
1382 [this](const SELECTION& )
1383 {
1384 return IsLibraryTreeShown();
1385 };
1386
1387 auto layerManagerCond =
1388 [this]( const SELECTION& )
1389 {
1390 return m_auimgr.GetPane( "LayersManager" ).IsShown();
1391 };
1392
1393 auto propertiesCond =
1394 [this] ( const SELECTION& )
1395 {
1396 return m_auimgr.GetPane( PropertiesPaneName() ).IsShown();
1397 };
1398
1399 mgr->SetConditions( ACTIONS::highContrastMode, CHECK( highContrastCond ) );
1400 mgr->SetConditions( PCB_ACTIONS::flipBoard, CHECK( boardFlippedCond ) );
1402
1403 mgr->SetConditions( ACTIONS::showLibraryTree, CHECK( libraryTreeCond ) );
1404 mgr->SetConditions( PCB_ACTIONS::showLayersManager, CHECK( layerManagerCond ) );
1405 mgr->SetConditions( ACTIONS::showProperties, CHECK( propertiesCond ) );
1406
1407 mgr->SetConditions( ACTIONS::print, ENABLE( haveFootprintCond ) );
1408 mgr->SetConditions( PCB_ACTIONS::exportFootprint, ENABLE( haveFootprintCond ) );
1409 mgr->SetConditions( PCB_ACTIONS::placeImportedGraphics, ENABLE( haveFootprintCond ) );
1410
1411 mgr->SetConditions( PCB_ACTIONS::footprintProperties, ENABLE( footprintSelectedInTreeCond || haveFootprintCond ) );
1412 mgr->SetConditions( PCB_ACTIONS::padTable, ENABLE( haveFootprintCond ) );
1413 mgr->SetConditions( PCB_ACTIONS::editTextAndGraphics, ENABLE( haveFootprintCond ) );
1414 mgr->SetConditions( PCB_ACTIONS::checkFootprint, ENABLE( haveFootprintCond ) );
1415 mgr->SetConditions( PCB_ACTIONS::repairFootprint, ENABLE( haveFootprintCond ) );
1416 mgr->SetConditions( PCB_ACTIONS::cleanupGraphics, ENABLE( haveFootprintCond ) );
1417 mgr->SetConditions( ACTIONS::showDatasheet, ENABLE( haveFootprintCond ) );
1418
1419 const auto isArcKeepCenterMode =
1420 [this]( const SELECTION& )
1421 {
1423 };
1424
1425 const auto isArcKeepEndpointMode =
1426 [this]( const SELECTION& )
1427 {
1429 };
1430
1431 const auto isArcKeepRadiusMode =
1432 [this]( const SELECTION& )
1433 {
1435 };
1436
1437 // clang-format off
1438 mgr->SetConditions( ACTIONS::pointEditorArcKeepCenter, CHECK( isArcKeepCenterMode ) );
1439 mgr->SetConditions( ACTIONS::pointEditorArcKeepEndpoint, CHECK( isArcKeepEndpointMode ) );
1440 mgr->SetConditions( ACTIONS::pointEditorArcKeepRadius, CHECK( isArcKeepRadiusMode ) );
1441 // clang-format on
1442
1443// Only enable a tool if the part is edtable
1444#define CURRENT_EDIT_TOOL( action ) \
1445 mgr->SetConditions( action, ACTION_CONDITIONS().Enable( haveFootprintCond ) \
1446 .Check( cond.CurrentTool( action ) ) )
1447
1472
1473#undef CURRENT_EDIT_TOOL
1474#undef ENABLE
1475#undef CHECK
1476}
1477
1478
1480{
1482
1483 // Be sure the axis are enabled
1484 GetCanvas()->GetGAL()->SetAxesEnabled( true );
1485
1486 UpdateView();
1487
1488 // Ensure the m_Layers settings are using the canvas type:
1490}
1491
1492
1494{
1496
1498 {
1499 GetGalDisplayOptions().ReadWindowSettings( cfg->m_Window );
1500
1501 GetBoard()->GetDesignSettings() = cfg->m_DesignSettings;
1503 }
1504
1508
1510
1511 if( aFlags & ENVVARS_CHANGED )
1512 SyncLibraryTree( true );
1513
1514 Layout();
1515 SendSizeEvent();
1516}
1517
1518
1519std::unique_ptr<GRID_HELPER> FOOTPRINT_EDIT_FRAME::MakeGridHelper()
1520{
1521 return std::make_unique<PCB_GRID_HELPER>( m_toolManager, GetMagneticItemsSettings() );
1522}
1523
1524
1526{
1527 LIB_ID id = GetLoadedFPID();
1528
1529 if( id.empty() )
1530 {
1531 DisplayErrorMessage( this, _( "No footprint selected." ) );
1532 return;
1533 }
1534
1535 wxFileName fn( id.GetLibItemName() );
1536 fn.SetExt( wxT( "png" ) );
1537
1538 wxString projectPath = wxPathOnly( Prj().GetProjectFullName() );
1539
1540 wxFileDialog dlg( this, _( "Export View as PNG" ), projectPath, fn.GetFullName(),
1541 FILEEXT::PngFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1542
1544
1545 if( dlg.ShowModal() == wxID_CANCEL || dlg.GetPath().IsEmpty() )
1546 return;
1547
1548 // calling wxYield is mandatory under Linux, after closing the file selector dialog
1549 // to refresh the screen before creating the PNG or JPEG image from screen
1550 wxYield();
1551 this->SaveCanvasImageToFile( dlg.GetPath(), BITMAP_TYPE::PNG );
1552}
@ 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:198
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:164
static TOOL_ACTION saveAs
Definition actions.h:59
static TOOL_ACTION copy
Definition actions.h:78
static TOOL_ACTION pluginsReload
Definition actions.h:294
static TOOL_ACTION group
Definition actions.h:239
static TOOL_ACTION pasteSpecial
Definition actions.h:81
static TOOL_ACTION showDatasheet
Definition actions.h:267
static TOOL_ACTION pointEditorArcKeepCenter
Definition actions.h:273
static TOOL_ACTION ungroup
Definition actions.h:240
static TOOL_ACTION toggleBoundingBoxes
Definition actions.h:157
static TOOL_ACTION pointEditorArcKeepRadius
Definition actions.h:275
static TOOL_ACTION undo
Definition actions.h:75
static TOOL_ACTION duplicate
Definition actions.h:84
static TOOL_ACTION highContrastMode
Definition actions.h:155
static TOOL_ACTION embeddedFiles
Definition actions.h:297
static TOOL_ACTION measureTool
Definition actions.h:252
static TOOL_ACTION doDelete
Definition actions.h:85
static TOOL_ACTION selectionTool
Definition actions.h:251
static TOOL_ACTION save
Definition actions.h:58
static TOOL_ACTION zoomFitScreen
Definition actions.h:142
static TOOL_ACTION redo
Definition actions.h:76
static TOOL_ACTION deleteTool
Definition actions.h:86
static TOOL_ACTION zoomTool
Definition actions.h:146
static TOOL_ACTION print
Definition actions.h:64
static TOOL_ACTION showProperties
Definition actions.h:266
static TOOL_ACTION cut
Definition actions.h:77
static TOOL_ACTION gridSetOrigin
Definition actions.h:195
static TOOL_ACTION ddAddLibrary
Definition actions.h:67
static TOOL_ACTION toggleGridOverrides
Definition actions.h:199
static TOOL_ACTION selectAll
Definition actions.h:82
static TOOL_ACTION pointEditorArcKeepEndpoint
Definition actions.h:274
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:83
virtual LSET GetLayerSet() const
Return a std::bitset of all layers on which the item physically resides.
Definition board_item.h:256
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:748
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:1018
const FOOTPRINTS & Footprints() const
Definition board.h:363
void SetCopperLayerCount(int aCount)
Definition board.cpp:927
void DeleteAllFootprints()
Remove all footprints from the deque and free the memory associated with them.
Definition board.cpp:1753
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition board.cpp:1084
void SetEnabledLayers(const LSET &aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
Definition board.cpp:989
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.
An interface to the global shared library manager that is schematic-specific and linked to one projec...
bool IsFootprintLibWritable(const wxString &aNickname)
Return true if the library given by aNickname is writable.
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:312
EDA_ITEM * Clone() const override
Invoke a function on all children.
std::deque< PAD * > & Pads()
Definition footprint.h:306
const LIB_ID & GetFPID() const
Definition footprint.h:351
const LSET & GetStackupLayers() const
Definition footprint.h:415
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:1075
const wxString & GetReference() const
Definition footprint.h:751
FOOTPRINT_STACKUP GetStackupMode() const
Definition footprint.h:408
DRAWINGS & GraphicalItems()
Definition footprint.h:309
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
void AddLibraries(EDA_BASE_FRAME *aParent)
static wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > Create(FOOTPRINT_EDIT_FRAME *aFrame, FOOTPRINT_LIBRARY_ADAPTER *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.
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition pcb_view.cpp:91
void UpdateAllLayersColor()
Apply the new coloring scheme to all layers.
Definition view.cpp:776
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:294
void OnKiCadExit()
Definition kiway.cpp:761
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
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:154
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:153
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
static const LSET & UserMask()
Definition lset.cpp:690
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:676
static LSET UserDefinedLayersMask(int aUserDefinedLayerCount=MAX_USER_DEFINED_LAYERS)
Return a mask with the requested number of user defined layers.
Definition lset.cpp:704
static LSET AllCuMask()
return AllCuMask( MAX_CU_LAYERS );
Definition lset.cpp:608
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:803
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:132
The interactive edit tool.
static FOOTPRINT_LIBRARY_ADAPTER * FootprintLibAdapter(PROJECT *aProject)
@ PCB_FOOTPRINT_EDITOR_FP_NAME
Definition project.h:230
@ PCB_FOOTPRINT_EDITOR_LIB_NICKNAME
Definition project.h:231
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:340
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:351
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.
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:109
const char * c_str() const
Definition utf8.h:108
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.
bool HasCloseButton() const
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
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:131
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition confirm.cpp:202
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:94
@ EXPAND_INNER_LAYERS
The 'normal' stackup handling, where there is a single inner layer (In1) and rule areas using it expa...
Definition footprint.h:99
@ CUSTOM_LAYERS
Stackup handling where the footprint can have any number of copper layers, and objects on those layer...
Definition footprint.h:104
#define CURRENT_EDIT_TOOL(action)
@ 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:113
@ ID_ON_ZOOM_SELECT
Definition id.h:112
PROJECT & Prj()
Definition kicad.cpp:637
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:759
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
void AllowNetworkFileSystems(wxDialog *aDialog)
Configure a file dialog to show network and virtual file systems.
Definition wxgtk/ui.cpp:717
#define _HKI(x)
Definition page_info.cpp:44
@ ID_FPEDIT_SAVE_PNG
Definition pcbnew_id.h:81
BOARD * GetBoard()
PGM_BASE & Pgm()
The global program "get" accessor.
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.