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"
37#include <bitmaps.h>
38#include <board.h>
40#include <widgets/wx_infobar.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>
56#include <string_utils.h>
58#include <tool/action_toolbar.h>
59#include <tool/common_control.h>
60#include <tool/common_tools.h>
62#include <tool/selection.h>
65#include <tool/tool_manager.h>
66#include <tool/zoom_tool.h>
67#include <tools/array_tool.h>
74#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
140 GetBoard()->SetBoardUse( BOARD_USE::FPHOLDER );
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.
145 GetBoard()->GetDesignSettings().m_NetSettings->GetDefaultNetclass()->SetClearance( 0 );
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.
149 GetBoard()->GetDesignSettings().m_SolderMaskExpansion = 0;
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
154 GetBoard()->SetVisibleAlls();
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 // Don't use -1 for don't-change-height on a growable panel; it has side-effects.
231 .MinSize( FromDIP( 250 ), FromDIP( 80 ) )
232 .BestSize( FromDIP( 250 ), -1 ) );
234 .Left().Layer( 3 )
235 .Caption( _( "Properties" ) ).PaneBorder( false )
236 .MinSize( FromDIP( wxSize( 240, 60 ) ) ).BestSize( FromDIP( wxSize( 300, 200 ) ) ) );
237 m_auimgr.AddPane( m_tbLeft, EDA_PANE().VToolbar().Name( "LeftToolbar" )
238 .Left().Layer( 2 ) );
239
240 m_auimgr.AddPane( m_tbRight, EDA_PANE().VToolbar().Name( "RightToolbar" )
241 .Right().Layer(2) );
242 m_auimgr.AddPane( m_appearancePanel, EDA_PANE().Name( "LayersManager" )
243 .Right().Layer( 3 )
244 .Caption( _( "Appearance" ) ).PaneBorder( false )
245 // Don't use -1 for don't-change-height on a growable panel; it has side-effects.
246 .MinSize( FromDIP( 180 ), FromDIP( 80 ) )
247 .BestSize( FromDIP( 180 ), -1 ) );
248 m_auimgr.AddPane( m_selectionFilterPanel, EDA_PANE().Palette().Name( "SelectionFilter" )
249 .Right().Layer( 3 ).Position( 2 )
250 .Caption( _( "Selection Filter" ) ).PaneBorder( false )
251 // Fixed-size pane; -1 for MinSize height is required
252 .MinSize( FromDIP( 180 ), -1 )
253 .BestSize( FromDIP( 180 ), -1 ) );
254
255 // Center
256 m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" )
257 .Center() );
258
260
261 m_auimgr.GetPane( "LayersManager" ).Show( m_show_layer_manager_tools );
262 m_auimgr.GetPane( "SelectionFilter" ).Show( m_show_layer_manager_tools );
263 m_auimgr.GetPane( PropertiesPaneName() ).Show( GetSettings()->m_AuiPanels.show_properties );
264
265 // The selection filter doesn't need to grow in the vertical direction when docked
266 m_auimgr.GetPane( "SelectionFilter" ).dock_proportion = 0;
267
270 DragAcceptFiles( true );
271
273
274 // Apply saved visibility stuff at the end
275 wxAuiPaneInfo& treePane = m_auimgr.GetPane( "Footprints" );
276 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( "LayersManager" );
277
278 if( libWidth > 0 )
279 SetAuiPaneSize( m_auimgr, treePane, libWidth, -1 );
280
281 if( aui_cfg.right_panel_width > 0 )
282 SetAuiPaneSize( m_auimgr, layersManager, aui_cfg.right_panel_width, -1 );
283
284 m_appearancePanel->SetTabIndex( aui_cfg.appearance_panel_tab );
285
287 {
288 m_appearancePanel->SetUserLayerPresets( cfg->m_LayerPresets );
289 m_appearancePanel->ApplyLayerPreset( cfg->m_ActiveLayerPreset );
290 }
291
292 // restore the last footprint from the project, if any, after the library has been init'ed
293 // N.B. This needs to happen after the AUI manager has been initialized so that we can
294 // properly call the WX_INFOBAR without crashing on some systems.
296
297 // This displays the last footprint loaded, if any, so it must be done after restoreLastFootprint()
299
300 GetToolManager()->PostAction( ACTIONS::zoomFitScreen );
301 UpdateTitle();
303
305
306 // Default shutdown reason until a file is loaded
307 KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Footprint changes are unsaved" ) );
308
309 // Catch unhandled accelerator command characters that were no handled by the library tree
310 // panel.
312 Bind( wxEVT_CHAR_HOOK, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
313
314 // Ensure the window is on top
315 Raise();
316 Show( true );
317
318 // Register a call to update the toolbar sizes. It can't be done immediately because
319 // it seems to require some sizes calculated that aren't yet (at least on GTK).
320 CallAfter(
321 [this]()
322 {
323 // Ensure the controls on the toolbars all are correctly sized
325 m_treePane->FocusSearchFieldIfExists();
326
327 // Update the angle snap mode toolbar button to reflect the current preference
329 } );
330}
331
332
334{
335 // Shutdown all running tools
336 if( m_toolManager )
337 m_toolManager->ShutdownAllTools();
338
339 // save the footprint in the PROJECT
341
342 // Clear the watched file
343 setFPWatcher( nullptr );
344
345 // We passed ownership of these to wxAuiManager.
346 // delete m_selectionFilterPanel;
347 // delete m_appearancePanel;
348 // delete m_treePane;
349}
350
351
353{
355
356 FOOTPRINT* fp = static_cast<FOOTPRINT*>( GetModel() );
357
358 if( fp )
359 {
360 std::vector<MSG_PANEL_ITEM> msgItems;
361 fp->GetMsgPanelInfo( this, msgItems );
362 SetMsgPanel( msgItems );
363 }
364}
365
366
372
373
375{
376 return m_toolManager->GetTool<PCB_SELECTION_TOOL>()->GetSelection();
377}
378
379
381{
382 // switches currently used canvas (Cairo / OpenGL).
383 PCB_BASE_FRAME::SwitchCanvas( aCanvasType );
384
385 GetCanvas()->GetGAL()->SetAxesEnabled( true );
386
387 // The base class method *does not reinit* the layers manager. We must update the layer
388 // widget to match board visibility states, both layers and render columns, and and some
389 // settings dependent on the canvas.
391}
392
393
399
400
402{
403 wxAuiPaneInfo& treePane = m_auimgr.GetPane( m_treePane );
404 treePane.Show( !IsLibraryTreeShown() );
405
406 if( IsLibraryTreeShown() )
407 {
408 // SetAuiPaneSize also updates m_auimgr
409 SetAuiPaneSize( m_auimgr, treePane, m_editorSettings->m_LibWidth, -1 );
410 }
411 else
412 {
413 m_editorSettings->m_LibWidth = m_treePane->GetSize().x;
414 m_auimgr.Update();
415 }
416}
417
418
420{
421 m_treePane->FocusSearchFieldIfExists();
422}
423
424
426{
428 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( "LayersManager" );
429 wxAuiPaneInfo& selectionFilter = m_auimgr.GetPane( "SelectionFilter" );
430
431 // show auxiliary Vertical layers and visibility manager toolbar
433 layersManager.Show( m_show_layer_manager_tools );
434 selectionFilter.Show( m_show_layer_manager_tools );
435
437 {
438 SetAuiPaneSize( m_auimgr, layersManager, settings->m_AuiPanels.right_panel_width, -1 );
439 }
440 else
441 {
442 settings->m_AuiPanels.right_panel_width = m_appearancePanel->GetSize().x;
443 m_auimgr.Update();
444 }
445}
446
447
449{
450 return const_cast<wxAuiManager&>( m_auimgr ).GetPane( m_treePane ).IsShown();
451}
452
453
458
459
461{
462 LIB_ID id;
463
464 if( IsLibraryTreeShown() )
466
467 if( id.GetLibNickname().empty() )
468 id = GetLoadedFPID();
469
470 return id;
471}
472
473
475{
476 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
477
478 if( footprint )
479 return LIB_ID( footprint->GetFPID().GetLibNickname(), m_footprintNameWhenLoaded );
480 else
481 return LIB_ID();
482}
483
484
486{
487 if( GetBoard()->GetFirstFootprint() )
488 {
491 }
492
493 GetScreen()->SetContentModified( false );
494}
495
496
498{
499 // If we've already vetted closing this window, then we have no FP anymore
500 if( m_isClosing || !GetBoard() )
501 return false;
502
503 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
504
505 return ( footprint && footprint->GetLink() != niluuid );
506}
507
508
510{
511 LIB_ID id = GetLoadedFPID();
512
513 if( id.IsValid() )
514 {
516 Prj().SetRString( PROJECT::PCB_FOOTPRINT_EDITOR_FP_NAME, id.GetLibItemName() );
517 }
518}
519
520
522{
523 const wxString& footprintName = Prj().GetRString( PROJECT::PCB_FOOTPRINT_EDITOR_FP_NAME );
524 const wxString& libNickname = Prj().GetRString( PROJECT::PCB_FOOTPRINT_EDITOR_LIB_NICKNAME );
525
526 if( libNickname.Length() && footprintName.Length() )
527 {
528 LIB_ID id;
529 id.SetLibNickname( libNickname );
530 id.SetLibItemName( footprintName );
531
532 FOOTPRINT* footprint = loadFootprint( id );
533
534 if( footprint )
535 AddFootprintToBoard( footprint );
536 }
537}
538
539
541{
542 FOOTPRINT* footprint = static_cast<FOOTPRINT*>( GetModel() );
543 BOARD& board = *GetBoard();
544
545 // All FPs have these layers enabled
546 LSET enabledLayers = LSET::AllTechMask() | LSET::UserMask();
547
548 const auto configureStackup =
549 [&]( FOOTPRINT_STACKUP aMode, const LSET& aLayerSet )
550 {
551 const LSET cuLayers = aLayerSet & LSET::AllCuMask();
552 board.SetCopperLayerCount( cuLayers.count() );
553
554 switch( aMode )
555 {
557 {
558 enabledLayers |= LSET{ F_Cu, In1_Cu, B_Cu };
559 board.SetLayerName( In1_Cu, _( "Inner layers" ) );
560 break;
561 }
562
564 {
565 // Nothing extra to add
566
567 // Clear layer name defaults
568 board.SetLayerName( In1_Cu, wxEmptyString );
569 break;
570 }
571
572 }
573
574 enabledLayers |= aLayerSet;
575 };
576
577 if( footprint )
578 {
579 configureStackup( footprint->GetStackupMode(), footprint->GetStackupLayers() );
580 }
581 else
582 {
583 // If no footprint is loaded, we assume the default stackup mode
584 configureStackup( FOOTPRINT_STACKUP::EXPAND_INNER_LAYERS, LSET{} );
585 }
586
588 {
589 m_originalFootprintCopy->RunOnChildren(
590 [&]( BOARD_ITEM* child )
591 {
592 LSET childLayers = child->GetLayerSet() & LSET::UserDefinedLayersMask();
593
594 for( PCB_LAYER_ID layer : childLayers )
595 enabledLayers.set( layer );
596 },
598 }
599
600 // Enable the user-configured number of user layers, plus any specifically named layers
602 {
603 int userLayerCount = cfg->m_DesignSettings.GetUserDefinedLayerCount();
604 enabledLayers |= LSET::UserDefinedLayersMask( userLayerCount );
605
606 for( const PCB_LAYER_ID& user : LSET::UserDefinedLayersMask() )
607 {
608 if( cfg->m_DesignSettings.m_UserLayerNames.contains( LSET::Name( user ).ToStdString() ) )
609 enabledLayers.set( user );
610 }
611 }
612
613 board.SetEnabledLayers( enabledLayers );
614
615 // Footprint Editor layer visibility is kept in the view, not the board (because the board
616 // just delegates to the project file, which we don't have).
617 for( const PCB_LAYER_ID& layer : GetBoard()->GetEnabledLayers() )
618 GetCanvas()->GetView()->SetLayerVisible( layer, true );
619}
620
621
623{
625
626 m_originalFootprintCopy.reset( static_cast<FOOTPRINT*>( aFootprint->Clone() ) );
627 m_originalFootprintCopy->SetParent( nullptr );
628
630
632 // Ensure item UUIDs are valid
633 // ("old" footprints can have null uuids that create issues in fp editor)
634 aFootprint->FixUuids();
635
637
638 // Use CallAfter so that we update the canvas before waiting for the infobar animation
639 CallAfter(
640 [this]()
641 {
643 wxString libName = fp->GetFPID().GetLibNickname();
644 wxString msg, link;
645
647 {
648 msg.Printf( _( "Editing %s from board. Saving will update the board only." ), fp->GetReference() );
649 link.Printf( _( "Open in library %s" ), UnescapeString( libName ) );
650
651 const auto openLibraryCopy =
652 [this]( wxHyperlinkEvent& aEvent )
653 {
655 };
656
657 if( WX_INFOBAR* infobar = GetInfoBar() )
658 {
659 wxHyperlinkCtrl* button = new wxHyperlinkCtrl( infobar, wxID_ANY, link, wxEmptyString );
660 button->Bind( wxEVT_COMMAND_HYPERLINK, openLibraryCopy );
661
662 infobar->RemoveAllButtons();
663 infobar->AddButton( button );
664 infobar->AddCloseButton();
665 infobar->ShowMessage( msg, wxICON_INFORMATION );
666 }
667 }
668 // An empty libname is OK - you get that when creating a new footprint from the main menu
669 // In that case. treat is as editable, and the user will be prompted for save-as when saving.
670 else if( !libName.empty()
671 && !PROJECT_PCB::FootprintLibAdapter( &Prj() )->IsFootprintLibWritable( libName ) )
672 {
673 msg.Printf( _( "Editing footprint from read-only library %s." ), UnescapeString( libName ) );
674
675 if( WX_INFOBAR* infobar = GetInfoBar() )
676 {
677 link = _( "Save as editable copy" );
678
679 const auto saveAsEditableCopy =
680 [this]( wxHyperlinkEvent& aEvent )
681 {
682 SaveFootprintAs( GetBoard()->GetFirstFootprint() );
683 GetCanvas()->GetView()->Update( GetBoard()->GetFirstFootprint() );
684 ClearModify();
685
686 // Get rid of the save-will-update-board-only (or any other dismissable warning)
687 WX_INFOBAR* loc_infobar = GetInfoBar();
688
689 if( loc_infobar->IsShownOnScreen() && loc_infobar->HasCloseButton() )
690 loc_infobar->Dismiss();
691
693 SyncLibraryTree( true );
694 };
695
696 wxHyperlinkCtrl* button = new wxHyperlinkCtrl( infobar, wxID_ANY, link, wxEmptyString );
697 button->Bind( wxEVT_COMMAND_HYPERLINK, saveAsEditableCopy );
698
699 infobar->RemoveAllButtons();
700 infobar->AddButton( button );
701 infobar->AddCloseButton();
702 infobar->ShowMessage( msg, wxICON_INFORMATION );
703 }
704 }
705 else
706 {
707 if( WX_INFOBAR* infobar = GetInfoBar() )
708 infobar->Dismiss();
709 }
710 } );
711
714}
715
716
718{
719 ReloadFootprint( aFootprint );
720
722 setFPWatcher( nullptr );
723 else
724 setFPWatcher( aFootprint );
725}
726
727
732
733
738
739
741{
742 wxFAIL_MSG( wxT( "Plotting not supported in Footprint Editor" ) );
743
745}
746
747
749{
750 wxFAIL_MSG( wxT( "Plotting not supported in Footprint Editor" ) );
751}
752
753
761
762
770
771
773{
774 // Get our own settings; aCfg will be the PCBNEW_SETTINGS because we're part of the pcbnew
775 // compile unit
777
778 if( cfg )
779 {
781
783
786
788 m_selectionFilterPanel->SetCheckboxesFromFilter( cfg->m_SelectionFilter );
789
791
792 for( auto& [source_name, dest_name] : cfg->m_DesignSettings.m_UserLayerNames )
793 {
794 wxString wx_source_name = source_name;
795 PCB_LAYER_ID layer = static_cast<PCB_LAYER_ID>( LSET::NameToLayer( wx_source_name ) );
796
797 if( IsUserLayer( layer ) )
798 GetBoard()->SetLayerName( layer, dest_name );
799 }
800
801 }
802}
803
804
806{
807 // Load canvas type from the FOOTPRINT_EDITOR_SETTINGS:
809
810 // If we had an OpenGL failure this session, use the fallback GAL but don't update the
811 // user preference silently:
812
815}
816
817
819{
821
822 // Get our own settings; aCfg will be the PCBNEW_SETTINGS because we're part of the pcbnew
823 // compile unit
825
826 if( cfg )
827 {
829
832 cfg->m_LibWidth = m_treePane->GetSize().x;
833
834 if( TOOL_MANAGER* toolMgr = GetToolManager() )
835 {
836 if( PCB_SELECTION_TOOL* selTool = toolMgr->GetTool<PCB_SELECTION_TOOL>() )
837 cfg->m_SelectionFilter = selTool->GetFilter();
838 }
839
841
843 {
844 cfg->m_AuiPanels.show_properties = m_propertiesPanel->IsShownOnScreen();
846 cfg->m_AuiPanels.properties_splitter = m_propertiesPanel->SplitterProportion();
847 }
848
850
852 {
855 cfg->m_LayerPresets = m_appearancePanel->GetUserLayerPresets();
856 cfg->m_ActiveLayerPreset = m_appearancePanel->GetActiveLayerPreset();
857 }
858 }
859}
860
861
862
864{
865 FOOTPRINT_EDITOR_SETTINGS* cfg = const_cast<FOOTPRINT_EDIT_FRAME*>( this )->GetSettings();
866
867 return cfg ? cfg->m_RotationAngle : ANGLE_90;
868}
869
870
871
873{
875 return ::GetColorSettings( cfg ? cfg->m_ColorTheme : DEFAULT_THEME );
876}
877
878
880{
881 static MAGNETIC_SETTINGS fallback;
882
884 return &cfg->m_MagneticItems;
885
886 return &fallback;
887}
888
889
890const BOX2I FOOTPRINT_EDIT_FRAME::GetDocumentExtents( bool aIncludeAllVisible ) const
891{
892 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
893
894 if( footprint )
895 {
896 bool hasGraphicalItem = footprint->Pads().size() || footprint->Zones().size();
897
898 if( !hasGraphicalItem )
899 {
900 for( const BOARD_ITEM* item : footprint->GraphicalItems() )
901 {
902 if( item->Type() == PCB_TEXT_T || item->Type() == PCB_TEXTBOX_T )
903 continue;
904
905 hasGraphicalItem = true;
906 break;
907 }
908 }
909
910 if( hasGraphicalItem )
911 {
912 return footprint->GetBoundingBox( false );
913 }
914 else
915 {
916 BOX2I newFootprintBB( { 0, 0 }, { 0, 0 } );
917 newFootprintBB.Inflate( pcbIUScale.mmToIU( 12 ) );
918 return newFootprintBB;
919 }
920 }
921
922 return GetBoardBoundingBox( false );
923}
924
925
927{
928 if( IsContentModified() )
929 {
930 wxString footprintName = GetBoard()->GetFirstFootprint()->GetReference();
931 wxString msg = _( "Save changes to '%s' before closing?" );
932
933 if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
934 [&]() -> bool
935 {
936 return SaveFootprint( GetBoard()->GetFirstFootprint() );
937 } ) )
938 {
939 return false;
940 }
941 }
942
943 if( doClose )
944 {
945 GetInfoBar()->ShowMessageFor( wxEmptyString, 1 );
946 Clear_Pcb( false );
947 UpdateTitle();
948 }
949
950 return true;
951}
952
953
954bool FOOTPRINT_EDIT_FRAME::canCloseWindow( wxCloseEvent& aEvent )
955{
956 if( IsContentModified() )
957 {
958 // Shutdown blocks must be determined and vetoed as early as possible
960 aEvent.GetId() == wxEVT_QUERY_END_SESSION )
961 {
962 aEvent.Veto();
963 return false;
964 }
965
966 wxString footprintName = GetBoard()->GetFirstFootprint()->GetFPID().GetLibItemName();
967
969 footprintName = GetBoard()->GetFirstFootprint()->GetReference();
970
971 wxString msg = _( "Save changes to '%s' before closing?" );
972
973 if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
974 [&]() -> bool
975 {
976 return SaveFootprint( GetBoard()->GetFirstFootprint() );
977 } ) )
978 {
979 aEvent.Veto();
980 return false;
981 }
982 }
983
984 PAD_TOOL* padTool = m_toolManager->GetTool<PAD_TOOL>();
985
986 if( padTool->InPadEditMode() )
987 padTool->ExitPadEditMode();
988
989 // Save footprint tree column widths
990 m_adapter->SaveSettings();
991
993}
994
995
997{
998 // No more vetos
999 GetCanvas()->SetEventDispatcher( nullptr );
1001
1002 if( GetLibTree() )
1004
1005 // Do not show the layer manager during closing to avoid flicker
1006 // on some platforms (Windows) that generate useless redraw of items in
1007 // the Layer Manager
1008 m_auimgr.GetPane( wxT( "LayersManager" ) ).Show( false );
1009 m_auimgr.GetPane( wxT( "SelectionFilter" ) ).Show( false );
1010
1011 Clear_Pcb( false );
1012}
1013
1014
1015void FOOTPRINT_EDIT_FRAME::OnExitKiCad( wxCommandEvent& event )
1016{
1017 Kiway().OnKiCadExit();
1018}
1019
1020
1022{
1023 Close();
1024}
1025
1026
1028{
1029 // call my base class
1031
1032 // We have 2 panes to update.
1033 // For some obscure reason, the AUI manager hides the first modified pane.
1034 // So force show panes
1035 wxAuiPaneInfo& tree_pane_info = m_auimgr.GetPane( m_treePane );
1036 bool tree_shown = tree_pane_info.IsShown();
1037 tree_pane_info.Caption( _( "Libraries" ) );
1038
1039 wxAuiPaneInfo& lm_pane_info = m_auimgr.GetPane( m_appearancePanel );
1040 bool lm_shown = lm_pane_info.IsShown();
1041 lm_pane_info.Caption( _( "Appearance" ) );
1042 wxAuiPaneInfo& sf_pane_info = m_auimgr.GetPane( m_selectionFilterPanel );
1043 sf_pane_info.Caption( _( "Selection Filter" ) );
1044
1045 // update the layer manager
1047
1048 // Now restore the visibility:
1049 lm_pane_info.Show( lm_shown );
1050 tree_pane_info.Show( tree_shown );
1051 m_auimgr.Update();
1052
1054
1055 UpdateTitle();
1056}
1057
1058
1060{
1062
1063 if( m_isClosing )
1064 return;
1065
1066 Update3DView( true, true );
1068
1069 if( !GetTitle().StartsWith( wxT( "*" ) ) )
1070 UpdateTitle();
1071}
1072
1073
1075{
1076 wxString title;
1077 LIB_ID fpid = GetLoadedFPID();
1078 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
1079 bool writable = true;
1080
1081 if( IsCurrentFPFromBoard() )
1082 {
1083 if( IsContentModified() )
1084 title = wxT( "*" );
1085
1086 title += footprint->GetReference();
1087 title += wxS( " " ) + wxString::Format( _( "[from %s]" ), Prj().GetProjectName()
1088 + wxT( "." )
1089 + FILEEXT::PcbFileExtension );
1090 }
1091 else if( fpid.IsValid() )
1092 {
1093 try
1094 {
1096 }
1097 catch( const IO_ERROR& )
1098 {
1099 // best efforts...
1100 }
1101
1102 // Note: don't used GetLoadedFPID(); footprint name may have been edited
1103 if( IsContentModified() )
1104 title = wxT( "*" );
1105
1106 title += From_UTF8( footprint->GetFPID().Format().c_str() );
1107
1108 if( !writable )
1109 title += wxS( " " ) + _( "[Read Only]" );
1110 }
1111 else if( !fpid.GetLibItemName().empty() )
1112 {
1113 // Note: don't used GetLoadedFPID(); footprint name may have been edited
1114 if( IsContentModified() )
1115 title = wxT( "*" );
1116
1117 title += From_UTF8( footprint->GetFPID().GetLibItemName().c_str() );
1118 title += wxS( " " ) + _( "[Unsaved]" );
1119 }
1120 else
1121 {
1122 title = _( "[no footprint loaded]" );
1123 }
1124
1125 title += wxT( " \u2014 " ) + _( "Footprint Editor" );
1126
1127 SetTitle( title );
1128}
1129
1130
1132{
1133 m_appearancePanel->OnBoardChanged();
1134}
1135
1136
1138{
1142 m_propertiesPanel->UpdateData();
1143 UpdateTitle();
1144}
1145
1146
1148{
1150
1152 auto adapter = static_cast<FP_TREE_SYNCHRONIZING_ADAPTER*>( m_adapter.get() );
1153
1154 adapter->AddLibraries( this );
1155}
1156
1157
1158void FOOTPRINT_EDIT_FRAME::SyncLibraryTree( [[maybe_unused]] bool aProgress )
1159{
1161 auto adapter = static_cast<FP_TREE_SYNCHRONIZING_ADAPTER*>( m_adapter.get() );
1162 LIB_ID target = GetTargetFPID();
1163 bool targetSelected = ( target == GetLibTree()->GetSelectedLibId() );
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( footprints );
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 PROPERTIES_TOOL );
1242 m_toolManager->RegisterTool( new EMBED_TOOL );
1243
1244 for( TOOL_BASE* tool : m_toolManager->Tools() )
1245 {
1246 if( PCB_TOOL_BASE* pcbTool = dynamic_cast<PCB_TOOL_BASE*>( tool ) )
1247 pcbTool->SetIsFootprintEditor( true );
1248 }
1249
1250 m_toolManager->GetTool<PCB_VIEWER_TOOLS>()->SetFootprintFrame( true );
1251 m_toolManager->InitTools();
1252
1253 m_toolManager->InvokeTool( "common.InteractiveSelection" );
1254
1255 // Load or reload wizard plugins in case they changed since the last time the frame opened
1256 // Because the board editor has also a plugin python menu,
1257 // call the PCB_EDIT_FRAME RunAction() if the board editor is running
1258 // Otherwise run the current RunAction().
1259 PCB_EDIT_FRAME* pcbframe = static_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
1260
1261 if( pcbframe )
1263 else
1265}
1266
1267
1269{
1271
1272 ACTION_MANAGER* mgr = m_toolManager->GetActionManager();
1273 PCB_EDITOR_CONDITIONS cond( this );
1274
1275 wxASSERT( mgr );
1276
1277#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
1278#define CHECK( x ) ACTION_CONDITIONS().Check( x )
1279
1280 auto haveFootprintCond =
1281 [this]( const SELECTION& )
1282 {
1283 return GetBoard() && GetBoard()->GetFirstFootprint() != nullptr;
1284 };
1285
1286 auto footprintTargettedCond =
1287 [this]( const SELECTION& )
1288 {
1289 return !GetTargetFPID().GetLibItemName().empty();
1290 };
1291
1292 auto footprintSelectedInTreeCond =
1293 [this]( const SELECTION& )
1294 {
1296 return !sel.GetLibNickname().empty() && !sel.GetLibItemName().empty();
1297 };
1298
1299 const auto footprintFromBoardCond =
1300 [this]( const SELECTION& )
1301 {
1302 return IsCurrentFPFromBoard();
1303 };
1304
1305 auto pcbFrameExistsCond =
1306 [this]( const SELECTION& )
1307 {
1308 PCB_EDIT_FRAME* frame = dynamic_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
1309
1310 return ( frame != nullptr );
1311 };
1312
1313 auto boardFootprintExistsCond =
1314 [this]( const SELECTION& )
1315 {
1316 PCB_EDIT_FRAME* frame = dynamic_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
1317
1318 FOOTPRINT* editorFootprint = GetBoard()->GetFirstFootprint();
1319 bool canInsert = frame && editorFootprint && editorFootprint->GetLink() == niluuid;
1320
1321 // If the source was deleted, the footprint can inserted but not updated in the board.
1322 if( frame && editorFootprint && editorFootprint->GetLink() != niluuid )
1323 {
1324 BOARD* mainpcb = frame->GetBoard();
1325 canInsert = true;
1326
1327 // search if the source footprint was not deleted:
1328 for( FOOTPRINT* candidate : mainpcb->Footprints() )
1329 {
1330 if( editorFootprint->GetLink() == candidate->m_Uuid )
1331 {
1332 canInsert = false;
1333 break;
1334 }
1335 }
1336 }
1337
1338 return canInsert;
1339 };
1340
1341 // clang-format off
1342 mgr->SetConditions( ACTIONS::saveAs, ENABLE( footprintTargettedCond ) );
1345 mgr->SetConditions( PCB_ACTIONS::editLibFpInFpEditor,ENABLE( footprintFromBoardCond ) );
1346
1347 mgr->SetConditions( PCB_ACTIONS::saveFpToBoard, ENABLE( boardFootprintExistsCond ) );
1348 mgr->SetConditions( PCB_ACTIONS::loadFpFromBoard, ENABLE( pcbFrameExistsCond ) );
1349
1352
1355
1356 mgr->SetConditions( ACTIONS::cut, ENABLE( cond.HasItems() ) );
1357 mgr->SetConditions( ACTIONS::copy, ENABLE( cond.HasItems() ) );
1364
1371
1375
1380 // clang-format on
1381
1382 auto highContrastCond =
1383 [this]( const SELECTION& )
1384 {
1386 };
1387
1388 auto boardFlippedCond = [this]( const SELECTION& )
1389 {
1391 };
1392
1393 auto libraryTreeCond =
1394 [this](const SELECTION& )
1395 {
1396 return IsLibraryTreeShown();
1397 };
1398
1399 auto layerManagerCond =
1400 [this]( const SELECTION& )
1401 {
1402 return m_auimgr.GetPane( "LayersManager" ).IsShown();
1403 };
1404
1405 auto propertiesCond =
1406 [this] ( const SELECTION& )
1407 {
1408 return m_auimgr.GetPane( PropertiesPaneName() ).IsShown();
1409 };
1410
1411 mgr->SetConditions( ACTIONS::highContrastMode, CHECK( highContrastCond ) );
1412 mgr->SetConditions( PCB_ACTIONS::flipBoard, CHECK( boardFlippedCond ) );
1414
1415 mgr->SetConditions( ACTIONS::showLibraryTree, CHECK( libraryTreeCond ) );
1416 mgr->SetConditions( PCB_ACTIONS::showLayersManager, CHECK( layerManagerCond ) );
1417 mgr->SetConditions( ACTIONS::showProperties, CHECK( propertiesCond ) );
1418
1419 mgr->SetConditions( ACTIONS::print, ENABLE( haveFootprintCond ) );
1420 mgr->SetConditions( PCB_ACTIONS::exportFootprint, ENABLE( haveFootprintCond ) );
1421 mgr->SetConditions( PCB_ACTIONS::placeImportedGraphics, ENABLE( haveFootprintCond ) );
1422
1423 mgr->SetConditions( PCB_ACTIONS::footprintProperties, ENABLE( footprintSelectedInTreeCond || haveFootprintCond ) );
1424 mgr->SetConditions( PCB_ACTIONS::padTable, ENABLE( haveFootprintCond ) );
1425 mgr->SetConditions( PCB_ACTIONS::editTextAndGraphics, ENABLE( haveFootprintCond ) );
1426 mgr->SetConditions( PCB_ACTIONS::checkFootprint, ENABLE( haveFootprintCond ) );
1427 mgr->SetConditions( PCB_ACTIONS::repairFootprint, ENABLE( haveFootprintCond ) );
1428 mgr->SetConditions( PCB_ACTIONS::cleanupGraphics, ENABLE( haveFootprintCond ) );
1429 mgr->SetConditions( ACTIONS::showDatasheet, ENABLE( haveFootprintCond ) );
1430
1431 const auto isArcKeepCenterMode =
1432 [this]( const SELECTION& )
1433 {
1435 };
1436
1437 const auto isArcKeepEndpointMode =
1438 [this]( const SELECTION& )
1439 {
1441 };
1442
1443 const auto isArcKeepRadiusMode =
1444 [this]( const SELECTION& )
1445 {
1447 };
1448
1449 // clang-format off
1450 mgr->SetConditions( ACTIONS::pointEditorArcKeepCenter, CHECK( isArcKeepCenterMode ) );
1451 mgr->SetConditions( ACTIONS::pointEditorArcKeepEndpoint, CHECK( isArcKeepEndpointMode ) );
1452 mgr->SetConditions( ACTIONS::pointEditorArcKeepRadius, CHECK( isArcKeepRadiusMode ) );
1453 // clang-format on
1454
1455// Only enable a tool if the part is edtable
1456#define CURRENT_EDIT_TOOL( action ) \
1457 mgr->SetConditions( action, ACTION_CONDITIONS().Enable( haveFootprintCond ) \
1458 .Check( cond.CurrentTool( action ) ) )
1459
1484
1485#undef CURRENT_EDIT_TOOL
1486#undef ENABLE
1487#undef CHECK
1488}
1489
1490
1492{
1494
1495 // Be sure the axis are enabled
1496 GetCanvas()->GetGAL()->SetAxesEnabled( true );
1497
1498 UpdateView();
1499
1500 // Ensure the m_Layers settings are using the canvas type:
1502}
1503
1504
1506{
1508 m_appearancePanel->CommonSettingsChanged( aFlags );
1509
1511 {
1512 GetGalDisplayOptions().ReadWindowSettings( cfg->m_Window );
1513
1514 GetBoard()->GetDesignSettings() = cfg->m_DesignSettings;
1516 }
1517
1521
1523
1524 if( aFlags & ENVVARS_CHANGED )
1525 SyncLibraryTree( true );
1526
1527 Layout();
1528 SendSizeEvent();
1529}
1530
1531
1532std::unique_ptr<GRID_HELPER> FOOTPRINT_EDIT_FRAME::MakeGridHelper()
1533{
1534 return std::make_unique<PCB_GRID_HELPER>( m_toolManager, GetMagneticItemsSettings() );
1535}
1536
1537
1539{
1540 LIB_ID id = GetLoadedFPID();
1541
1542 if( id.empty() )
1543 {
1544 DisplayErrorMessage( this, _( "No footprint selected." ) );
1545 return;
1546 }
1547
1548 wxFileName fn( id.GetLibItemName() );
1549 fn.SetExt( wxT( "png" ) );
1550
1551 wxString projectPath = wxPathOnly( Prj().GetProjectFullName() );
1552
1553 wxFileDialog dlg( this, _( "Export View as PNG" ), projectPath, fn.GetFullName(),
1554 FILEEXT::PngFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1555
1557
1558 if( dlg.ShowModal() == wxID_CANCEL || dlg.GetPath().IsEmpty() )
1559 return;
1560
1561 // calling wxYield is mandatory under Linux, after closing the file selector dialog
1562 // to refresh the screen before creating the PNG or JPEG image from screen
1563 wxYield();
1564 this->SaveCanvasImageToFile( dlg.GetPath(), BITMAP_TYPE::PNG );
1565}
@ 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:315
@ 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 selectSetLasso
Definition actions.h:221
static TOOL_ACTION selectSetRect
Set lasso selection mode.
Definition actions.h:220
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::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:84
virtual LSET GetLayerSet() const
Return a std::bitset of all layers on which the item physically resides.
Definition board_item.h:288
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:323
bool SetLayerName(PCB_LAYER_ID aLayer, const wxString &aLayerName)
Changes the name of the layer given by aLayer.
Definition board.cpp:755
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition board.h:524
const FOOTPRINTS & Footprints() const
Definition board.h:364
void SetCopperLayerCount(int aCount)
Definition board.cpp:934
void DeleteAllFootprints()
Remove all footprints from the deque and free the memory associated with them.
Definition board.cpp:1755
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition board.cpp:1091
void SetEnabledLayers(const LSET &aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
Definition board.cpp:996
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:332
EDA_ITEM * Clone() const override
Invoke a function on all children.
std::deque< PAD * > & Pads()
Definition footprint.h:326
const LIB_ID & GetFPID() const
Definition footprint.h:371
const LSET & GetStackupLayers() const
Definition footprint.h:435
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:1093
const wxString & GetReference() const
Definition footprint.h:771
FOOTPRINT_STACKUP GetStackupMode() const
Definition footprint.h:428
DRAWINGS & GraphicalItems()
Definition footprint.h:329
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:845
void SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
Definition view.h:409
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition view.h:656
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:315
void OnKiCadExit()
Definition kiway.cpp:798
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition kiway.cpp:402
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:156
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:155
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
static const LSET & AllCuMask()
return AllCuMask( MAX_CU_LAYERS );
Definition lset.cpp:608
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 wxString Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
Definition lset.cpp:188
void ExitPadEditMode()
Definition pad_tool.cpp:804
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
bool m_FlipBoardView
true if the board is flipped to show the mirrored view
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:130
The interactive edit tool.
static FOOTPRINT_LIBRARY_ADAPTER * FootprintLibAdapter(PROJECT *aProject)
@ 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:349
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:360
Action handler for the Properties panel.
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 SELECTION_CONDITION MoreThan(int aNumber)
Create a functor that tests if the number of selected items is greater than the value given as parame...
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:77
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)
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:53
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:116
@ ID_ON_ZOOM_SELECT
Definition id.h:115
PROJECT & Prj()
Definition kicad.cpp:644
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:761
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:102
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
Definition unix/app.cpp:91
void AllowNetworkFileSystems(wxDialog *aDialog)
Configure a file dialog to show network and virtual file systems.
Definition wxgtk/ui.cpp:435
#define _HKI(x)
Definition page_info.cpp:44
@ ID_FPEDIT_SAVE_PNG
Definition pcbnew_id.h:81
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:108
@ PCB_TEXTBOX_T
class PCB_TEXTBOX, wrapped text on a layer
Definition typeinfo.h:90
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition typeinfo.h:89
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.