KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_edit_frame.h
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 wanadoo.fr
5 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
6 * Copyright (C) 2023 CERN (www.cern.ch)
7 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27#ifndef SCH_EDIT_FRAME_H
28#define SCH_EDIT_FRAME_H
29
30#include <stddef.h>
31#include <vector>
32#include <wx/cmndata.h>
33#include <wx/event.h>
34#include <wx/gdicmn.h>
35#include <wx/string.h>
36#include <wx/treectrl.h>
37#include <wx/utils.h>
38
39#include <core/typeinfo.h>
40#include <eda_base_frame.h>
41#include <eeschema_settings.h>
42#include <math/box2.h>
43#include <sch_base_frame.h>
44#include <template_fieldnames.h>
45
46class SCH_ITEM;
47class EDA_ITEM;
48class SCH_LINE;
49class SCH_TEXT;
50class SCH_BITMAP;
51class SCH_SHEET;
52class SCH_SHEET_PATH;
53class SCH_SHEET_PIN;
54class SCH_SYMBOL;
55class SCH_FIELD;
56class SCH_JUNCTION;
57class SCHEMATIC;
58class SCH_COMMIT;
59class DESIGN_BLOCK;
62class DIALOG_ERC;
64class DIALOG_SCH_FIND;
65class RESCUER;
66class HIERARCHY_PANE;
67class API_HANDLER_SCH;
69
70
73{
76};
77
78
80{
84};
85
86
87wxDECLARE_EVENT( EDA_EVT_SCHEMATIC_CHANGING, wxCommandEvent );
88wxDECLARE_EVENT( EDA_EVT_SCHEMATIC_CHANGED, wxCommandEvent );
89
90
94class NET_NAVIGATOR_ITEM_DATA : public wxTreeItemData
95{
96public:
97 NET_NAVIGATOR_ITEM_DATA( const SCH_SHEET_PATH& aSheetPath, const SCH_ITEM* aItem ) :
98 m_sheetPath( aSheetPath ),
99 m_item( aItem )
100 {
101 }
102
104 m_item( nullptr )
105 {
106 }
107
109 const SCH_ITEM* GetItem() const { return m_item; }
110
111 bool operator==( const NET_NAVIGATOR_ITEM_DATA& aRhs ) const
112 {
113 return ( m_sheetPath == aRhs.m_sheetPath ) && ( m_item == aRhs.m_item );
114 }
115
117 {
118 if( this == &aItemData )
119 return *this;
120
121 m_sheetPath = aItemData.m_sheetPath;
122 m_item = aItemData.m_item;
123
124 return *this;
125 }
126
127private:
130};
131
132
137{
138public:
139 SCH_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent );
140 ~SCH_EDIT_FRAME() override;
141
142 SCH_SCREEN* GetScreen() const override;
143
144 SELECTION& GetCurrentSelection() override;
145
146 SCHEMATIC& Schematic() const;
147
148 std::unique_ptr<GRID_HELPER> MakeGridHelper() override;
149
153 bool GetShowAllPins() const override;
154
158 void SaveProjectLocalSettings() override;
159
165 bool LoadProjectSettings();
166
170 void LoadDrawingSheet();
171
172 void ShowSchematicSetupDialog( const wxString& aInitialPage = wxEmptyString );
173
174 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
175 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
176
177 void CreateScreens();
178
179 void setupUIConditions() override;
180
186 bool IsContentModified() const override;
187
192 void OnModify() override;
193
194 SEVERITY GetSeverity( int aErrorCode ) const override;
195
199 wxString GetScreenDesc() const override;
200 wxString GetFullScreenDesc() const override;
201
222 void ExecuteRemoteCommand( const char* cmdline ) override;
223
224 void KiwayMailIn( KIWAY_EXPRESS& aEvent ) override;
225
230
234 void AutoRotateItem( SCH_SCREEN* aScreen, SCH_ITEM* aItem );
235
239 void ShowFindReplaceDialog( bool aReplace );
240
244 void UpdateHierarchyNavigator( bool aRefreshNetNavigator = true, bool aClear = false );
245
253
259
260 void ShowFindReplaceStatus( const wxString& aMsg, int aStatusTime );
262
266 void OnFindDialogClose();
267
272
282 void BreakSegment( SCH_COMMIT* aCommit, SCH_LINE* aSegment, const VECTOR2I& aPoint,
283 SCH_LINE** aNewSegment, SCH_SCREEN* aScreen );
284
294 bool BreakSegments( SCH_COMMIT* aCommit, const VECTOR2I& aPoint, SCH_SCREEN* aScreen );
295
304 bool BreakSegmentsOnJunctions( SCH_COMMIT* aCommit, SCH_SCREEN* aScreen );
305
311 void TestDanglingEnds();
312
322 void SendSelectItemsToPcb( const std::vector<EDA_ITEM*>& aItems, bool aForce );
323
329 void SendCrossProbeNetName( const wxString& aNetName );
330
336 void SetCrossProbeConnection( const SCH_CONNECTION* aConnection );
337
342
343 const wxString& GetHighlightedConnection() const
344 {
345 return m_highlightedConn;
346 }
347
348 void SetHighlightedConnection( const wxString& aConnection,
349 const NET_NAVIGATOR_ITEM_DATA* aSelection = nullptr );
350
359 bool ReadyToNetlist( const wxString& aAnnotateMessage );
360
376 bool WriteNetListFile( int aFormat, const wxString& aFullFileName, unsigned aNetlistOptions,
377 REPORTER* aReporter = nullptr );
378
386 void DeleteAnnotation( ANNOTATE_SCOPE_T aAnnotateScope, bool aRecursive, REPORTER& aReporter );
387
412 void AnnotateSymbols( SCH_COMMIT* aCommit, ANNOTATE_SCOPE_T aAnnotateScope,
413 ANNOTATE_ORDER_T aSortOption, ANNOTATE_ALGO_T aAlgoOption,
414 bool aRecursive, int aStartNumber, bool aResetAnnotation,
415 bool aRepairTimestamps, REPORTER& aReporter );
416
433 int CheckAnnotate( ANNOTATION_ERROR_HANDLER aErrorHandler,
434 ANNOTATE_SCOPE_T aAnnotateScope = ANNOTATE_ALL,
435 bool aRecursive = true );
436
443 int ModalAnnotate( const wxString& aMessage );
444
445 // Functions used for hierarchy handling
447
448 void SetCurrentSheet( const SCH_SHEET_PATH& aSheet );
449
450 void UpdateItem( EDA_ITEM* aItem, bool isAddOrDelete = false,
451 bool aUpdateRtree = false ) override;
452
458 void HardRedraw() override;
459
463 void DisplayCurrentSheet();
464
469
476 void OnPageSettingsChange() override;
477
484
485 wxPageSetupDialogData& GetPageSetupData() { return m_pageSetupData; }
486
487 void NewProject();
488 void LoadProject();
489
497 bool SaveProject( bool aSaveAs = false );
498
499 bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl = 0 ) override;
500
501 wxString GetCurrentFileName() const override;
502
510 bool AskToSaveChanges();
511
512 SCH_JUNCTION* AddJunction( SCH_COMMIT* aCommit, SCH_SCREEN* aScreen, const VECTOR2I& aPos );
513
521 void SchematicCleanUp( SCH_COMMIT* aCommit, SCH_SCREEN* aScreen = nullptr );
522
532 bool TrimWire( SCH_COMMIT* aCommit, const VECTOR2I& aStart, const VECTOR2I& aEnd );
533
534 void OnOpenPcbnew();
535 void OnOpenCvpcb();
536 void OnUpdatePCB();
537 void OnAnnotate();
538
546 bool CheckSheetForRecursion( SCH_SHEET* aSheet, SCH_SHEET_PATH* aCurrentSheet );
547
559 bool AllowCaseSensitiveFileNameClashes( const wxString& aOldName,
560 const wxString& aSchematicFileName );
561
595 bool EditSheetProperties( SCH_SHEET* aSheet, SCH_SHEET_PATH* aHierarchy,
596 bool* aIsUndoable = nullptr, bool* aClearAnnotationNewItems = nullptr,
597 bool* aUpdateHierarchyNavigator = nullptr,
598 wxString* aSourceSheetFilename = nullptr );
599
600 void InitSheet( SCH_SHEET* aSheet, const wxString& aNewFilename );
601
652 bool LoadSheetFromFile( SCH_SHEET* aSheet, SCH_SHEET_PATH* aCurrentSheet,
653 const wxString& aFileName, bool aSkipRecursionCheck = false,
654 bool aSkipLibCheck = false );
655
661 void DeleteJunction( SCH_COMMIT* aCommit, SCH_ITEM* aItem );
662
663 void FlipBodyStyle( SCH_SYMBOL* aSymbol );
664
665 void SelectUnit( SCH_SYMBOL* aSymbol, int aUnit );
666
667 void SetAltPinFunction( SCH_PIN* aPin, const wxString& aFunction );
668
669 /* Undo - redo */
670
687 void SaveCopyInUndoList( SCH_SCREEN* aScreen, SCH_ITEM* aItemToCopy, UNDO_REDO aTypeCommand,
688 bool aAppend, bool aDirtyConnectivity = true );
689
698 void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList, UNDO_REDO aTypeCommand,
699 bool aAppend, bool aDirtyConnectivity = true );
700
707
719 void ClearUndoORRedoList( UNDO_REDO_LIST whichList, int aItemCount = -1 ) override;
720
724 void SaveCopyForRepeatItem( const SCH_ITEM* aItem );
725 void AddCopyForRepeatItem( const SCH_ITEM* aItem );
726
732 const std::vector<std::unique_ptr<SCH_ITEM>>& GetRepeatItems() const
733 {
734 return m_items_to_repeat;
735 }
736
743 {
744 m_items_to_repeat.clear();
745 }
746
747 EDA_ITEM* GetItem( const KIID& aId ) const override;
748
755
762 bool CreateArchiveLibrary( const wxString& aFileName );
763
776 wxString CreateNewDesignBlockLibrary( const wxString& aLibName = wxEmptyString,
777 const wxString& aProposedName = wxEmptyString );
778
785 bool AddDesignBlockLibrary( const wxString& aFilename, DESIGN_BLOCK_LIB_TABLE* aTable );
786
787 void SaveSheetAsDesignBlock( const wxString& aLibraryName, SCH_SHEET_PATH& aSheetPath );
788
789 void SaveSelectionAsDesignBlock( const wxString& aLibraryName );
790
791 bool DeleteDesignBlockLibrary( const wxString& aLibName, bool aConfirm );
792
793 bool DeleteDesignBlockFromLibrary( const LIB_ID& aLibId, bool aConfirm );
794
795 bool EditDesignBlockProperties( const LIB_ID& aLibId );
796
797
807 DESIGN_BLOCK* GetDesignBlock( const LIB_ID& aLibId, bool aUseCacheLib = false,
808 bool aShowErrorMsg = false );
809
811
812 void SetNetListerCommand( const wxString& aCommand ) { m_netListerCommand = aCommand; }
813
817 void DefaultExecFlags() { m_exec_flags = wxEXEC_SYNC; }
818
824 void SetExecFlags( const int aFlags ) { m_exec_flags |= aFlags; }
825
832 void ClearExecFlags( const int aFlags ) { m_exec_flags &= ~( aFlags ); }
833
834 wxString GetNetListerCommand() const { return m_netListerCommand; }
835
839 void RecalculateConnections( SCH_COMMIT* aCommit, SCH_CLEANUP_FLAGS aCleanupFlags );
840
844 void CommonSettingsChanged( int aFlags ) override;
845
847
848 void ShowChangedLanguage() override;
849
850 void SetScreen( BASE_SCREEN* aScreen ) override;
851
852 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
853
855
856 void FocusOnItem( SCH_ITEM* aItem );
857
859
868 void SaveSymbolToSchematic( const LIB_SYMBOL& aSymbol, const KIID& aSchematicSymbolUUID );
869
875
876 void ShowAllIntersheetRefs( bool aShow );
877
884 virtual void CheckForAutoSaveFile( const wxFileName& aFileName ) override;
885
886 virtual void DeleteAutoSaveFile( const wxFileName& aFileName ) override;
887
892
896 void ToggleSearch();
897
898 void ToggleProperties() override;
899
900 void ToggleLibraryTree() override;
901
903
905
907
908 wxTreeCtrl* GetNetNavigator() { return m_netNavigator; }
909
911
915 static const wxString SchematicHierarchyPaneName()
916 {
917 return wxT( "SchematicHierarchy" );
918 }
919
923 static const wxString SearchPaneName() { return wxT( "Search" ); }
924
925 bool IsSearchPaneShown() { return m_auimgr.GetPane( SearchPaneName() ).IsShown(); }
926
927 void FocusSearch();
928
938 void AddSchematicChangeListener( wxEvtHandler* aListener );
939
943 void RemoveSchematicChangeListener( wxEvtHandler* aListener );
944
945 static const wxString NetNavigatorPaneName()
946 {
947 return wxS( "NetNavigator" );
948 }
949
950 void RefreshNetNavigator( const NET_NAVIGATOR_ITEM_DATA* aSelection = nullptr );
951
952 void MakeNetNavigatorNode( const wxString& aNetName, wxTreeItemId aParentId,
953 const NET_NAVIGATOR_ITEM_DATA* aSelection,
954 bool aSingleSheetSchematic );
955
956 void SelectNetNavigatorItem( const NET_NAVIGATOR_ITEM_DATA* aSelection = nullptr );
957
958 const SCH_ITEM* SelectNextPrevNetNavigatorItem( bool aNext );
959
960 void ToggleNetNavigator();
961
963 {
964 return PLUGIN_ACTION_SCOPE::SCHEMATIC;
965 }
966
967 DECLARE_EVENT_TABLE()
968
969protected:
975 bool doAutoSave() override;
976
977 void configureToolbars() override;
978
979 void doReCreateMenuBar() override;
980
984 void sendNetlistToCvpcb();
985
986 void onSize( wxSizeEvent& aEvent );
987
988 void saveProjectSettings() override;
989
990 void onCloseSymbolDiffDialog( wxCommandEvent& aEvent );
991
992 void onCloseErcDialog( wxCommandEvent& aEvent );
993
994 void onCloseSymbolFieldsTableDialog( wxCommandEvent& aEvent );
995
996 void unitsChangeRefresh() override;
997
998 void updateSelectionFilterVisbility() override;
999
1000#ifdef KICAD_IPC_API
1001 void onPluginAvailabilityChanged( wxCommandEvent& aEvt );
1002#endif
1003
1009 DESIGN_BLOCK_LIB_TABLE* selectDesignBlockLibTable( bool aOptional = false );
1010
1015 wxString createNewDesignBlockLibrary( const wxString& aLibName, const wxString& aProposedName,
1016 DESIGN_BLOCK_LIB_TABLE* aTable );
1017
1018private:
1019 // Called when resizing the Hierarchy Navigator panel
1020 void OnResizeHierarchyNavigator( wxSizeEvent& aEvent );
1021
1022 void onResizeNetNavigator( wxSizeEvent& aEvent );
1023
1024 // Sets up the tool framework
1025 void setupTools();
1026
1027 void OnExit( wxCommandEvent& event );
1028
1029 void OnLoadFile( wxCommandEvent& event );
1030 void OnImportProject( wxCommandEvent& event );
1031
1032 void OnClearFileHistory( wxCommandEvent& aEvent );
1033
1034 bool canCloseWindow( wxCloseEvent& aCloseEvent ) override;
1035 void doCloseWindow() override;
1036
1045 void updateTitle();
1046
1050 void initScreenZoom();
1051
1061
1068 bool importFile( const wxString& aFileName, int aFileType,
1069 const std::map<std::string, UTF8>* aProperties = nullptr );
1070
1078 bool saveSchematicFile( SCH_SHEET* aSheet, const wxString& aSavePath );
1079
1085 void mapExistingAnnotation( std::map<wxString, wxString>& aMap );
1086
1087 bool updateAutoSaveFile();
1088
1089 const wxString& getAutoSaveFileName() const;
1090
1091 wxTreeCtrl* createHighlightedNetNavigator();
1092
1093 void onNetNavigatorSelection( wxTreeEvent& aEvent );
1094
1095 void onNetNavigatorSelChanging( wxTreeEvent& aEvent );
1096
1098
1099private:
1100 // The schematic editor control class should be able to access some internal
1101 // functions of the editor frame.
1104
1107
1108 wxPageSetupDialogData m_pageSetupData;
1109 std::vector<std::unique_ptr<SCH_ITEM>> m_items_to_repeat;
1110
1115
1122
1123
1124 wxTreeCtrl* m_netNavigator;
1125
1126 bool m_syncingPcbToSchSelection; // Recursion guard when synchronizing selection from PCB
1127
1129
1131
1132 std::vector<wxEvtHandler*> m_schematicChangeListeners;
1133
1134 std::vector<LIB_ID> m_designBlockHistoryList;
1135
1137
1138#ifdef KICAD_IPC_API
1139 std::unique_ptr<API_HANDLER_SCH> m_apiHandler;
1140#endif
1141};
1142
1143
1144#endif // SCH_EDIT_FRAME_H
PLUGIN_ACTION_SCOPE
Definition: api_plugin.h:56
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
Handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:41
UNDO_REDO_LIST
Specify whether we are interacting with the undo or redo stacks.
wxAuiManager m_auimgr
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:89
Definition: kiid.h:49
Carry a payload from one KIWAY_PLAYER to another within a PROJECT.
Definition: kiway_express.h:40
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:285
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
Define a library symbol object.
Definition: lib_symbol.h:85
Tree view item data for the net navigator.
const SCH_ITEM * m_item
const SCH_ITEM * GetItem() const
SCH_SHEET_PATH m_sheetPath
bool operator==(const NET_NAVIGATOR_ITEM_DATA &aRhs) const
NET_NAVIGATOR_ITEM_DATA(const SCH_SHEET_PATH &aSheetPath, const SCH_ITEM *aItem)
SCH_SHEET_PATH & GetSheetPath()
NET_NAVIGATOR_ITEM_DATA & operator=(const NET_NAVIGATOR_ITEM_DATA &aItemData)
A holder to handle information on schematic or board items.
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:73
Holds all the data relating to one schematic.
Definition: schematic.h:69
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
Object to handle a bitmap image that can be inserted in a schematic.
Definition: sch_bitmap.h:40
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
Handle actions specific to the schematic editor.
Schematic editor (Eeschema) main window.
void ShowSchematicSetupDialog(const wxString &aInitialPage=wxEmptyString)
void RollbackSchematicFromUndo()
Perform an undo of the last edit without logging a corresponding redo.
void DefaultExecFlags()
Reset the execution flags to defaults for external netlist and bom generators.
bool IsSyncingSelection()
void ToggleProperties() override
bool IsContentModified() const override
Get if the current schematic has been modified but not saved.
void RefreshOperatingPointDisplay()
Refresh the display of any operating points.
wxPageSetupDialogData m_pageSetupData
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
EDA_ITEM * GetItem(const KIID &aId) const override
Fetch an item by KIID.
void mapExistingAnnotation(std::map< wxString, wxString > &aMap)
Fill a map of uuid -> reference from the currently loaded schematic.
Definition: annotate.cpp:39
void SaveSelectionAsDesignBlock(const wxString &aLibraryName)
const wxString & getAutoSaveFileName() const
wxTreeCtrl * m_netNavigator
std::vector< std::unique_ptr< SCH_ITEM > > m_items_to_repeat
For the repeat-last-item cmd.
void ToggleNetNavigator()
void onResizeNetNavigator(wxSizeEvent &aEvent)
void updateSelectionFilterVisbility() override
Selection filter panel doesn't have a dedicated visibility control, so show it if any other AUI panel...
bool m_highlightedConnChanged
bool EditDesignBlockProperties(const LIB_ID &aLibId)
void onNetNavigatorSelChanging(wxTreeEvent &aEvent)
void SetExecFlags(const int aFlags)
Set (adds) specified flags for next execution of external generator of the netlist or bom.
bool AllowCaseSensitiveFileNameClashes(const wxString &aOldName, const wxString &aSchematicFileName)
Check aSchematicFileName for a potential file name case sensitivity clashes.
Definition: sheet.cpp:722
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag and update other data struc...
void ShowAllIntersheetRefs(bool aShow)
void SaveProjectLocalSettings() override
Save changes to the project settings to the project (.pro) file.
bool OpenProjectFiles(const std::vector< wxString > &aFileSet, int aCtl=0) override
Open a project or set of files given by aFileList.
void DeleteAnnotation(ANNOTATE_SCOPE_T aAnnotateScope, bool aRecursive, REPORTER &aReporter)
Clear the current symbol annotation.
Definition: annotate.cpp:60
void doCloseWindow() override
DIALOG_BOOK_REPORTER * m_diffSymbolDialog
wxString createNewDesignBlockLibrary(const wxString &aLibName, const wxString &aProposedName, DESIGN_BLOCK_LIB_TABLE *aTable)
Create a new library in the given table (presumed to be either the global or project library table).
void ToggleLibraryTree() override
void SetHighlightedConnection(const wxString &aConnection, const NET_NAVIGATOR_ITEM_DATA *aSelection=nullptr)
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
bool ReadyToNetlist(const wxString &aAnnotateMessage)
Check if we are ready to write a netlist file for the current schematic.
void onCloseErcDialog(wxCommandEvent &aEvent)
void ShowFindReplaceDialog(bool aReplace)
Run the Find or Find & Replace dialog.
void InitSheet(SCH_SHEET *aSheet, const wxString &aNewFilename)
Definition: sheet.cpp:110
void UpdateHierarchySelection()
Update the hierarchy navigation tree selection (cross-probe from schematic to hierarchy pane).
bool m_syncingPcbToSchSelection
bool BreakSegmentsOnJunctions(SCH_COMMIT *aCommit, SCH_SCREEN *aScreen)
Test all junctions and bus entries in the schematic for intersections with wires and buses and breaks...
void SaveSheetAsDesignBlock(const wxString &aLibraryName, SCH_SHEET_PATH &aSheetPath)
void SetScreen(BASE_SCREEN *aScreen) override
bool AskToSaveChanges()
Check if any of the screens has unsaved changes and asks the user whether to save or drop them.
void OnFindDialogClose()
Notification that the Find dialog has closed.
wxString GetNetListerCommand() const
bool doAutoSave() override
Save the schematic files that have been modified and not yet saved.
void SaveSymbolToSchematic(const LIB_SYMBOL &aSymbol, const KIID &aSchematicSymbolUUID)
Update a schematic symbol from a LIB_SYMBOL.
void SchematicCleanUp(SCH_COMMIT *aCommit, SCH_SCREEN *aScreen=nullptr)
Perform routine schematic cleaning including breaking wire and buses and deleting identical objects s...
void onSize(wxSizeEvent &aEvent)
DIALOG_SCHEMATIC_SETUP * m_schematicSetupDialog
bool LoadSheetFromFile(SCH_SHEET *aSheet, SCH_SHEET_PATH *aCurrentSheet, const wxString &aFileName, bool aSkipRecursionCheck=false, bool aSkipLibCheck=false)
Load a the KiCad schematic file aFileName into the sheet aSheet.
Definition: sheet.cpp:169
void SetAltPinFunction(SCH_PIN *aPin, const wxString &aFunction)
Definition: picksymbol.cpp:221
void CommonSettingsChanged(int aFlags) override
Called after the preferences dialog is run.
void doReCreateMenuBar() override
void ShowChangedLanguage() override
void SendSelectItemsToPcb(const std::vector< EDA_ITEM * > &aItems, bool aForce)
Send items to board editor for selection.
bool DeleteDesignBlockFromLibrary(const LIB_ID &aLibId, bool aConfirm)
wxPageSetupDialogData & GetPageSetupData()
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend, bool aDirtyConnectivity=true)
Create a copy of the current schematic item, and put it in the undo list.
void configureToolbars() override
std::vector< wxEvtHandler * > m_schematicChangeListeners
void AnnotateSymbols(SCH_COMMIT *aCommit, ANNOTATE_SCOPE_T aAnnotateScope, ANNOTATE_ORDER_T aSortOption, ANNOTATE_ALGO_T aAlgoOption, bool aRecursive, int aStartNumber, bool aResetAnnotation, bool aRepairTimestamps, REPORTER &aReporter)
Annotate the symbols in the schematic that are not currently annotated.
Definition: annotate.cpp:212
void SendCrossProbeClearHighlight()
Tell Pcbnew to clear the existing highlighted net, if one exists.
void HardRedraw() override
Rebuild the GAL and redraw the screen.
void OnClearFileHistory(wxCommandEvent &aEvent)
void MakeNetNavigatorNode(const wxString &aNetName, wxTreeItemId aParentId, const NET_NAVIGATOR_ITEM_DATA *aSelection, bool aSingleSheetSchematic)
bool GetShowAllPins() const override
Allow edit frame to show/hide hidden pins.
bool WriteNetListFile(int aFormat, const wxString &aFullFileName, unsigned aNetlistOptions, REPORTER *aReporter=nullptr)
Create a netlist file.
void ClearUndoORRedoList(UNDO_REDO_LIST whichList, int aItemCount=-1) override
Free the undo or redo list from aList element.
SCHEMATIC * m_schematic
The currently loaded schematic.
void onCloseSymbolFieldsTableDialog(wxCommandEvent &aEvent)
void ClearFindReplaceStatus()
SCH_SHEET_PATH & GetCurrentSheet() const
void OnLoadFile(wxCommandEvent &event)
const SCH_ITEM * GetSelectedNetNavigatorItem() const
PLUGIN_ACTION_SCOPE PluginActionScope() const override
SCHEMATIC & Schematic() const
void updateTitle()
Set the main window title bar text.
void ExecuteRemoteCommand(const char *cmdline) override
Execute a remote command sent via a socket on port KICAD_SCH_PORT_SERVICE_NUMBER (which defaults to 4...
const std::vector< std::unique_ptr< SCH_ITEM > > & GetRepeatItems() const
Return the items which are to be repeated with the insert key.
bool IsSearchPaneShown()
bool saveSchematicFile(SCH_SHEET *aSheet, const wxString &aSavePath)
Save aSheet to a schematic file.
void ToggleSearch()
Toggle the show/hide state of Search pane.
void DrawCurrentSheetToClipboard()
Use the wxWidgets print code to draw an image of the current sheet onto the clipboard.
Definition: sheet.cpp:624
bool LoadProjectSettings()
Load the KiCad project file (*.pro) settings specific to Eeschema.
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
void RefreshNetNavigator(const NET_NAVIGATOR_ITEM_DATA *aSelection=nullptr)
wxString GetFullScreenDesc() const override
static const wxString SearchPaneName()
DIALOG_BOOK_REPORTER * GetSymbolDiffDialog()
DESIGN_BLOCK * GetDesignBlock(const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
Load design block from design block library table.
bool canCloseWindow(wxCloseEvent &aCloseEvent) override
wxTreeCtrl * GetNetNavigator()
DESIGN_BLOCK_LIB_TABLE * selectDesignBlockLibTable(bool aOptional=false)
Prompt user to select global or project library tables.
int m_exec_flags
Flags of the wxExecute() function to call a custom net list generator.
void RecomputeIntersheetRefs()
Update the schematic's page reference map for all global labels, and refresh the labels so that they ...
bool checkForNoFullyDefinedLibIds(SCH_SHEET *aSheet)
Verify that the symbol library links aSheet and all of its child sheets have been remapped to the sym...
Definition: sheet.cpp:88
DIALOG_ERC * GetErcDialog()
void sendNetlistToCvpcb()
Send the KiCad netlist over to CVPCB.
bool EditSheetProperties(SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy, bool *aIsUndoable=nullptr, bool *aClearAnnotationNewItems=nullptr, bool *aUpdateHierarchyNavigator=nullptr, wxString *aSourceSheetFilename=nullptr)
Edit an existing sheet or add a new sheet to the schematic.
Definition: sheet.cpp:603
bool BreakSegments(SCH_COMMIT *aCommit, const VECTOR2I &aPoint, SCH_SCREEN *aScreen)
Check every wire and bus for a intersection at aPoint and break into two segments at aPoint if an int...
void UpdateHierarchyNavigator(bool aRefreshNetNavigator=true, bool aClear=false)
Update the hierarchy navigation tree and history.
void ToggleSchematicHierarchy()
Toggle the show/hide state of the left side schematic navigation panel.
bool importFile(const wxString &aFileName, int aFileType, const std::map< std::string, UTF8 > *aProperties=nullptr)
Load the given filename but sets the path to the current project path.
void FlipBodyStyle(SCH_SYMBOL *aSymbol)
Definition: picksymbol.cpp:182
void SendCrossProbeNetName(const wxString &aNetName)
Send a net name to Pcbnew for highlighting.
bool AddDesignBlockLibrary(const wxString &aFilename, DESIGN_BLOCK_LIB_TABLE *aTable)
Add an existing library to either the global or project library table.
void LoadDrawingSheet()
Load the drawing sheet file.
virtual void DeleteAutoSaveFile(const wxFileName &aFileName) override
const SCH_ITEM * SelectNextPrevNetNavigatorItem(bool aNext)
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
wxString CreateNewDesignBlockLibrary(const wxString &aLibName=wxEmptyString, const wxString &aProposedName=wxEmptyString)
If a library name is given, creates a new design block library in the project folder with the given n...
std::vector< LIB_ID > m_designBlockHistoryList
void OnPageSettingsChange() override
Called when modifying the page settings.
void ClearRepeatItemsList()
Clear the list of items which are to be repeated with the insert key.
void SelectUnit(SCH_SYMBOL *aSymbol, int aUnit)
Definition: picksymbol.cpp:95
const BOX2I GetDocumentExtents(bool aIncludeAllVisible=true) const override
Return bounding box of document with option to not include some items.
void RecalculateConnections(SCH_COMMIT *aCommit, SCH_CLEANUP_FLAGS aCleanupFlags)
Generate the connection data for the entire schematic hierarchy.
void CaptureHierarchyPaneSize()
void initScreenZoom()
Initialize the zoom value of the current screen and mark the screen as zoom-initialized.
bool CheckSheetForRecursion(SCH_SHEET *aSheet, SCH_SHEET_PATH *aCurrentSheet)
Verify that aSheet will not cause a recursion error in aCurrentSheet.
Definition: sheet.cpp:54
void UpdateLabelsHierarchyNavigator()
Update the hierarchy navigation tree labels.
void OnImportProject(wxCommandEvent &event)
void ClearExecFlags(const int aFlags)
Clear (removes) specified flags that not needed for next execution of external generator of the netli...
static const wxString SchematicHierarchyPaneName()
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
void unitsChangeRefresh() override
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
int CheckAnnotate(ANNOTATION_ERROR_HANDLER aErrorHandler, ANNOTATE_SCOPE_T aAnnotateScope=ANNOTATE_ALL, bool aRecursive=true)
Check for annotation errors.
Definition: annotate.cpp:460
void RemoveSchematicChangeListener(wxEvtHandler *aListener)
Remove aListener to from the schematic changed listener list.
void ShowFindReplaceStatus(const wxString &aMsg, int aStatusTime)
bool CreateArchiveLibrary(const wxString &aFileName)
Create a library aFileName that contains all symbols used in the current schematic.
Definition: libarch.cpp:41
void SetCurrentSheet(const SCH_SHEET_PATH &aSheet)
void BreakSegment(SCH_COMMIT *aCommit, SCH_LINE *aSegment, const VECTOR2I &aPoint, SCH_LINE **aNewSegment, SCH_SCREEN *aScreen)
Break a single segment into two at the specified point.
int GetSchematicJunctionSize()
void DisplayCurrentSheet()
Draw the current sheet on the display.
void SetNetListerCommand(const wxString &aCommand)
void PutDataInPreviousState(PICKED_ITEMS_LIST *aList)
Restore an undo or redo command to put data pointed by aList in the previous state.
int ModalAnnotate(const wxString &aMessage)
Run a modal version of the annotate dialog for a specific purpose.
~SCH_EDIT_FRAME() override
virtual void CheckForAutoSaveFile(const wxFileName &aFileName) override
This overloaded version checks if the auto save master file "#auto_saved_files#" exists and recovers ...
const wxString & GetHighlightedConnection() const
DIALOG_ERC * m_ercDialog
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false, bool aUpdateRtree=false) override
Mark an item for refresh.
wxString m_netListerCommand
Command line to call a custom net list generator.
bool TrimWire(SCH_COMMIT *aCommit, const VECTOR2I &aStart, const VECTOR2I &aEnd)
If any single wire passes through both points, remove the portion between the two points,...
void UpdateNetHighlightStatus()
wxString GetScreenDesc() const override
Return a human-readable description of the current screen.
DIALOG_SCH_FIND * m_findReplaceDialog
DESIGN_BLOCK_PANE * m_designBlocksPane
void SelectNetNavigatorItem(const NET_NAVIGATOR_ITEM_DATA *aSelection=nullptr)
void AddCopyForRepeatItem(const SCH_ITEM *aItem)
DIALOG_SYMBOL_FIELDS_TABLE * GetSymbolFieldsTableDialog()
void OnResizeHierarchyNavigator(wxSizeEvent &aEvent)
wxString GetCurrentFileName() const override
Get the full filename + path of the currently opened file in the frame.
void UpdateDesignBlockOptions()
Design block panel options have changed and the panel needs to be refreshed.
wxString m_highlightedConn
The highlighted net or bus or empty string.
static const wxString NetNavigatorPaneName()
void SetCrossProbeConnection(const SCH_CONNECTION *aConnection)
Send a connection (net or bus) to Pcbnew for highlighting.
void onCloseSymbolDiffDialog(wxCommandEvent &aEvent)
wxTreeCtrl * createHighlightedNetNavigator()
void TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
DESIGN_BLOCK_PANE * GetDesignBlockPane() const
bool SaveProject(bool aSaveAs=false)
Save the currently-open schematic (including its hierarchy) and associated project.
bool DeleteDesignBlockLibrary(const wxString &aLibName, bool aConfirm)
void saveProjectSettings() override
Save any design-related project settings associated with this frame.
void OnExit(wxCommandEvent &event)
void DeleteJunction(SCH_COMMIT *aCommit, SCH_ITEM *aItem)
Remove a given junction and heals any wire segments under the junction.
void AutoRotateItem(SCH_SCREEN *aScreen, SCH_ITEM *aItem)
Automatically set the rotation of an item (if the item supports it).
void AddSchematicChangeListener(wxEvtHandler *aListener)
Add aListener to post #EDA_EVT_SCHEMATIC_CHANGED command events to.
HIERARCHY_PANE * m_hierarchy
DIALOG_SYMBOL_FIELDS_TABLE * m_symbolFieldsTableDialog
std::unique_ptr< GRID_HELPER > MakeGridHelper() override
SEVERITY GetSeverity(int aErrorCode) const override
void onNetNavigatorSelection(wxTreeEvent &aEvent)
void FocusOnItem(SCH_ITEM *aItem)
SCH_JUNCTION * AddJunction(SCH_COMMIT *aCommit, SCH_SCREEN *aScreen, const VECTOR2I &aPos)
void SaveCopyForRepeatItem(const SCH_ITEM *aItem)
Clone aItem and owns that clone in this container.
void KiwayMailIn(KIWAY_EXPRESS &aEvent) override
Receive KIWAY_EXPRESS messages from other players.
Handle actions specific to the schematic editor.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:167
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:41
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:66
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:47
Schematic symbol object.
Definition: sch_symbol.h:75
Base window classes and related definitions.
SEVERITY
SCH_CLEANUP_FLAGS
@ LOCAL_CLEANUP
@ NO_CLEANUP
@ GLOBAL_CLEANUP
wxDECLARE_EVENT(EDA_EVT_SCHEMATIC_CHANGING, wxCommandEvent)
SCH_SEARCH_T
Schematic search type used by the socket link with Pcbnew.
@ HIGHLIGHT_SYMBOL
@ HIGHLIGHT_PIN
std::function< void(ERCE_T aType, const wxString &aMsg, SCH_REFERENCE *aItemA, SCH_REFERENCE *aItemB)> ANNOTATION_ERROR_HANDLER
Define a standard error handler for annotation errors.
ANNOTATE_ORDER_T
Schematic annotation order options.
ANNOTATE_SCOPE_T
Schematic annotation scope options.
@ ANNOTATE_ALL
Annotate the full schematic.
ANNOTATE_ALGO_T
Schematic annotation type options.
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...