KiCad PCB EDA Suite
Loading...
Searching...
No Matches
eda_draw_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) 2004-2017 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
6 * Copyright (C) 2004-2023 KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
27#include <base_screen.h>
28#include <bitmaps.h>
29#include <confirm.h>
30#include <core/arraydim.h>
31#include <core/kicad_algo.h>
32#include <dialog_shim.h>
34#include <eda_draw_frame.h>
35#include <file_history.h>
37#include <id.h>
38#include <kiface_base.h>
39#include <kiplatform/ui.h>
40#include <lockfile.h>
41#include <macros.h>
42#include <math/vector2wx.h>
43#include <page_info.h>
44#include <paths.h>
45#include <pgm_base.h>
46#include <render_settings.h>
51#include <title_block.h>
52#include <tool/actions.h>
53#include <tool/action_toolbar.h>
54#include <tool/common_tools.h>
55#include <tool/grid_helper.h>
56#include <tool/grid_menu.h>
59#include <tool/tool_manager.h>
60#include <tool/tool_menu.h>
61#include <tool/zoom_menu.h>
62#include <trace_helpers.h>
63#include <view/view.h>
65#include <view/view_controls.h>
66#include <widgets/msgpanel.h>
69#include <wx/event.h>
70#include <wx/snglinst.h>
71#include <widgets/ui_common.h>
72#include <widgets/search_pane.h>
73#include <wx/dirdlg.h>
74#include <wx/filedlg.h>
75#include <wx/debug.h>
76#include <wx/socket.h>
77
78#include <wx/snglinst.h>
79#include <wx/fdrepdlg.h>
80
81#define FR_HISTORY_LIST_CNT 10
82
83
84BEGIN_EVENT_TABLE( EDA_DRAW_FRAME, KIWAY_PLAYER )
87
88 EVT_ACTIVATE( EDA_DRAW_FRAME::onActivate )
89END_EVENT_TABLE()
90
91
92bool EDA_DRAW_FRAME::m_openGLFailureOccured = false;
93
94
95EDA_DRAW_FRAME::EDA_DRAW_FRAME( KIWAY* aKiway, wxWindow* aParent, FRAME_T aFrameType,
96 const wxString& aTitle, const wxPoint& aPos, const wxSize& aSize,
97 long aStyle, const wxString& aFrameName,
98 const EDA_IU_SCALE& aIuScale ) :
99 KIWAY_PLAYER( aKiway, aParent, aFrameType, aTitle, aPos, aSize, aStyle, aFrameName, aIuScale ),
100 m_socketServer( nullptr ),
101 m_lastToolbarIconSize( 0 )
102{
103 m_mainToolBar = nullptr;
104 m_drawToolBar = nullptr;
105 m_optionsToolBar = nullptr;
106 m_auxiliaryToolBar = nullptr;
107 m_gridSelectBox = nullptr;
108 m_zoomSelectBox = nullptr;
109 m_searchPane = nullptr;
110 m_undoRedoCountMax = DEFAULT_MAX_UNDO_ITEMS;
111
113 m_canvas = nullptr;
114 m_toolDispatcher = nullptr;
115 m_messagePanel = nullptr;
116 m_currentScreen = nullptr;
117 m_showBorderAndTitleBlock = false; // true to display reference sheet.
118 m_gridColor = COLOR4D( DARKGRAY ); // Default grid color
119 m_drawBgColor = COLOR4D( BLACK ); // the background color of the draw canvas:
120 // BLACK for Pcbnew, BLACK or WHITE for Eeschema
121 m_colorSettings = nullptr;
122 m_polarCoords = false;
123 m_findReplaceData = std::make_unique<EDA_SEARCH_DATA>();
124 m_hotkeyPopup = nullptr;
125 m_propertiesPanel = nullptr;
126 m_netInspectorPanel = nullptr;
127
128 SetUserUnits( EDA_UNITS::MILLIMETRES );
129
130 m_auimgr.SetFlags( wxAUI_MGR_DEFAULT );
131
132 if( ( aStyle & wxFRAME_NO_TASKBAR ) == 0 )
133 {
134 CreateStatusBar( 8 )->SetDoubleBuffered( true );
135
136 GetStatusBar()->SetFont( KIUI::GetStatusFont( this ) );
137
138 // set the size of the status bar subwindows:
139 updateStatusBarWidths();
140 }
141
142 m_messagePanel = new EDA_MSG_PANEL( this, -1, wxPoint( 0, m_frameSize.y ), wxDefaultSize );
143 m_messagePanel->SetBackgroundColour( COLOR4D( LIGHTGRAY ).ToColour() );
144 m_msgFrameHeight = m_messagePanel->GetBestSize().y;
145
146 // Create child subwindows.
147 GetClientSize( &m_frameSize.x, &m_frameSize.y );
148 m_framePos.x = m_framePos.y = 0;
149 m_frameSize.y -= m_msgFrameHeight;
150
151 m_messagePanel->SetSize( m_frameSize.x, m_msgFrameHeight );
152
153 Bind( wxEVT_DPI_CHANGED,
154 [&]( wxDPIChangedEvent& )
155 {
156 if( ( GetWindowStyle() & wxFRAME_NO_TASKBAR ) == 0 )
157 updateStatusBarWidths();
158
159 wxMoveEvent dummy;
160 OnMove( dummy );
161
162 // we need to kludge the msg panel to the correct size again
163 // especially important even for first launches as the constructor of the window
164 // here usually doesn't have the correct dpi awareness yet
165 m_frameSize.y += m_msgFrameHeight;
166 m_msgFrameHeight = m_messagePanel->GetBestSize().y;
167 m_frameSize.y -= m_msgFrameHeight;
168
169 m_messagePanel->SetPosition( wxPoint( 0, m_frameSize.y ) );
170 m_messagePanel->SetSize( m_frameSize.x, m_msgFrameHeight );
171
172 // Don't skip, otherwise the frame gets too big
173 } );
174}
175
176
178{
180
181 delete m_actions;
182 delete m_toolManager;
183 delete m_toolDispatcher;
184 delete m_canvas;
185
186 delete m_currentScreen;
187 m_currentScreen = nullptr;
188
189 m_auimgr.UnInit();
190
191 ReleaseFile();
192}
193
194
196{
197 if( m_file_checker.get() != nullptr )
198 m_file_checker->UnlockFile();
199}
200
201
202bool EDA_DRAW_FRAME::LockFile( const wxString& aFileName )
203{
204 // We need to explicitly reset here to get the deletion before
205 // we create a new unique_ptr that may be for the same file
206 m_file_checker.reset();
207
208 m_file_checker = std::make_unique<LOCKFILE>( aFileName );
209
210 if( !m_file_checker->Valid() && m_file_checker->IsLockedByMe() )
211 {
212 // If we cannot acquire the lock but we appear to be the one who
213 // locked it, check to see if there is another KiCad instance running.
214 // If there is not, then we can override the lock. This could happen if
215 // KiCad crashed or was interrupted
216 if( !Pgm().SingleInstance()->IsAnotherRunning() )
217 m_file_checker->OverrideLock();
218 }
219 // If the file is valid, return true. This could mean that the file is
220 // locked or it could mean that the file is read-only
221 return m_file_checker->Valid();
222}
223
224
226{
227 KIWAY_PLAYER* frame = Kiway().Player( FRAME_PYTHON, false );
228
229 wxRect rect = GetScreenRect();
230 wxPoint center = rect.GetPosition() + rect.GetSize() / 2;
231
232 if( !frame )
233 {
234 frame = Kiway().Player( FRAME_PYTHON, true, Kiway().GetTop() );
235
236 // If we received an error in the CTOR due to Python-ness, don't crash
237 if( !frame )
238 return;
239
240 if( !frame->IsVisible() )
241 frame->Show( true );
242
243 // On Windows, Raise() does not bring the window on screen, when iconized
244 if( frame->IsIconized() )
245 frame->Iconize( false );
246
247 frame->Raise();
248 frame->SetPosition( center - frame->GetSize() / 2 );
249
250 return;
251 }
252
253 frame->Show( !frame->IsVisible() );
254 frame->SetPosition( center - frame->GetSize() / 2 );
255}
256
257
259{
260 KIWAY_PLAYER* frame = Kiway().Player( FRAME_PYTHON, false );
261 return frame && frame->IsVisible();
262}
263
264
266{
267 // Notify all tools the units have changed
268 if( m_toolManager )
270
274}
275
276
278{
280 {
282 m_toolManager->GetTool<COMMON_TOOLS>()->ToggleUnits( dummy );
283 }
284 else
285 {
286 SetUserUnits( GetUserUnits() == EDA_UNITS::INCHES ? EDA_UNITS::MILLIMETRES
287 : EDA_UNITS::INCHES );
289
290 wxCommandEvent e( EDA_EVT_UNITS_CHANGED );
291 ProcessEventLocally( e );
292 }
293}
294
295
296void EDA_DRAW_FRAME::CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged )
297{
298 EDA_BASE_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
299
300 COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
302
303 if( m_supportsAutoSave && m_autoSaveTimer->IsRunning() )
304 {
305 if( GetAutoSaveInterval() > 0 )
306 {
307 m_autoSaveTimer->Start( GetAutoSaveInterval() * 1000, wxTIMER_ONE_SHOT );
308 }
309 else
310 {
311 m_autoSaveTimer->Stop();
312 m_autoSavePending = false;
313 }
314 }
315
316 viewControls->LoadSettings();
317
318 m_galDisplayOptions.ReadCommonConfig( *settings, this );
319
320 GetToolManager()->RunAction( ACTIONS::gridPreset, config()->m_Window.grid.last_size_idx );
322
323 if( m_lastToolbarIconSize == 0
325 {
328 }
329
330#ifndef __WXMAC__
332
333 if( m_canvasType != GetCanvas()->GetBackend() )
334 {
335 // Try to switch (will automatically fallback if necessary)
338 bool success = newGAL == m_canvasType;
339
340 if( !success )
341 {
342 m_canvasType = newGAL;
343 m_openGLFailureOccured = true; // Store failure for other EDA_DRAW_FRAMEs
344 }
345 }
346#endif
347
348 // Notify all tools the preferences have changed
349 if( m_toolManager )
351}
352
353
355{
356 if( m_messagePanel )
358}
359
360
362{
365
366 if( m_gridSelectBox == nullptr )
367 return;
368
369 // Update grid values with the current units setting.
370 m_gridSelectBox->Clear();
371 wxArrayString gridsList;
372
373 wxCHECK( config(), /* void */ );
374
375 GRID_MENU::BuildChoiceList( &gridsList, config(), this );
376
377 for( const wxString& grid : gridsList )
378 m_gridSelectBox->Append( grid );
379
380 m_gridSelectBox->Append( wxT( "---" ) );
381 m_gridSelectBox->Append( _( "Edit Grids..." ) );
382
383 m_gridSelectBox->SetSelection( config()->m_Window.grid.last_size_idx );
384}
385
386
387void EDA_DRAW_FRAME::OnUpdateSelectGrid( wxUpdateUIEvent& aEvent )
388{
389 // No need to update the grid select box if it doesn't exist or the grid setting change
390 // was made using the select box.
391 if( m_gridSelectBox == nullptr )
392 return;
393
394 wxCHECK( config(), /* void */ );
395
396 int idx = config()->m_Window.grid.last_size_idx;
397 idx = std::clamp( idx, 0, (int) m_gridSelectBox->GetCount() - 1 );
398
399 if( idx != m_gridSelectBox->GetSelection() )
400 m_gridSelectBox->SetSelection( idx );
401}
402
403
404
405void EDA_DRAW_FRAME::OnUpdateSelectZoom( wxUpdateUIEvent& aEvent )
406{
407 // No need to update the grid select box if it doesn't exist or the grid setting change
408 // was made using the select box.
409 if( m_zoomSelectBox == nullptr )
410 return;
411
412 double zoom = GetCanvas()->GetGAL()->GetZoomFactor();
413
414 wxCHECK( config(), /* void */ );
415
416 const std::vector<double>& zoomList = config()->m_Window.zoom_factors;
417 int curr_selection = m_zoomSelectBox->GetSelection();
418 int new_selection = 0; // select zoom auto
419 double last_approx = 1e9; // large value to start calculation
420
421 // Search for the nearest available value to the current zoom setting, and select it
422 for( size_t jj = 0; jj < zoomList.size(); ++jj )
423 {
424 double rel_error = std::fabs( zoomList[jj] - zoom ) / zoom;
425
426 if( rel_error < last_approx )
427 {
428 last_approx = rel_error;
429 // zoom IDs in m_zoomSelectBox start with 1 (leaving 0 for auto-zoom choice)
430 new_selection = jj+1;
431 }
432 }
433
434 if( curr_selection != new_selection )
435 m_zoomSelectBox->SetSelection( new_selection );
436}
437
439{
440 DisplayErrorMessage( this, wxT("EDA_DRAW_FRAME::PrintPage() error") );
441}
442
443
444void EDA_DRAW_FRAME::OnSelectGrid( wxCommandEvent& event )
445{
446 wxCHECK_RET( m_gridSelectBox, wxS( "m_gridSelectBox uninitialized" ) );
447
448 int idx = m_gridSelectBox->GetCurrentSelection();
449
450 if( idx == int( m_gridSelectBox->GetCount() ) - 2 )
451 {
452 // wxWidgets will check the separator, which we don't want.
453 // Re-check the current grid.
454 wxUpdateUIEvent dummy;
456 }
457 else if( idx == int( m_gridSelectBox->GetCount() ) - 1 )
458 {
459 // wxWidgets will check the Grid Settings... entry, which we don't want.
460 // Re-check the current grid.
461 wxUpdateUIEvent dummy;
463
464 // Give a time-slice to close the menu before opening the dialog.
465 // (Only matters on some versions of GTK.)
466 wxSafeYield();
467
469 }
470 else
471 {
473 }
474
476 m_canvas->Refresh();
477 // Needed on Windows because clicking on m_gridSelectBox remove the focus from m_canvas
478 // (Windows specific
480}
481
482
484{
485 wxCHECK( config(), true );
486
487 return config()->m_Window.grid.show;
488}
489
490
492{
493 wxCHECK( config(), /* void */ );
494
495 config()->m_Window.grid.show = aVisible;
496
497 // Update the display with the new grid
498 if( GetCanvas() )
499 {
500 // Check to ensure these exist, since this function could be called before
501 // the GAL and View have been created
502 if( GetCanvas()->GetGAL() )
503 GetCanvas()->GetGAL()->SetGridVisibility( aVisible );
504
505 if( GetCanvas()->GetView() )
507
508 GetCanvas()->Refresh();
509 }
510}
511
512
514{
515 wxCHECK( config(), false );
516
518}
519
520
522{
523 wxCHECK( config(), /* void */ );
524
525 config()->m_Window.grid.overrides_enabled = aOverride;
526}
527
528
529std::unique_ptr<GRID_HELPER> EDA_DRAW_FRAME::MakeGridHelper()
530{
531 return nullptr;
532}
533
534
536{
537 if( m_zoomSelectBox == nullptr )
538 return;
539
540 double zoom = m_canvas->GetGAL()->GetZoomFactor();
541
542 m_zoomSelectBox->Clear();
543 m_zoomSelectBox->Append( _( "Zoom Auto" ) );
544 m_zoomSelectBox->SetSelection( 0 );
545
546 wxCHECK( config(), /* void */ );
547
548 for( unsigned i = 0; i < config()->m_Window.zoom_factors.size(); ++i )
549 {
550 double current = config()->m_Window.zoom_factors[i];
551
552 m_zoomSelectBox->Append( wxString::Format( _( "Zoom %.2f" ), current ) );
553
554 if( zoom == current )
555 m_zoomSelectBox->SetSelection( i + 1 );
556 }
557}
558
559
560void EDA_DRAW_FRAME::OnSelectZoom( wxCommandEvent& event )
561{
562 wxCHECK_RET( m_zoomSelectBox, wxS( "m_zoomSelectBox uninitialized" ) );
563
564 int id = m_zoomSelectBox->GetCurrentSelection();
565
566 if( id < 0 || !( id < (int)m_zoomSelectBox->GetCount() ) )
567 return;
568
571 m_canvas->Refresh();
572 // Needed on Windows because clicking on m_zoomSelectBox remove the focus from m_canvas
573 // (Windows specific
575}
576
577
578void EDA_DRAW_FRAME::OnMove( wxMoveEvent& aEvent )
579{
580 // If the window is moved to a different display, the scaling factor may change
581 double oldFactor = m_galDisplayOptions.m_scaleFactor;
583
584 if( oldFactor != m_galDisplayOptions.m_scaleFactor && m_canvas )
585 {
586 wxSize clientSize = GetClientSize();
587 GetCanvas()->GetGAL()->ResizeScreen( clientSize.x, clientSize.y );
589 }
590
591 aEvent.Skip();
592}
593
594
596{
598 CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
599
600 aMenu.AddSeparator( 1000 );
601
602 std::shared_ptr<ZOOM_MENU> zoomMenu = std::make_shared<ZOOM_MENU>( this );
603 zoomMenu->SetTool( commonTools );
604 aToolMenu.RegisterSubMenu( zoomMenu );
605
606 std::shared_ptr<GRID_MENU> gridMenu = std::make_shared<GRID_MENU>( this );
607 gridMenu->SetTool( commonTools );
608 aToolMenu.RegisterSubMenu( gridMenu );
609
610 aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
611 aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
612}
613
614
615void EDA_DRAW_FRAME::DisplayToolMsg( const wxString& msg )
616{
617 SetStatusText( msg, 6 );
618}
619
620
621void EDA_DRAW_FRAME::DisplayConstraintsMsg( const wxString& msg )
622{
623 SetStatusText( msg, 7 );
624}
625
626
628{
629 wxString msg;
630
633
634 msg.Printf( _( "grid %s" ),
635 gridSettings.grids[currentIdx].UserUnitsMessageText( this, false ) );
636
637 SetStatusText( msg, 4 );
638}
639
640
642{
643 wxString msg;
644
645 switch( GetUserUnits() )
646 {
647 case EDA_UNITS::INCHES: msg = _( "inches" ); break;
648 case EDA_UNITS::MILS: msg = _( "mils" ); break;
649 case EDA_UNITS::MILLIMETRES: msg = _( "mm" ); break;
650 default: msg = _( "Units" ); break;
651 }
652
653 SetStatusText( msg, 5 );
654}
655
656
657void EDA_DRAW_FRAME::OnSize( wxSizeEvent& SizeEv )
658{
659 EDA_BASE_FRAME::OnSize( SizeEv );
660
661 m_frameSize = GetClientSize( );
662
663 SizeEv.Skip();
664}
665
666
668{
669 wxWindow* stsbar = GetStatusBar();
670 int spacer = KIUI::GetTextSize( wxT( "M" ), stsbar ).x * 2;
671
672 int dims[] = {
673 // remainder of status bar on far left is set to a default or whatever is left over.
674 -1,
675
676 // When using GetTextSize() remember the width of character '1' is not the same
677 // as the width of '0' unless the font is fixed width, and it usually won't be.
678
679 // zoom:
680 KIUI::GetTextSize( wxT( "Z 762000" ), stsbar ).x,
681
682 // cursor coords
683 KIUI::GetTextSize( wxT( "X 1234.1234 Y 1234.1234" ), stsbar ).x,
684
685 // delta distances
686 KIUI::GetTextSize( wxT( "dx 1234.1234 dy 1234.1234 dist 1234.1234" ), stsbar ).x,
687
688 // grid size
689 KIUI::GetTextSize( wxT( "grid X 1234.1234 Y 1234.1234" ), stsbar ).x,
690
691 // units display, Inches is bigger than mm
692 KIUI::GetTextSize( _( "Inches" ), stsbar ).x,
693
694 // Size for the "Current Tool" panel; longest string from SetTool()
695 KIUI::GetTextSize( wxT( "Add layer alignment target" ), stsbar ).x,
696
697 // constraint mode
698 KIUI::GetTextSize( _( "Constrain to H, V, 45" ), stsbar ).x
699 };
700
701 for( size_t ii = 1; ii < arrayDim( dims ); ii++ )
702 dims[ii] += spacer;
703
704 SetStatusWidths( arrayDim( dims ), dims );
705}
706
707
709{
710 SetStatusText( GetZoomLevelIndicator(), 1 );
711
712 // Absolute and relative cursor positions are handled by overloading this function and
713 // handling the internal to user units conversion at the appropriate level.
714
715 // refresh units display
717}
718
719
721{
722 // returns a human readable value which can be displayed as zoom
723 // level indicator in dialogs.
724 double zoom = m_canvas->GetGAL()->GetZoomFactor();
725 return wxString::Format( wxT( "Z %.2f" ), zoom );
726}
727
728
730{
732
734 WINDOW_SETTINGS* window = GetWindowSettings( aCfg );
735
736 // Read units used in dialogs and toolbars
737 SetUserUnits( static_cast<EDA_UNITS>( aCfg->m_System.units ) );
738
740
741 m_galDisplayOptions.ReadConfig( *cmnCfg, *window, this );
742
743 m_findReplaceData->findString = aCfg->m_FindReplace.find_string;
744 m_findReplaceData->replaceString = aCfg->m_FindReplace.replace_string;
745 m_findReplaceData->matchMode =
746 static_cast<EDA_SEARCH_MATCH_MODE>( aCfg->m_FindReplace.match_mode );
747 m_findReplaceData->matchCase = aCfg->m_FindReplace.match_case;
748 m_findReplaceData->searchAndReplace = aCfg->m_FindReplace.search_and_replace;
749
750 for( const wxString& s : aCfg->m_FindReplace.find_history )
752
753 for( const wxString& s : aCfg->m_FindReplace.replace_history )
755
757}
758
759
761{
763
764 WINDOW_SETTINGS* window = GetWindowSettings( aCfg );
765
766 aCfg->m_System.units = static_cast<int>( GetUserUnits() );
768
770
771 aCfg->m_FindReplace.search_and_replace = m_findReplaceData->searchAndReplace;
772
773 aCfg->m_FindReplace.find_string = m_findReplaceData->findString;
774 aCfg->m_FindReplace.replace_string = m_findReplaceData->replaceString;
775
776 aCfg->m_FindReplace.find_history.clear();
777 aCfg->m_FindReplace.replace_history.clear();
778
779 for( size_t i = 0; i < m_findStringHistoryList.GetCount() && i < FR_HISTORY_LIST_CNT; i++ )
780 {
781 aCfg->m_FindReplace.find_history.push_back( m_findStringHistoryList[ i ].ToStdString() );
782 }
783
784 for( size_t i = 0; i < m_replaceStringHistoryList.GetCount() && i < FR_HISTORY_LIST_CNT; i++ )
785 {
786 aCfg->m_FindReplace.replace_history.push_back(
787 m_replaceStringHistoryList[ i ].ToStdString() );
788 }
789
790 // Save the units used in this frame
791 if( m_toolManager )
792 {
794 {
795 aCfg->m_System.last_imperial_units = static_cast<int>( cmnTool->GetLastImperialUnits() );
796 aCfg->m_System.last_metric_units = static_cast<int>( cmnTool->GetLastMetricUnits() );
797 }
798 }
799}
800
801
802void EDA_DRAW_FRAME::AppendMsgPanel( const wxString& aTextUpper, const wxString& aTextLower,
803 int aPadding )
804{
806 m_messagePanel->AppendMessage( aTextUpper, aTextLower, aPadding );
807}
808
809
811{
814}
815
816
817void EDA_DRAW_FRAME::SetMsgPanel( const std::vector<MSG_PANEL_ITEM>& aList )
818{
820 {
822
823 for( const MSG_PANEL_ITEM& item : aList )
825 }
826}
827
828
829void EDA_DRAW_FRAME::SetMsgPanel( const wxString& aTextUpper, const wxString& aTextLower,
830 int aPadding )
831{
833 {
835 m_messagePanel->AppendMessage( aTextUpper, aTextLower, aPadding );
836 }
837}
838
839
841{
842 wxCHECK_RET( aItem, wxT( "Invalid EDA_ITEM pointer. Bad programmer." ) );
843
844 std::vector<MSG_PANEL_ITEM> items;
845 aItem->GetMsgPanelInfo( this, items );
846 SetMsgPanel( items );
847}
848
849
851{
852}
853
854
856{
857 GetCanvas()->SetEvtHandlerEnabled( true );
859}
860
861
863{
864 GetCanvas()->SwitchBackend( aCanvasType );
866
868}
869
870
872{
873#ifdef __WXMAC__
874 // Cairo renderer doesn't handle Retina displays so there's really only one game
875 // in town for Mac
877#endif
878
880 APP_SETTINGS_BASE* cfg = aCfg ? aCfg : Kiface().KifaceSettings();
881
882 if( cfg )
883 canvasType = static_cast<EDA_DRAW_PANEL_GAL::GAL_TYPE>( cfg->m_Graphics.canvas_type );
884
885 if( canvasType < EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE
886 || canvasType >= EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST )
887 {
888 wxASSERT( false );
890 }
891
892 // Legacy canvas no longer supported. Switch to OpenGL, falls back to Cairo on failure
893 if( canvasType == EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE )
895
896 return canvasType;
897}
898
899
901{
902 // Not all classes derived from EDA_DRAW_FRAME can save the canvas type, because some
903 // have a fixed type, or do not have a option to set the canvas type (they inherit from
904 // a parent frame)
905 static std::vector<FRAME_T> s_allowedFrames =
906 {
911 };
912
913 if( !alg::contains( s_allowedFrames, m_ident ) )
914 return false;
915
916 if( aCanvasType < EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE
917 || aCanvasType >= EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST )
918 {
919 wxASSERT( false );
920 return false;
921 }
922
923 if( APP_SETTINGS_BASE* cfg = Kiface().KifaceSettings() )
924 cfg->m_Graphics.canvas_type = static_cast<int>( aCanvasType );
925
926 return false;
927}
928
929
931{
932 const VECTOR2I& gridOrigin = GetGridOrigin();
933 VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
934
935 double xOffset = fmod( gridOrigin.x, gridSize.x );
936 int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
937 double yOffset = fmod( gridOrigin.y, gridSize.y );
938 int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
939
940 return VECTOR2I( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
941}
942
943
945{
946 const VECTOR2I& gridOrigin = GetGridOrigin();
947 VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize() / 2.0;
948
949 double xOffset = fmod( gridOrigin.x, gridSize.x );
950 int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
951 double yOffset = fmod( gridOrigin.y, gridSize.y );
952 int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
953
954 return VECTOR2I( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
955}
956
957
958const BOX2I EDA_DRAW_FRAME::GetDocumentExtents( bool aIncludeAllVisible ) const
959{
960 return BOX2I();
961}
962
963
965{
966 // To be implemented by subclasses.
967}
968
969
970void EDA_DRAW_FRAME::Zoom_Automatique( bool aWarpPointer )
971{
973}
974
975
976// Find the first child dialog.
977std::vector<wxWindow*> EDA_DRAW_FRAME::findDialogs()
978{
979 std::vector<wxWindow*> dialogs;
980
981 for( wxWindow* window : GetChildren() )
982 {
983 if( dynamic_cast<DIALOG_SHIM*>( window ) )
984 dialogs.push_back( window );
985 }
986
987 return dialogs;
988}
989
990
992{
993 bool centerView = false;
995
996 // Center if we're off the current view, or within 10% of its edge
997 r.Inflate( - (int) r.GetWidth() / 10 );
998
999 if( !r.Contains( aPos ) )
1000 centerView = true;
1001
1002 std::vector<BOX2D> dialogScreenRects;
1003
1004 for( wxWindow* dialog : findDialogs() )
1005 {
1006 dialogScreenRects.emplace_back( ToVECTOR2D( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ) ),
1007 ToVECTOR2D( dialog->GetSize() ) );
1008 }
1009
1010 // Center if we're behind an obscuring dialog, or within 10% of its edge
1011 for( BOX2D rect : dialogScreenRects )
1012 {
1013 rect.Inflate( rect.GetWidth() / 10 );
1014
1015 if( rect.Contains( GetCanvas()->GetView()->ToScreen( aPos ) ) )
1016 centerView = true;
1017 }
1018
1019 if( centerView )
1020 {
1021 try
1022 {
1023 GetCanvas()->GetView()->SetCenter( aPos, dialogScreenRects );
1024 }
1025 catch( const ClipperLib::clipperException& e )
1026 {
1027 wxFAIL_MSG( wxString::Format( wxT( "Clipper exception occurred centering object: %s" ),
1028 e.what() ) );
1029 }
1030 }
1031
1033}
1034
1035
1036static const wxString productName = wxT( "KiCad E.D.A. " );
1037
1038
1039void PrintDrawingSheet( const RENDER_SETTINGS* aSettings, const PAGE_INFO& aPageInfo,
1040 const wxString& aSheetName, const wxString& aSheetPath,
1041 const wxString& aFileName, const TITLE_BLOCK& aTitleBlock,
1042 const std::map<wxString, wxString>* aProperties, int aSheetCount,
1043 const wxString& aPageNumber, double aMils2Iu, const PROJECT* aProject,
1044 const wxString& aSheetLayer, bool aIsFirstPage )
1045{
1046 DS_DRAW_ITEM_LIST drawList( unityScale );
1047
1048 drawList.SetDefaultPenSize( aSettings->GetDefaultPenWidth() );
1049 drawList.SetPlotterMilsToIUfactor( aMils2Iu );
1050 drawList.SetPageNumber( aPageNumber );
1051 drawList.SetSheetCount( aSheetCount );
1052 drawList.SetFileName( aFileName );
1053 drawList.SetSheetName( aSheetName );
1054 drawList.SetSheetPath( aSheetPath );
1055 drawList.SetSheetLayer( aSheetLayer );
1056 drawList.SetProject( aProject );
1057 drawList.SetIsFirstPage( aIsFirstPage );
1058 drawList.SetProperties( aProperties );
1059
1060 drawList.BuildDrawItemsList( aPageInfo, aTitleBlock );
1061
1062 // Draw item list
1063 drawList.Print( aSettings );
1064}
1065
1066
1068 const std::map<wxString, wxString>* aProperties,
1069 double aMils2Iu, const wxString &aFilename,
1070 const wxString &aSheetLayer )
1071{
1073 return;
1074
1075 wxDC* DC = aSettings->GetPrintDC();
1076 wxPoint origin = DC->GetDeviceOrigin();
1077
1078 if( origin.y > 0 )
1079 {
1080 DC->SetDeviceOrigin( 0, 0 );
1081 DC->SetAxisOrientation( true, false );
1082 }
1083
1085 aFilename, GetTitleBlock(), aProperties, aScreen->GetPageCount(),
1086 aScreen->GetPageNumber(), aMils2Iu, &Prj(), aSheetLayer,
1087 aScreen->GetVirtualPageNumber() == 1 );
1088
1089 if( origin.y > 0 )
1090 {
1091 DC->SetDeviceOrigin( origin.x, origin.y );
1092 DC->SetAxisOrientation( true, true );
1093 }
1094}
1095
1096
1098{
1099 // Virtual function. Base class implementation returns an empty string.
1100 return wxEmptyString;
1101}
1102
1103
1105{
1106 // Virtual function. Base class implementation returns an empty string.
1107 return wxEmptyString;
1108}
1109
1110
1111bool EDA_DRAW_FRAME::LibraryFileBrowser( bool doOpen, wxFileName& aFilename,
1112 const wxString& wildcard, const wxString& ext,
1113 bool isDirectory, bool aIsGlobal,
1114 const wxString& aGlobalPath )
1115{
1116 wxString prompt = doOpen ? _( "Select Library" ) : _( "New Library" );
1117 aFilename.SetExt( ext );
1118
1119 wxString projectDir = Prj().IsNullProject() ? aFilename.GetPath() : Prj().GetProjectPath();
1120 wxString defaultDir;
1121
1122 if( aIsGlobal )
1123 {
1124 if( !GetMruPath().IsEmpty() && !GetMruPath().StartsWith( projectDir ) )
1125 defaultDir = GetMruPath();
1126 else
1127 defaultDir = aGlobalPath;
1128 }
1129 else
1130 {
1131 if( !GetMruPath().IsEmpty() && GetMruPath().StartsWith( projectDir ) )
1132 defaultDir = GetMruPath();
1133 else
1134 defaultDir = projectDir;
1135 }
1136
1137 if( isDirectory && doOpen )
1138 {
1139 wxDirDialog dlg( this, prompt, defaultDir, wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );
1140
1141 if( dlg.ShowModal() == wxID_CANCEL )
1142 return false;
1143
1144 aFilename = dlg.GetPath();
1145 aFilename.SetExt( ext );
1146 }
1147 else
1148 {
1149 // Ensure the file has a dummy name, otherwise GTK will display the regex from the filter
1150 if( aFilename.GetName().empty() )
1151 aFilename.SetName( wxS( "Library" ) );
1152
1153 wxFileDialog dlg( this, prompt, defaultDir, aFilename.GetFullName(),
1154 wildcard, doOpen ? wxFD_OPEN | wxFD_FILE_MUST_EXIST
1155 : wxFD_SAVE | wxFD_CHANGE_DIR | wxFD_OVERWRITE_PROMPT );
1156
1157 if( dlg.ShowModal() == wxID_CANCEL )
1158 return false;
1159
1160 aFilename = dlg.GetPath();
1161 aFilename.SetExt( ext );
1162 }
1163
1164 SetMruPath( aFilename.GetPath() );
1165
1166 return true;
1167}
1168
1169
1171{
1172 // Rebuild all toolbars, and update the checked state of check tools
1173 if( m_mainToolBar )
1175
1176 if( m_drawToolBar ) // Drawing tools (typically on right edge of window)
1178
1179 if( m_optionsToolBar ) // Options (typically on left edge of window)
1181
1182 if( m_auxiliaryToolBar ) // Additional tools under main toolbar
1184
1185
1186}
1187
1188
1190{
1191 if( m_mainToolBar )
1192 m_auimgr.GetPane( m_mainToolBar ).MaxSize( m_mainToolBar->GetSize() );
1193
1194 if( m_drawToolBar )
1195 m_auimgr.GetPane( m_drawToolBar ).MaxSize( m_drawToolBar->GetSize() );
1196
1197 if( m_optionsToolBar )
1198 m_auimgr.GetPane( m_optionsToolBar ).MaxSize( m_optionsToolBar->GetSize() );
1199
1200 if( m_auxiliaryToolBar )
1201 m_auimgr.GetPane( m_auxiliaryToolBar ).MaxSize( m_auxiliaryToolBar->GetSize() );
1202
1203 m_auimgr.Update();
1204}
1205
1206
1208{
1210
1211 if( m_searchPane )
1212 {
1213 wxAuiPaneInfo& search_pane_info = m_auimgr.GetPane( m_searchPane );
1214 search_pane_info.Caption( _( "Search" ) );
1215 }
1216
1217 if( m_propertiesPanel )
1218 {
1219 wxAuiPaneInfo& properties_pane_info = m_auimgr.GetPane( m_propertiesPanel );
1220 properties_pane_info.Caption( _( "Properties" ) );
1221 }
1222
1224 {
1225 wxAuiPaneInfo& net_inspector_panel_info = m_auimgr.GetPane( m_netInspectorPanel );
1226 net_inspector_panel_info.Caption( _( "Net Inspector" ) );
1227 }
1228}
1229
1230
1232{
1233 if( !m_propertiesPanel || !m_propertiesPanel->IsShownOnScreen() )
1234 return;
1235
1237}
1238
1239
1241{
1242 m_hotkeyPopup = new HOTKEY_CYCLE_POPUP( this );
1243}
1244
1245
1247{
1248 if( !m_colorSettings || aForceRefresh )
1249 {
1251
1252 const_cast<EDA_DRAW_FRAME*>( this )->m_colorSettings = colorSettings;
1253 }
1254
1255 return m_colorSettings;
1256}
1257
1258
1260{
1262
1263 if( cmnTool )
1264 {
1265 // Tell the tool what the units used last session
1266 cmnTool->SetLastUnits( static_cast<EDA_UNITS>( aCfg->m_System.last_imperial_units ) );
1267 cmnTool->SetLastUnits( static_cast<EDA_UNITS>( aCfg->m_System.last_metric_units ) );
1268 }
1269
1270 // Tell the tool what units the frame is currently using
1271 switch( static_cast<EDA_UNITS>( aCfg->m_System.units ) )
1272 {
1273 default:
1274 case EDA_UNITS::MILLIMETRES: m_toolManager->RunAction( ACTIONS::millimetersUnits ); break;
1275 case EDA_UNITS::INCHES: m_toolManager->RunAction( ACTIONS::inchesUnits ); break;
1276 case EDA_UNITS::MILS: m_toolManager->RunAction( ACTIONS::milsUnits ); break;
1277 }
1278}
1279
1280
1281void EDA_DRAW_FRAME::GetUnitPair( EDA_UNITS& aPrimaryUnit, EDA_UNITS& aSecondaryUnits )
1282{
1284
1285 aPrimaryUnit = GetUserUnits();
1286 aSecondaryUnits = EDA_UNITS::MILS;
1287
1288 if( EDA_UNIT_UTILS::IsImperialUnit( aPrimaryUnit ) )
1289 {
1290 if( cmnTool )
1291 aSecondaryUnits = cmnTool->GetLastMetricUnits();
1292 else
1293 aSecondaryUnits = EDA_UNITS::MILLIMETRES;
1294 }
1295 else
1296 {
1297 if( cmnTool )
1298 aSecondaryUnits = cmnTool->GetLastImperialUnits();
1299 else
1300 aSecondaryUnits = EDA_UNITS::MILS;
1301 }
1302}
1303
1304
1306{
1308
1309 // If we had an OpenGL failure this session, use the fallback GAL but don't update the
1310 // user preference silently:
1311
1314}
1315
1316
1317void EDA_DRAW_FRAME::handleActivateEvent( wxActivateEvent& aEvent )
1318{
1319 // Force a refresh of the message panel to ensure that the text is the right color
1320 // when the window activates
1321 if( !IsIconized() )
1322 m_messagePanel->Refresh();
1323}
1324
1325
1326void EDA_DRAW_FRAME::onActivate( wxActivateEvent& aEvent )
1327{
1328 handleActivateEvent( aEvent );
1329
1330 aEvent.Skip();
1331}
1332
1333
1334bool EDA_DRAW_FRAME::SaveCanvasImageToFile( const wxString& aFileName,
1335 BITMAP_TYPE aBitmapType )
1336{
1337 bool retv = true;
1338
1339 // Make a screen copy of the canvas:
1340 wxSize image_size = GetCanvas()->GetClientSize();
1341
1342 wxClientDC dc( GetCanvas() );
1343 wxBitmap bitmap( image_size.x, image_size.y );
1344 wxMemoryDC memdc;
1345
1346 memdc.SelectObject( bitmap );
1347 memdc.Blit( 0, 0, image_size.x, image_size.y, &dc, 0, 0 );
1348 memdc.SelectObject( wxNullBitmap );
1349
1350 wxImage image = bitmap.ConvertToImage();
1351
1352 wxBitmapType type = wxBITMAP_TYPE_PNG;
1353 switch( aBitmapType )
1354 {
1355 case BITMAP_TYPE::PNG: type = wxBITMAP_TYPE_PNG; break;
1356 case BITMAP_TYPE::BMP: type = wxBITMAP_TYPE_BMP; break;
1357 case BITMAP_TYPE::JPG: type = wxBITMAP_TYPE_JPEG; break;
1358 }
1359
1360 if( !image.SaveFile( aFileName, type ) )
1361 retv = false;
1362
1363 image.Destroy();
1364 return retv;
1365}
1366
1367
1369{
1370#ifdef KICAD_IPC_API
1371 // TODO: Add user control over visibility and order
1372 API_PLUGIN_MANAGER& mgr = Pgm().GetPluginManager();
1373
1374 mgr.ButtonBindings().clear();
1375
1376 std::vector<const PLUGIN_ACTION*> actions = mgr.GetActionsForScope( PluginActionScope() );
1377
1378 for( auto& action : actions )
1379 {
1380 if( !action->show_button )
1381 continue;
1382
1383 const wxBitmapBundle& icon = KIPLATFORM::UI::IsDarkTheme() && action->icon_dark.IsOk()
1384 ? action->icon_dark
1385 : action->icon_light;
1386
1387 wxAuiToolBarItem* button = m_mainToolBar->AddTool( wxID_ANY, wxEmptyString, icon,
1388 action->name );
1389
1390 Connect( button->GetId(), wxEVT_COMMAND_MENU_SELECTED,
1391 wxCommandEventHandler( EDA_DRAW_FRAME::OnApiPluginInvoke ) );
1392
1393 mgr.ButtonBindings().insert( { button->GetId(), action->identifier } );
1394 }
1395#endif
1396}
1397
1398
1399void EDA_DRAW_FRAME::OnApiPluginInvoke( wxCommandEvent& aEvent )
1400{
1401#ifdef KICAD_IPC_API
1402 API_PLUGIN_MANAGER& mgr = Pgm().GetPluginManager();
1403
1404 if( mgr.ButtonBindings().count( aEvent.GetId() ) )
1405 mgr.InvokeAction( mgr.ButtonBindings().at( aEvent.GetId() ) );
1406#endif
1407}
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
Definition: arraydim.h:31
BASE_SCREEN class implementation.
constexpr EDA_IU_SCALE unityScale
Definition: base_units.h:111
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
BITMAP_TYPE
Definition: bitmap_types.h:43
BOX2< VECTOR2I > BOX2I
Definition: box2.h:922
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition: box2.h:990
static TOOL_ACTION gridProperties
Definition: actions.h:189
static TOOL_ACTION millimetersUnits
Definition: actions.h:195
static TOOL_ACTION updatePreferences
Definition: actions.h:223
static TOOL_ACTION gridPreset
Definition: actions.h:186
static TOOL_ACTION updateUnits
Definition: actions.h:196
static TOOL_ACTION milsUnits
Definition: actions.h:194
static TOOL_ACTION inchesUnits
Definition: actions.h:193
static TOOL_ACTION zoomFitScreen
Definition: actions.h:134
static TOOL_ACTION zoomPreset
Definition: actions.h:137
Responsible for loading plugin definitions for API-based plugins (ones that do not run inside KiCad i...
std::map< int, wxString > & ButtonBindings()
std::vector< const PLUGIN_ACTION * > GetActionsForScope(PLUGIN_ACTION_SCOPE aScope)
void InvokeAction(const wxString &aIdentifier)
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
WINDOW_SETTINGS m_Window
Definition: app_settings.h:186
FIND_REPLACE m_FindReplace
Definition: app_settings.h:172
Handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:41
int GetPageCount() const
Definition: base_screen.h:72
int GetVirtualPageNumber() const
Definition: base_screen.h:75
const wxString & GetPageNumber() const
Definition: base_screen.cpp:70
constexpr BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:558
constexpr size_type GetWidth() const
Definition: box2.h:214
constexpr bool Contains(const Vec &aPoint) const
Definition: box2.h:168
Color settings are a bit different than most of the settings objects in that there can be more than o...
APPEARANCE m_Appearance
Handles action that are shared between different applications.
Definition: common_tools.h:38
void SetLastUnits(EDA_UNITS aUnit)
EDA_UNITS GetLastImperialUnits()
Definition: common_tools.h:79
EDA_UNITS GetLastMetricUnits()
Definition: common_tools.h:78
void AddSeparator(int aOrder=ANY_ORDER)
Add a separator to the menu.
Dialog helper object to sit in the inheritance tree between wxDialog and any class written by wxFormB...
Definition: dialog_shim.h:88
Store the list of graphic items: rect, lines, polygons and texts to draw/plot the title block and fra...
Definition: ds_draw_item.h:401
void SetPlotterMilsToIUfactor(double aMils2Iu)
Set the scalar to convert pages units (mils) to plot units.
Definition: ds_draw_item.h:467
void BuildDrawItemsList(const PAGE_INFO &aPageInfo, const TITLE_BLOCK &aTitleBlock)
Drawing or plot the drawing sheet.
void SetSheetPath(const wxString &aSheetPath)
Set the sheet path to draw/plot.
Definition: ds_draw_item.h:454
void SetFileName(const wxString &aFileName)
Set the filename to draw/plot.
Definition: ds_draw_item.h:444
void SetDefaultPenSize(int aPenSize)
Definition: ds_draw_item.h:461
void Print(const RENDER_SETTINGS *aSettings)
Draws the item list created by BuildDrawItemsList.
void SetSheetName(const wxString &aSheetName)
Set the sheet name to draw/plot.
Definition: ds_draw_item.h:449
void SetIsFirstPage(bool aIsFirstPage)
Set if the page is the first page.
Definition: ds_draw_item.h:493
void SetProperties(const std::map< wxString, wxString > *aProps)
Set properties used for text variable resolution.
Definition: ds_draw_item.h:434
void SetSheetLayer(const wxString &aSheetLayer)
Set the sheet layer to draw/plot.
Definition: ds_draw_item.h:459
void SetSheetCount(int aSheetCount)
Set the value of the count of sheets, for basic inscriptions.
Definition: ds_draw_item.h:498
void SetPageNumber(const wxString &aPageNumber)
Set the value of the sheet number.
Definition: ds_draw_item.h:488
void SetProject(const PROJECT *aProject)
Definition: ds_draw_item.h:424
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
virtual WINDOW_SETTINGS * GetWindowSettings(APP_SETTINGS_BASE *aCfg)
Return a pointer to the window settings for this frame.
void ShowChangedLanguage() override
Redraw the menus and what not in current language.
wxTimer * m_autoSaveTimer
wxAuiManager m_auimgr
int GetMaxUndoItems() const
virtual void LoadSettings(APP_SETTINGS_BASE *aCfg)
Load common frame parameters from a configuration file.
wxString GetMruPath() const
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
virtual void OnSize(wxSizeEvent &aEvent)
int GetAutoSaveInterval() const
virtual void SaveSettings(APP_SETTINGS_BASE *aCfg)
Save common frame parameters to a configuration data file.
void SetMruPath(const wxString &aPath)
bool m_isClosing
Set by NonUserClose() to indicate that the user did not request the current close.
The base class for create windows for drawing purpose.
virtual const BOX2I GetDocumentExtents(bool aIncludeAllVisible=true) const
Returns bbox of document with option to not include some items.
wxArrayString m_replaceStringHistoryList
virtual void ClearMsgPanel()
Clear all messages from the message panel.
virtual void ReCreateVToolbar()
EDA_DRAW_PANEL_GAL * m_canvas
This the frame's interface to setting GAL display options.
virtual void ActivateGalCanvas()
Use to start up the GAL drawing canvas.
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
GAL_DISPLAY_OPTIONS_IMPL m_galDisplayOptions
virtual const TITLE_BLOCK & GetTitleBlock() const =0
virtual void PrintPage(const RENDER_SETTINGS *aSettings)
Print the page pointed by current screen, set by the calling print function.
void onActivate(wxActivateEvent &aEvent)
COLOR_SETTINGS * m_colorSettings
wxChoice * m_gridSelectBox
void AddStandardSubMenus(TOOL_MENU &aMenu)
Construct a "basic" menu for a tool, containing only items that apply to all tools (e....
void ReleaseFile()
Release the current file marked in use.
void OnToolbarSizeChanged()
Update toolbars if desired toolbar icon changed.
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
void ScriptingConsoleEnableDisable()
Toggles the scripting console visibility.
virtual wxString GetFullScreenDesc() const
void OnSelectGrid(wxCommandEvent &event)
Command event handler for selecting grid sizes.
void DisplayToolMsg(const wxString &msg) override
std::unique_ptr< LOCKFILE > m_file_checker
bool IsScriptingConsoleVisible()
Gets the current visibility of the scripting console window.
void OnUpdateSelectZoom(wxUpdateUIEvent &aEvent)
Update the checked item in the zoom wxchoice.
virtual const PAGE_INFO & GetPageSettings() const =0
void DisplayUnitsMsg()
Display current unit pane in the status bar.
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.
ACTION_TOOLBAR * m_optionsToolBar
void UpdateGridSelectBox()
Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes,...
bool LockFile(const wxString &aFileName)
Mark a schematic file as being in use.
virtual void HardRedraw()
Rebuild the GAL and redraws the screen.
bool LibraryFileBrowser(bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false, bool aIsGlobal=false, const wxString &aGlobalPath=wxEmptyString)
bool IsGridOverridden() const
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
bool SaveCanvasImageToFile(const wxString &aFileName, BITMAP_TYPE aBitmapType)
Save the current view as an image file.
void UpdateZoomSelectBox()
Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes,...
virtual void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Changes the current rendering backend.
virtual void OnSize(wxSizeEvent &event) override
Recalculate the size of toolbars and display panel when the frame size changes.
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting(APP_SETTINGS_BASE *aCfg=nullptr)
Returns the canvas type stored in the application settings.
const wxString GetZoomLevelIndicator() const
Return a human readable value for display in dialogs.
virtual void OnSelectZoom(wxCommandEvent &event)
Set the zoom factor when selected by the zoom list box in the main tool bar.
virtual void resolveCanvasType()
Determines the Canvas type to load (with prompt if required) and initializes m_canvasType.
static bool m_openGLFailureOccured
Has any failure occured when switching to OpenGL in any EDA_DRAW_FRAME?
BASE_SCREEN * m_currentScreen
current used SCREEN
virtual wxString GetScreenDesc() const
VECTOR2I GetNearestGridPosition(const VECTOR2I &aPosition) const
Return the nearest aGridSize location to aPosition.
EDA_MSG_PANEL * m_messagePanel
virtual const VECTOR2I & GetGridOrigin() const =0
Return the absolute coordinates of the origin of the snap grid.
virtual void ReCreateAuxiliaryToolbar()
void FocusOnLocation(const VECTOR2I &aPos)
Useful to focus on a particular location, in find functions.
virtual void ReCreateHToolbar()
void RecreateToolbars()
Rebuild all toolbars, and update the checked state of check tools.
bool saveCanvasTypeSetting(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Stores the canvas type in the application settings.
ACTION_TOOLBAR * m_mainToolBar
virtual void Zoom_Automatique(bool aWarpPointer)
Redraw the screen with best zoom level and the best centering that shows all the page or the board.
NET_INSPECTOR_PANEL * m_netInspectorPanel
virtual void SetGridVisibility(bool aVisible)
virtual void handleActivateEvent(wxActivateEvent &aEvent)
Handle a window activation event.
virtual void ReCreateOptToolbar()
virtual void OnApiPluginInvoke(wxCommandEvent &aEvent)
Handler for activating an API plugin (via toolbar or menu)
virtual void UpdateMsgPanel()
Redraw the message panel.
virtual COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const
Returns a pointer to the active color theme settings.
void ToggleUserUnits() override
virtual void CreateHotkeyPopup()
void UpdateStatusBar() override
Update the status bar information.
void GetUnitPair(EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits) override
Get the pair or units in current use.
void ShowChangedLanguage() override
Redraw the menus and what not in current language.
void updateStatusBarWidths()
void PrintDrawingSheet(const RENDER_SETTINGS *aSettings, BASE_SCREEN *aScreen, const std::map< wxString, wxString > *aProperties, double aMils2Iu, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString)
Prints the drawing-sheet (frame and title block).
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
ACTION_TOOLBAR * m_drawToolBar
SEARCH_PANE * m_searchPane
void unitsChangeRefresh() override
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void OnMove(wxMoveEvent &aEvent) override
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
bool IsGridVisible() const
std::vector< wxWindow * > findDialogs()
virtual void DisplayGridMsg()
Display current grid size in the status bar.
wxArrayString m_findStringHistoryList
wxChoice * m_zoomSelectBox
virtual std::unique_ptr< GRID_HELPER > MakeGridHelper()
virtual PLUGIN_ACTION_SCOPE PluginActionScope() const
std::unique_ptr< EDA_SEARCH_DATA > m_findReplaceData
void DisplayConstraintsMsg(const wxString &msg)
void AppendMsgPanel(const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
Append a message to the message panel.
virtual void SetGridOverrides(bool aOverride)
PROPERTIES_PANEL * m_propertiesPanel
virtual void addApiPluginTools()
Append actions from API plugins to the main toolbar.
bool m_showBorderAndTitleBlock
VECTOR2I GetNearestHalfGridPosition(const VECTOR2I &aPosition) const
Return the nearest aGridSize / 2 location to aPosition.
HOTKEY_CYCLE_POPUP * m_hotkeyPopup
The current canvas type.
void OnUpdateSelectGrid(wxUpdateUIEvent &aEvent)
Update the checked item in the grid wxchoice.
ACTION_TOOLBAR * m_auxiliaryToolBar
static constexpr GAL_TYPE GAL_FALLBACK
GAL_TYPE GetBackend() const
Return the type of backend currently used by GAL canvas.
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
@ GAL_TYPE_LAST
Sentinel, do not use as a parameter.
@ GAL_TYPE_OPENGL
OpenGL implementation.
@ GAL_TYPE_NONE
GAL not used (the legacy wxDC engine is used)
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
void SetFocus() override
virtual bool SwitchBackend(GAL_TYPE aGalType)
Switch method of rendering graphics.
void StartDrawing()
Begin drawing if it was stopped previously.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:89
virtual void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
Definition: eda_item.h:203
A panel to display various information messages.
Definition: msgpanel.h:101
void AppendMessage(const wxString &aUpperText, const wxString &aLowerText, int aPadding=6)
Append a message to the message panel.
Definition: msgpanel.cpp:111
void EraseMsgBox()
Definition: msgpanel.cpp:215
void ReadConfig(COMMON_SETTINGS &aCommonConfig, WINDOW_SETTINGS &aWindowConfig, wxWindow *aWindow)
Read application and common configs.
void ReadCommonConfig(COMMON_SETTINGS &aCommonSettings, wxWindow *aWindow)
Read GAL config options from the common config store.
void WriteConfig(WINDOW_SETTINGS &aCfg)
static void BuildChoiceList(wxArrayString *aGridsList, APP_SETTINGS_BASE *aCfg, EDA_DRAW_FRAME *aParent)
Definition: grid_menu.cpp:83
Similar to EDA_VIEW_SWITCHER, this dialog is a popup that shows feedback when using a hotkey to cycle...
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:95
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
virtual void ResizeScreen(int aWidth, int aHeight)
Resize the canvas.
double GetZoomFactor() const
const VECTOR2D & GetGridSize() const
Return the grid size.
void SetGridVisibility(bool aVisibility)
Set the visibility setting of the grid.
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
int GetDefaultPenWidth() const
wxDC * GetPrintDC() const
An interface for classes handling user events controlling the view behavior such as zooming,...
virtual void LoadSettings()
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Move the graphic crosshair cursor to the requested position expressed in world coordinates.
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
Definition: view.cpp:547
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:649
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:613
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:625
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:55
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
Definition: kiway_player.h:65
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:284
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:406
EDA_MSG_PANEL items for displaying messages.
Definition: msgpanel.h:54
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:59
virtual COMMON_SETTINGS * GetCommonSettings() const
Definition: pgm_base.cpp:679
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:142
Container for project specific data.
Definition: project.h:64
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:135
virtual bool IsNullProject() const
Check if this project is a null project (i.e.
Definition: project.cpp:153
virtual void UpdateData()=0
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieves a color settings object that applications can read colors from.
Hold the information shown in the lower right corner of a plot, printout, or editing view.
Definition: title_block.h:41
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:167
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:169
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
ACTIONS * m_actions
Definition: tools_holder.h:168
Generic, UI-independent tool event.
Definition: tool_event.h:167
bool RunAction(const std::string &aActionName, T aParam)
Run the specified action immediately, pausing the current action to run the new one.
Definition: tool_manager.h:150
APP_SETTINGS_BASE * GetSettings() const
Definition: tool_manager.h:400
Manage a CONDITIONAL_MENU and some number of CONTEXT_MENUs as sub-menus.
Definition: tool_menu.h:43
CONDITIONAL_MENU & GetMenu()
Definition: tool_menu.cpp:44
void RegisterSubMenu(std::shared_ptr< ACTION_MENU > aSubMenu)
Store a submenu of this menu model.
Definition: tool_menu.cpp:50
EDA_UNITS GetUserUnits() const
void SetUserUnits(EDA_UNITS aUnits)
@ LIGHTGRAY
Definition: color4d.h:47
@ DARKGRAY
Definition: color4d.h:46
@ BLACK
Definition: color4d.h:44
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:195
This file is part of the common library.
#define _(s)
#define DEFAULT_MAX_UNDO_ITEMS
#define FR_HISTORY_LIST_CNT
Maximum size of the find/replace history stacks.
void PrintDrawingSheet(const RENDER_SETTINGS *aSettings, const PAGE_INFO &aPageInfo, const wxString &aSheetName, const wxString &aSheetPath, const wxString &aFileName, const TITLE_BLOCK &aTitleBlock, const std::map< wxString, wxString > *aProperties, int aSheetCount, const wxString &aPageNumber, double aMils2Iu, const PROJECT *aProject, const wxString &aSheetLayer, bool aIsFirstPage)
Print the border and title block.
static const wxString productName
EDA_SEARCH_MATCH_MODE
EDA_UNITS
Definition: eda_units.h:46
GERBVIEW_FRAME::OnZipFileHistory GERBVIEW_FRAME::OnSelectHighlightChoice EVT_UPDATE_UI(ID_TOOLBARH_GERBVIEW_SELECT_ACTIVE_LAYER, GERBVIEW_FRAME::OnUpdateLayerSelectBox) void GERBVIEW_FRAME
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:33
@ FRAME_PCB_EDITOR
Definition: frame_type.h:42
@ FRAME_SCH_SYMBOL_EDITOR
Definition: frame_type.h:35
@ FRAME_SCH
Definition: frame_type.h:34
@ FRAME_PL_EDITOR
Definition: frame_type.h:59
@ FRAME_FOOTPRINT_EDITOR
Definition: frame_type.h:43
@ FRAME_GERBER
Definition: frame_type.h:57
@ FRAME_PYTHON
Definition: frame_type.h:55
@ ID_ON_GRID_SELECT
Definition: id.h:145
@ ID_ON_ZOOM_SELECT
Definition: id.h:143
File locking utilities.
This file contains miscellaneous commonly used macros and functions.
Message panel definition file.
KICOMMON_API bool IsImperialUnit(EDA_UNITS aUnit)
Definition: eda_units.cpp:47
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
Definition: definitions.h:49
bool IsDarkTheme()
Determine if the desktop interface is currently using a dark theme or a light theme.
Definition: wxgtk/ui.cpp:48
KICOMMON_API wxFont GetStatusFont(wxWindow *aWindow)
Definition: ui_common.cpp:130
KICOMMON_API wxSize GetTextSize(const wxString &aSingleLine, wxWindow *aWindow)
Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currentl...
Definition: ui_common.cpp:77
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:100
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: pgm_base.cpp:1060
see class PGM_BASE
std::vector< FAB_LAYER_COLOR > dummy
std::vector< wxString > replace_history
Definition: app_settings.h:99
std::vector< wxString > find_history
Definition: app_settings.h:97
bool overrides_enabled
Definition: grid_settings.h:78
std::vector< GRID > grids
Definition: grid_settings.h:66
Stores the common settings that are saved and loaded for each window / frame.
Definition: app_settings.h:74
GRID_SETTINGS grid
Definition: app_settings.h:81
std::vector< double > zoom_factors
Definition: app_settings.h:78
wxLogTrace helper definitions.
Functions to provide common constants and other functions to assist in making a consistent UI.
VECTOR2< int32_t > VECTOR2I
Definition: vector2d.h:691
VECTOR2D ToVECTOR2D(const wxPoint &aPoint)
Definition: vector2wx.h:40