KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_base_frame.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
5 * Copyright (C) 2015-2023 KiCad Developers, see change_log.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#include <advanced_config.h>
26#include <base_units.h>
27#include <kiway.h>
29#include <pgm_base.h>
30#include <eda_list_dialog.h>
31#include <eeschema_settings.h>
35#include <sch_draw_panel.h>
36#include <sch_view.h>
37#include <sch_painter.h>
39#include <confirm.h>
41#include <project_sch.h>
42#include <symbol_library.h>
43#include <sch_base_frame.h>
44#include <symbol_lib_table.h>
45#include <tool/action_toolbar.h>
46#include <tool/tool_manager.h>
48#include <tools/ee_actions.h>
50#include <wx/choicdlg.h>
51#include <wx/log.h>
52
54
56 SYMBOL_LIB* aCacheLib, wxWindow* aParent, bool aShowErrorMsg )
57{
58 wxCHECK_MSG( aLibTable, nullptr, wxS( "Invalid symbol library table." ) );
59
60 LIB_SYMBOL* symbol = nullptr;
61
62 try
63 {
64 symbol = aLibTable->LoadSymbol( aLibId );
65
66 if( !symbol && aCacheLib )
67 {
68 wxCHECK_MSG( aCacheLib->IsCache(), nullptr, wxS( "Invalid cache library." ) );
69
70 wxString cacheName = aLibId.GetLibNickname().wx_str();
71 cacheName << "_" << aLibId.GetLibItemName();
72 symbol = aCacheLib->FindSymbol( cacheName );
73 }
74 }
75 catch( const IO_ERROR& ioe )
76 {
77 if( aShowErrorMsg )
78 {
79 wxString msg = wxString::Format( _( "Error loading symbol %s from library '%s'." ),
80 aLibId.GetLibItemName().wx_str(),
81 aLibId.GetLibNickname().wx_str() );
82 DisplayErrorMessage( aParent, msg, ioe.What() );
83 }
84 }
85
86 return symbol;
87}
88
89
90SCH_BASE_FRAME::SCH_BASE_FRAME( KIWAY* aKiway, wxWindow* aParent, FRAME_T aWindowType,
91 const wxString& aTitle, const wxPoint& aPosition,
92 const wxSize& aSize, long aStyle, const wxString& aFrameName ) :
93 EDA_DRAW_FRAME( aKiway, aParent, aWindowType, aTitle, aPosition, aSize, aStyle,
94 aFrameName, schIUScale ),
95 m_base_frame_defaults( nullptr, "base_Frame_defaults" ),
96 m_selectionFilterPanel( nullptr ),
97 m_spaceMouse( nullptr )
98{
99 if( ( aStyle & wxFRAME_NO_TASKBAR ) == 0 )
100 createCanvas();
101
102 Bind( wxEVT_IDLE,
103 [this]( wxIdleEvent& aEvent )
104 {
105 // Handle cursor adjustments. While we can get motion and key events through
106 // wxWidgets, we can't get modifier-key-up events.
107 if( m_toolManager )
108 {
110
111 if( selTool )
112 selTool->OnIdle( aEvent );
113 }
114 } );
115
117}
118
119
121{
122 delete m_spaceMouse;
123}
124
125
127{
129}
130
131
133{
134 return dynamic_cast<EESCHEMA_SETTINGS*>( config() );
135}
136
137
139{
140 return dynamic_cast<SYMBOL_EDITOR_SETTINGS*>( config() );
141}
142
143
144void SCH_BASE_FRAME::SetPageSettings( const PAGE_INFO& aPageSettings )
145{
146 GetScreen()->SetPageSettings( aPageSettings );
147}
148
149
151{
152 return GetScreen()->GetPageSettings();
153}
154
155
157{
158 // GetSizeIU is compile time dependent:
160}
161
162
164{
165 wxASSERT( GetScreen() );
166 return GetScreen()->GetTitleBlock();
167}
168
169
171{
172 wxASSERT( GetScreen() );
173 GetScreen()->SetTitleBlock( aTitleBlock );
174}
175
176
178{
179 wxString line;
180 BASE_SCREEN* screen = GetScreen();
181
182 if( !screen )
183 return;
184
186
187 // Display absolute and relative coordinates
189 VECTOR2D d = cursorPos - screen->m_LocalOrigin;
190
191 line.Printf( wxS( "X %s Y %s" ),
192 MessageTextFromValue( cursorPos.x, false ),
193 MessageTextFromValue( cursorPos.y, false ) );
194 SetStatusText( line, 2 );
195
196 line.Printf( wxS( "dx %s dy %s dist %s" ),
197 MessageTextFromValue( d.x, false ),
198 MessageTextFromValue( d.y, false ),
199 MessageTextFromValue( hypot( d.x, d.y ), false ) );
200 SetStatusText( line, 3 );
201
204}
205
206
207LIB_SYMBOL* SCH_BASE_FRAME::GetLibSymbol( const LIB_ID& aLibId, bool aUseCacheLib,
208 bool aShowErrorMsg )
209{
210 SYMBOL_LIB* cache =
211 ( aUseCacheLib ) ? PROJECT_SCH::SchLibs( &Prj() )->GetCacheLibrary() : nullptr;
212
213 return SchGetLibSymbol( aLibId, PROJECT_SCH::SchSymbolLibTable( &Prj() ), cache, this,
214 aShowErrorMsg );
215}
216
217
218bool SCH_BASE_FRAME::saveSymbolLibTables( bool aGlobal, bool aProject )
219{
220 wxString msg;
221 bool success = true;
222
223 if( aGlobal )
224 {
225 try
226 {
228 }
229 catch( const IO_ERROR& ioe )
230 {
231 success = false;
232 msg.Printf( _( "Error saving global symbol library table:\n%s" ), ioe.What() );
233 DisplayErrorMessage( this, msg );
234 }
235 }
236
237 if( aProject && !Prj().GetProjectName().IsEmpty() )
238 {
239 wxFileName fn( Prj().GetProjectPath(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName() );
240
241 try
242 {
243 PROJECT_SCH::SchSymbolLibTable( &Prj() )->Save( fn.GetFullPath() );
244 }
245 catch( const IO_ERROR& ioe )
246 {
247 success = false;
248 msg.Printf( _( "Error saving project-specific symbol library table:\n%s" ),
249 ioe.What() );
250 DisplayErrorMessage( this, msg );
251 }
252 }
253
254 return success;
255}
256
257
259{
260 // If no project is loaded, always work with the global table
261 if( Prj().IsNullProject() )
262 {
264
265 if( aOptional )
266 {
267 wxMessageDialog dlg( this, _( "Add the library to the global library table?" ),
268 _( "Add To Global Library Table" ), wxYES_NO );
269
270 if( dlg.ShowModal() != wxID_OK )
271 ret = nullptr;
272 }
273
274 return ret;
275 }
276
277 wxArrayString libTableNames;
278 libTableNames.Add( _( "Global" ) );
279 libTableNames.Add( _( "Project" ) );
280
281 wxSingleChoiceDialog dlg( this, _( "Choose the Library Table to add the library to:" ),
282 _( "Add To Library Table" ), libTableNames );
283
284 if( aOptional )
285 {
286 dlg.FindWindow( wxID_CANCEL )->SetLabel( _( "Skip" ) );
287 dlg.FindWindow( wxID_OK )->SetLabel( _( "Add" ) );
288 }
289
290 if( dlg.ShowModal() != wxID_OK )
291 return nullptr;
292
293 switch( dlg.GetSelection() )
294 {
295 case 0: return &SYMBOL_LIB_TABLE::GetGlobalLibTable();
296 case 1: return PROJECT_SCH::SchSymbolLibTable( &Prj() );
297 default: return nullptr;
298 }
299}
300
301
302void SCH_BASE_FRAME::RedrawScreen( const VECTOR2I& aCenterPoint, bool aWarpPointer )
303{
304 GetCanvas()->GetView()->SetCenter( aCenterPoint );
305
306 if( aWarpPointer )
308
309 GetCanvas()->Refresh();
310}
311
312
314{
315 if( GetCanvas() && GetCanvas()->GetView() )
316 {
319 }
320}
321
322
324{
325 return static_cast<SCH_DRAW_PANEL*>( EDA_DRAW_FRAME::GetCanvas() );
326}
327
328
330{
331 if( GetCanvas() && GetCanvas()->GetView() )
332 {
333 if( KIGFX::PAINTER* painter = GetCanvas()->GetView()->GetPainter() )
334 return static_cast<SCH_RENDER_SETTINGS*>( painter->GetSettings() );
335 }
336
337 return nullptr;
338}
339
340
342{
344
345 SetCanvas( new SCH_DRAW_PANEL( this, wxID_ANY, wxPoint( 0, 0 ), m_frameSize,
348}
349
350
352{
354
355 try
356 {
357 if( !m_spaceMouse )
359
361 }
362 catch( const std::system_error& e )
363 {
364 wxLogTrace( wxT( "KI_TRACE_NAVLIB" ), e.what() );
365 }
366}
367
368
369void SCH_BASE_FRAME::UpdateItem( EDA_ITEM* aItem, bool isAddOrDelete, bool aUpdateRtree )
370{
371 EDA_ITEM* parent = aItem->GetParent();
372
373 if( aItem->Type() == SCH_SHEET_PIN_T )
374 {
375 // Sheet pins aren't in the view. Refresh their parent.
376 if( parent )
377 GetCanvas()->GetView()->Update( parent );
378 }
379 else
380 {
381 if( !isAddOrDelete )
382 GetCanvas()->GetView()->Update( aItem );
383
384 // Some children are drawn from their parents. Mark them for re-paint.
385 if( parent && parent->IsType( { SCH_SYMBOL_T, SCH_SHEET_T, SCH_LABEL_LOCATE_ANY_T, SCH_TABLE_T } ) )
386 GetCanvas()->GetView()->Update( parent, KIGFX::REPAINT );
387 }
388
393 if( aUpdateRtree && dynamic_cast<SCH_ITEM*>( aItem ) )
394 GetScreen()->Update( static_cast<SCH_ITEM*>( aItem ) );
395
396 // Calling Refresh() here introduces a bi-stable state: when doing operations on a
397 // large number of items if at some point the refresh timer times out and does a
398 // refresh it will take long enough that the next item will also time out, and the
399 // next, and the next, etc.
400 // GetCanvas()->Refresh();
401}
402
403
405{
406 // We currently have two zoom-dependent renderings: text, which is rendered as bitmap text
407 // when too small to see the difference, and selection shadows.
408 //
409 // Because non-selected text is cached by OpenGL, we only apply the bitmap performance hack
410 // to selected text items.
411 //
412 // Thus, as it currently stands, all zoom-dependent items can be found in the list of selected
413 // items.
414
415 if( m_toolManager )
416 {
418 SELECTION& selection = selectionTool->GetSelection();
419 KIGFX::SCH_VIEW* view = GetCanvas()->GetView();
420
421 for( EDA_ITEM* item : selection )
422 {
423 if( item->RenderAsBitmap( view->GetGAL()->GetWorldScale() ) != item->IsShownAsBitmap()
425 {
426 view->Update( item, KIGFX::REPAINT );
427
428 EDA_ITEM* parent = item->GetParent();
429
430 // Symbol children are drawn from their parents. Mark them for re-paint.
431 if( parent && parent->Type() == SCH_SYMBOL_T )
432 GetCanvas()->GetView()->Update( parent, KIGFX::REPAINT );
433 }
434 }
435 }
436}
437
438
440{
441 // Null pointers will cause boost::ptr_vector to raise a boost::bad_pointer exception which
442 // will be unhandled. There is no valid reason to pass an invalid EDA_ITEM pointer to the
443 // screen append function.
444 wxCHECK( aItem != nullptr, /* void */ );
445
446 auto screen = aScreen;
447
448 if( aScreen == nullptr )
449 screen = GetScreen();
450
451 if( aItem->Type() != SCH_TABLECELL_T )
452 screen->Append( (SCH_ITEM*) aItem );
453
454 if( screen == GetScreen() )
455 {
456 GetCanvas()->GetView()->Add( aItem );
457 UpdateItem( aItem, true ); // handle any additional parent semantics
458 }
459}
460
461
463{
464 auto screen = aScreen;
465
466 if( aScreen == nullptr )
467 screen = GetScreen();
468
469 if( screen == GetScreen() )
470 GetCanvas()->GetView()->Remove( aItem );
471
472 if( aItem->Type() != SCH_TABLECELL_T )
473 screen->Remove( (SCH_ITEM*) aItem );
474
475 if( screen == GetScreen() )
476 UpdateItem( aItem, true ); // handle any additional parent semantics
477}
478
479
481{
482 // Let tools add things to the view if necessary
483 if( m_toolManager )
485
487}
488
489
491{
492 return GetColorSettings()->GetColor( aLayer );
493}
494
495
496void SCH_BASE_FRAME::CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged )
497{
498 EDA_DRAW_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
499
500 COLOR_SETTINGS* colorSettings = GetColorSettings( true );
501
502 GetCanvas()->GetView()->GetPainter()->GetSettings()->LoadColors( colorSettings );
504
508}
509
510
512{
513 if( !m_colorSettings || aForceRefresh )
514 {
517 wxString colorTheme = cfg->m_ColorTheme;
518
520 {
522
523 if( !symCfg->m_UseEeschemaColorSettings )
524 colorTheme = symCfg->m_ColorTheme;
525 }
526
527 COLOR_SETTINGS* colorSettings = mgr.GetColorSettings( colorTheme );
528
529 const_cast<SCH_BASE_FRAME*>( this )->m_colorSettings = colorSettings;
530 }
531
532 return m_colorSettings;
533}
534
535
537{
539}
540
541
542void SCH_BASE_FRAME::handleActivateEvent( wxActivateEvent& aEvent )
543{
545
546 if( m_spaceMouse )
547 m_spaceMouse->SetFocus( aEvent.GetActive() );
548}
549
550
551void SCH_BASE_FRAME::handleIconizeEvent( wxIconizeEvent& aEvent )
552{
554
555 if( m_spaceMouse )
556 m_spaceMouse->SetFocus( false );
557}
558
559
561{
563 PROJECT& prj = Prj();
564
565 if( PROJECT_SCH::SchSymbolLibTable( &prj )->IsEmpty() )
566 {
567 ShowInfoBarError( _( "No symbol libraries are loaded." ) );
568 return wxEmptyString;
569 }
570
571 wxArrayString headers;
572
573 headers.Add( _( "Library" ) );
574
575 std::vector< wxArrayString > itemsToDisplay;
576 std::vector< wxString > libNicknames = PROJECT_SCH::SchSymbolLibTable( &prj )->GetLogicalLibs();
577
578 for( const wxString& name : libNicknames )
579 {
580 // Exclude read only libraries.
581 if( !PROJECT_SCH::SchSymbolLibTable( &prj )->IsSymbolLibWritable( name ) )
582 continue;
583
586 {
587 wxArrayString item;
588
590 itemsToDisplay.push_back( item );
591 }
592 }
593
594 for( const wxString& name : libNicknames )
595 {
596 // Exclude read only libraries.
597 if( !PROJECT_SCH::SchSymbolLibTable( &prj )->IsSymbolLibWritable( name ) )
598 continue;
599
602 {
603 wxArrayString item;
604
605 item.Add( name );
606 itemsToDisplay.push_back( item );
607 }
608 }
609
610 wxString oldLibName = prj.GetRString( PROJECT::SCH_LIB_SELECT );
611
612 EDA_LIST_DIALOG dlg( this, _( "Select Symbol Library" ), headers, itemsToDisplay, oldLibName,
613 false );
614
615 if( dlg.ShowModal() != wxID_OK )
616 return wxEmptyString;
617
618 wxString libName = dlg.GetTextSelection();
619
620 if( !libName.empty() )
621 {
622 if( PROJECT_SCH::SchSymbolLibTable( &prj )->HasLibrary( libName ) )
623 prj.SetRString( PROJECT::SCH_LIB_SELECT, libName );
624 else
625 libName = wxEmptyString;
626 }
627
628 return libName;
629}
630
631
633{
634 Unbind( wxEVT_FSWATCHER, &SCH_BASE_FRAME::OnSymChange, this );
635
636 if( m_watcher )
637 {
638 wxLogTrace( "KICAD_LIB_WATCH", "Remove watch" );
639 m_watcher->RemoveAll();
640 m_watcher->SetOwner( nullptr );
641 m_watcher.reset();
642 }
643
644 wxString libfullname;
646
647 if( !aID || !tbl )
648 return;
649
650 try
651 {
652 const SYMBOL_LIB_TABLE_ROW* row = tbl->FindRow( aID->GetLibNickname() );
653
654 if( !row )
655 return;
656
657 libfullname = row->GetFullURI( true );
658 }
659 catch( const std::exception& e )
660 {
661 DisplayInfoMessage( this, e.what() );
662 return;
663 }
664 catch( const IO_ERROR& error )
665 {
666 wxLogTrace( "KICAD_LIB_WATCH", "Error: %s", error.What() );
667 return;
668 }
669
670 wxLogTrace( "KICAD_LIB_WATCH", "Setting up watcher for %s", libfullname );
671 m_watcherFileName.Assign( libfullname );
672
673 if( !m_watcherFileName.FileExists() )
674 return;
675
676 wxLog::EnableLogging( false );
677 m_watcherLastModified = m_watcherFileName.GetModificationTime();
678 wxLog::EnableLogging( true );
679
680 Bind( wxEVT_FSWATCHER, &SCH_BASE_FRAME::OnSymChange, this );
681 m_watcher = std::make_unique<wxFileSystemWatcher>();
682 m_watcher->SetOwner( this );
683
684 wxFileName fn;
685 fn.AssignDir( m_watcherFileName.GetPath() );
686 fn.DontFollowLink();
687
688 m_watcher->AddTree( fn );
689}
690
691
692void SCH_BASE_FRAME::OnSymChange( wxFileSystemWatcherEvent& aEvent )
693{
695
696 wxLogTrace( "KICAD_LIB_WATCH", "OnSymChange: %s, watcher file: %s",
697 aEvent.GetPath().GetFullPath(), m_watcherFileName.GetFullPath() );
698
699 if( !libs || !m_watcher || !m_watcher.get() || m_watcherFileName.GetPath().IsEmpty() )
700 return;
701
702 if( aEvent.GetPath() != m_watcherFileName )
703 return;
704
705 // Start the debounce timer (set to 1 second)
706 if( !m_watcherDebounceTimer.StartOnce( 1000 ) )
707 {
708 wxLogTrace( "KICAD_LIB_WATCH", "Failed to start the debounce timer" );
709 return;
710 }
711}
712
713
715{
716 wxLogTrace( "KICAD_LIB_WATCH", "OnSymChangeDebounceTimer" );
717 // Disable logging to avoid spurious messages and check if the file has changed
718 wxLog::EnableLogging( false );
719 wxDateTime lastModified = m_watcherFileName.GetModificationTime();
720 wxLog::EnableLogging( true );
721
722 if( lastModified == m_watcherLastModified || !lastModified.IsValid() )
723 return;
724
725 m_watcherLastModified = lastModified;
726
727 if( !GetScreen()->IsContentModified() || IsOK( this, _( "The library containing the current symbol has changed.\n"
728 "Do you want to reload the library?" ) ) )
729 {
730 wxLogTrace( "KICAD_LIB_WATCH", "Sending refresh symbol mail" );
731 std::string libName = m_watcherFileName.GetFullPath().ToStdString();
734 }
735}
const char * name
Definition: DXF_plotter.cpp:57
constexpr EDA_IU_SCALE schIUScale
Definition: base_units.h:110
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:173
Handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:41
VECTOR2D m_LocalOrigin
Relative Screen cursor coordinate (on grid) in user units.
Definition: base_screen.h:90
Color settings are a bit different than most of the settings objects in that there can be more than o...
COLOR4D GetColor(int aLayer) const
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
virtual void handleIconizeEvent(wxIconizeEvent &aEvent)
Handle a window iconize event.
virtual bool IsContentModified() const
Get if the contents of the frame have been modified since the last save.
void ShowInfoBarError(const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left o...
bool IsType(FRAME_T aType) const
The base class for create windows for drawing purpose.
virtual void ActivateGalCanvas()
Use to start up the GAL drawing canvas.
COLOR_SETTINGS * m_colorSettings
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
void DisplayUnitsMsg()
Display current unit pane in the status bar.
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting(APP_SETTINGS_BASE *aCfg=nullptr)
Returns the canvas type stored in the application settings.
GAL_DISPLAY_OPTIONS_IMPL & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
void SetCanvas(EDA_DRAW_PANEL_GAL *aPanel)
virtual void handleActivateEvent(wxActivateEvent &aEvent)
Handle a window activation event.
void UpdateStatusBar() override
Update the status bar information.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
virtual void DisplayGridMsg()
Display current grid size in the status bar.
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
void ForceRefresh()
Force a redraw.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:88
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:100
virtual bool IsType(const std::vector< KICAD_T > &aScanTypes) const
Check whether the item is one of the listed types.
Definition: eda_item.h:175
EDA_ITEM * GetParent() const
Definition: eda_item.h:102
A dialog which shows:
wxString GetTextSelection(int aColumn=0)
Return the selected text from aColumn in the wxListCtrl in the dialog.
void OnIdle(wxIdleEvent &aEvent)
Zoom the screen to fit the bounding box for cross probing/selection sync.
EE_SELECTION & GetSelection()
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:77
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
void SetAxesColor(const COLOR4D &aAxesColor)
Set the axes color.
double GetWorldScale() const
Get the world scale.
Contains all the knowledge about how to draw graphical object onto any particular output device.
Definition: painter.h:59
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
virtual void LoadColors(const COLOR_SETTINGS *aSettings)
static std::vector< KICAD_T > g_ScaledSelectionTypes
Definition: sch_painter.h:149
virtual void CenterOnCursor()=0
Set the viewport center to the current cursor position and warps the cursor to the screen center.
VECTOR2D GetCursorPosition() const
Return the current cursor position in world coordinates.
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:315
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
Definition: view.cpp:354
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: view.cpp:1639
GAL * GetGAL() const
Return the #GAL this view is using to draw graphical primitives.
Definition: view.h:197
void RecacheAllItems()
Rebuild GAL display lists.
Definition: view.cpp:1418
void UpdateAllItems(int aUpdateFlags)
Update all items in the view according to the given flags.
Definition: view.cpp:1521
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:215
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:578
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:619
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:279
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
Send aPayload to aDestination from aSource.
Definition: kiway.cpp:527
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
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
Define a library symbol object.
Definition: lib_symbol.h:79
const wxString GetFullURI(bool aSubstituted=false) const
Return the full location specifying URI for the LIB, either in original UI form or in environment var...
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
static const wxString GetPinningSymbol()
The class that implements the public interface to the SpaceMouse plug-in.
void SetFocus(bool aFocus)
Set the connection to the 3Dconnexion driver to the focus state so that 3DMouse data is routed to thi...
void SetCanvas(EDA_DRAW_PANEL_GAL *aViewport)
Sets the viewport controlled by the SpaceMouse.
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:59
const VECTOR2D GetSizeIU(double aIUScale) const
Gets the page size in internal units.
Definition: page_info.h:171
virtual COMMON_SETTINGS * GetCommonSettings() const
Definition: pgm_base.cpp:678
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:142
std::vector< wxString > m_PinnedSymbolLibs
Below are project-level settings that have not been moved to a dedicated file.
Definition: project_file.h:120
static SYMBOL_LIB_TABLE * SchSymbolLibTable(PROJECT *aProject)
Accessor for project symbol library table.
static SYMBOL_LIBS * SchLibs(PROJECT *aProject)
Definition: project_sch.cpp:90
Container for project specific data.
Definition: project.h:62
@ SCH_LIB_SELECT
Definition: project.h:183
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:166
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:269
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:280
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
virtual void RedrawScreen(const VECTOR2I &aCenterPoint, bool aWarpPointer)
SCH_BASE_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aWindowType, const wxString &aTitle, const wxPoint &aPosition, const wxSize &aSize, long aStyle, const wxString &aFrameName)
void UpdateStatusBar() override
Update the status bar information.
SCH_RENDER_SETTINGS * GetRenderSettings()
void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
const VECTOR2I GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...
void SetPageSettings(const PAGE_INFO &aPageSettings) override
void handleIconizeEvent(wxIconizeEvent &aEvent) override
Handle a window iconize event.
void AddToScreen(EDA_ITEM *aItem, SCH_SCREEN *aScreen=nullptr)
Add an item to the screen (and view) aScreen is the screen the item is located on,...
void OnSymChange(wxFileSystemWatcherEvent &aEvent)
Handler for Symbol change events.
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
SYMBOL_EDITOR_SETTINGS * libeditconfig() const
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void HardRedraw() override
Rebuild the GAL and redraws the screen.
wxTimer m_watcherDebounceTimer
SYMBOL_LIB_TABLE * SelectSymLibTable(bool aOptional=false)
Display a dialog asking the user to select a symbol library table.
wxString SelectLibraryFromList()
Display a list of loaded libraries and allows the user to select a library.
void SyncView()
Mark all items for refresh.
wxDateTime m_watcherLastModified
std::unique_ptr< wxFileSystemWatcher > m_watcher
These are file watchers for the symbol library tables.
virtual ~SCH_BASE_FRAME()
const TITLE_BLOCK & GetTitleBlock() const override
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
NL_SCHEMATIC_PLUGIN * m_spaceMouse
bool saveSymbolLibTables(bool aGlobal, bool aProject)
Save Symbol Library Tables to disk.
void RefreshZoomDependentItems()
Mark selected items for refresh.
EESCHEMA_SETTINGS * eeconfig() const
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock) override
LIB_SYMBOL * GetLibSymbol(const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
Load symbol from symbol library table.
virtual void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false, bool aUpdateRtree=false)
Mark an item for refresh.
void handleActivateEvent(wxActivateEvent &aEvent) override
Handle a window activation event.
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Returns a pointer to the active color theme settings.
wxFileName m_watcherFileName
void setSymWatcher(const LIB_ID *aSymbol)
Creates (or removes) a watcher on the specified symbol library.
const PAGE_INFO & GetPageSettings() const override
COLOR4D GetDrawBgColor() const override
void OnSymChangeDebounceTimer(wxTimerEvent &aEvent)
Handler for the filesystem watcher debounce timer.
void RemoveFromScreen(EDA_ITEM *aItem, SCH_SCREEN *aScreen)
Remove an item from the screen (and view) aScreen is the screen the item is located on,...
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Helper to retrieve a layer color from the global color settings.
KIGFX::SCH_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:172
const PAGE_INFO & GetPageSettings() const
Definition: sch_screen.h:131
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)
Definition: sch_screen.h:157
void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition: sch_screen.h:132
const TITLE_BLOCK & GetTitleBlock() const
Definition: sch_screen.h:155
void Update(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
Update aItem's bounding box in the tree.
Definition: sch_screen.cpp:313
T * GetAppSettings()
Returns a handle to the a given settings by type If the settings have already been loaded,...
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieves a color settings object that applications can read colors from.
A collection of SYMBOL_LIB objects.
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_IO object i...
static SYMBOL_LIB_TABLE & GetGlobalLibTable()
static const wxString & GetSymbolLibTableFileName()
static wxString GetGlobalTableFileName()
Fetch the global symbol library table file name.
LIB_SYMBOL * LoadSymbol(const wxString &aNickname, const wxString &aName)
Load a LIB_SYMBOL having aName from the library given by aNickname.
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
Object used to load, save, search, and otherwise manipulate symbol library files.
bool IsCache() const
LIB_SYMBOL * FindSymbol(const wxString &aName) const
Find LIB_SYMBOL by aName.
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
@ MODEL_RELOAD
Model changes (the sheet for a schematic)
Definition: tool_base.h:80
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Reset all tools (i.e.
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
wxString wx_str() const
Definition: utf8.cpp:45
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:360
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:332
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:305
This file is part of the common library.
#define _(s)
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:33
@ FRAME_SCH_SYMBOL_EDITOR
Definition: frame_type.h:35
@ FRAME_SCH_VIEWER
Definition: frame_type.h:36
SCH_LAYER_ID
Eeschema drawing layers.
Definition: layer_ids.h:353
@ LAYER_SCHEMATIC_GRID_AXES
Definition: layer_ids.h:388
@ LAYER_SCHEMATIC_BACKGROUND
Definition: layer_ids.h:389
@ MAIL_REFRESH_SYMBOL
Definition: mail_type.h:58
@ REPAINT
Item needs to be redrawn.
Definition: view_item.h:57
@ ALL
All except INITIAL_ADD.
Definition: view_item.h:58
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
Definition: definitions.h:49
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:100
Declaration of the NL_SCHEMATIC_PLUGIN class.
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: pgm_base.cpp:1059
see class PGM_BASE
LIB_SYMBOL * SchGetLibSymbol(const LIB_ID &aLibId, SYMBOL_LIB_TABLE *aLibTable, SYMBOL_LIB *aCacheLib, wxWindow *aParent, bool aShowErrorMsg)
Load symbol from symbol library table.
LIB_SYMBOL * SchGetLibSymbol(const LIB_ID &aLibId, SYMBOL_LIB_TABLE *aLibTable, SYMBOL_LIB *aCacheLib=nullptr, wxWindow *aParent=nullptr, bool aShowErrorMsg=false)
Load symbol from symbol library table.
KIWAY Kiway(KFCTL_STANDALONE)
std::vector< wxString > pinned_symbol_libs
const double IU_PER_MILS
Definition: base_units.h:77
Definition for symbol library class.
@ SCH_SYMBOL_T
Definition: typeinfo.h:160
@ SCH_TABLECELL_T
Definition: typeinfo.h:154
@ SCH_SHEET_PIN_T
Definition: typeinfo.h:161