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 (C) 2004-2024 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;
68
69
72{
75};
76
77
79{
83};
84
85
86wxDECLARE_EVENT( EDA_EVT_SCHEMATIC_CHANGING, wxCommandEvent );
87wxDECLARE_EVENT( EDA_EVT_SCHEMATIC_CHANGED, wxCommandEvent );
88
89
93class NET_NAVIGATOR_ITEM_DATA : public wxTreeItemData
94{
95public:
96 NET_NAVIGATOR_ITEM_DATA( const SCH_SHEET_PATH& aSheetPath, const SCH_ITEM* aItem ) :
97 m_sheetPath( aSheetPath ),
98 m_item( aItem )
99 {
100 }
101
103 m_item( nullptr )
104 {
105 }
106
108 const SCH_ITEM* GetItem() const { return m_item; }
109
110 bool operator==( const NET_NAVIGATOR_ITEM_DATA& aRhs ) const
111 {
112 return ( m_sheetPath == aRhs.m_sheetPath ) && ( m_item == aRhs.m_item );
113 }
114
116 {
117 if( this == &aItemData )
118 return *this;
119
120 m_sheetPath = aItemData.m_sheetPath;
121 m_item = aItemData.m_item;
122
123 return *this;
124 }
125
126private:
129};
130
131
136{
137public:
138 SCH_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent );
139 ~SCH_EDIT_FRAME() override;
140
141 SCH_SCREEN* GetScreen() const override;
142
143 SELECTION& GetCurrentSelection() override;
144
145 SCHEMATIC& Schematic() const;
146
147 std::unique_ptr<GRID_HELPER> MakeGridHelper() override;
148
152 bool GetShowAllPins() const override;
153
157 void SaveProjectLocalSettings() override;
158
164 bool LoadProjectSettings();
165
169 void LoadDrawingSheet();
170
171 void ShowSchematicSetupDialog( const wxString& aInitialPage = wxEmptyString );
172
173 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
174 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
175
176 void CreateScreens();
177 void ReCreateHToolbar() override;
178 void ReCreateVToolbar() override;
179 void ReCreateOptToolbar() override;
180
181 void setupUIConditions() override;
182
188 bool IsContentModified() const override;
189
194 void OnModify() override;
195
196 SEVERITY GetSeverity( int aErrorCode ) const override;
197
201 wxString GetScreenDesc() const override;
202 wxString GetFullScreenDesc() const override;
203
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 );
245
252
258
259 void ShowFindReplaceStatus( const wxString& aMsg, int aStatusTime );
261
265 void OnFindDialogClose();
266
271
280 void BreakSegment( SCH_COMMIT* aCommit, SCH_LINE* aSegment, const VECTOR2I& aPoint,
281 SCH_LINE** aNewSegment, SCH_SCREEN* aScreen );
282
291 bool BreakSegments( SCH_COMMIT* aCommit, const VECTOR2I& aPoint, SCH_SCREEN* aScreen );
292
300 bool BreakSegmentsOnJunctions( SCH_COMMIT* aCommit, SCH_SCREEN* aScreen );
301
306 void TestDanglingEnds();
307
317 void SendSelectItemsToPcb( const std::vector<EDA_ITEM*>& aItems, bool aForce );
318
324 void SendCrossProbeNetName( const wxString& aNetName );
325
331 void SetCrossProbeConnection( const SCH_CONNECTION* aConnection );
332
337
338 const wxString& GetHighlightedConnection() const
339 {
340 return m_highlightedConn;
341 }
342
343 void SetHighlightedConnection( const wxString& aConnection,
344 const NET_NAVIGATOR_ITEM_DATA* aSelection = nullptr );
345
354 bool ReadyToNetlist( const wxString& aAnnotateMessage );
355
371 bool WriteNetListFile( int aFormat, const wxString& aFullFileName, unsigned aNetlistOptions,
372 REPORTER* aReporter = nullptr );
373
381 void DeleteAnnotation( ANNOTATE_SCOPE_T aAnnotateScope, bool aRecursive, REPORTER& aReporter );
382
405 void AnnotateSymbols( SCH_COMMIT* aCommit, ANNOTATE_SCOPE_T aAnnotateScope,
406 ANNOTATE_ORDER_T aSortOption, ANNOTATE_ALGO_T aAlgoOption,
407 bool aRecursive, int aStartNumber, bool aResetAnnotation,
408 bool aRepairTimestamps, REPORTER& aReporter );
409
426 int CheckAnnotate( ANNOTATION_ERROR_HANDLER aErrorHandler,
427 ANNOTATE_SCOPE_T aAnnotateScope = ANNOTATE_ALL,
428 bool aRecursive = true );
429
436 int ModalAnnotate( const wxString& aMessage );
437
438 // Functions used for hierarchy handling
440
441 void SetCurrentSheet( const SCH_SHEET_PATH& aSheet );
442
443 void UpdateItem( EDA_ITEM* aItem, bool isAddOrDelete = false,
444 bool aUpdateRtree = false ) override;
445
449 void HardRedraw() override;
450
454 void DisplayCurrentSheet();
455
460
467 void OnPageSettingsChange() override;
468
475
476 wxPageSetupDialogData& GetPageSetupData() { return m_pageSetupData; }
477
478 void NewProject();
479 void LoadProject();
480
488 bool SaveProject( bool aSaveAs = false );
489
490 bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl = 0 ) override;
491
492 wxString GetCurrentFileName() const override;
493
501 bool AskToSaveChanges();
502
503 SCH_JUNCTION* AddJunction( SCH_COMMIT* aCommit, SCH_SCREEN* aScreen, const VECTOR2I& aPos );
504
511 void SchematicCleanUp( SCH_COMMIT* aCommit, SCH_SCREEN* aScreen = nullptr );
512
521 bool TrimWire( SCH_COMMIT* aCommit, const VECTOR2I& aStart, const VECTOR2I& aEnd );
522
523 void OnOpenPcbnew();
524 void OnOpenCvpcb();
525 void OnUpdatePCB();
526 void OnAnnotate();
527
535 bool CheckSheetForRecursion( SCH_SHEET* aSheet, SCH_SHEET_PATH* aCurrentSheet );
536
548 bool AllowCaseSensitiveFileNameClashes( const wxString& aOldName, const wxString& aSchematicFileName );
549
582 bool EditSheetProperties( SCH_SHEET* aSheet, SCH_SHEET_PATH* aHierarchy,
583 bool* aIsUndoable = nullptr, bool* aClearAnnotationNewItems = nullptr,
584 bool* aUpdateHierarchyNavigator = nullptr );
585
586 void InitSheet( SCH_SHEET* aSheet, const wxString& aNewFilename );
587
636 bool LoadSheetFromFile( SCH_SHEET* aSheet, SCH_SHEET_PATH* aCurrentSheet,
637 const wxString& aFileName, bool aSkipRecursionCheck = false,
638 bool aSkipLibCheck = false );
639
645 void DeleteJunction( SCH_COMMIT* aCommit, SCH_ITEM* aItem );
646
647 void FlipBodyStyle( SCH_SYMBOL* aSymbol );
648
649 void SelectUnit( SCH_SYMBOL* aSymbol, int aUnit );
650
651 void SetAltPinFunction( SCH_PIN* aPin, const wxString& aFunction );
652
653 /* Undo - redo */
654
671 void SaveCopyInUndoList( SCH_SCREEN* aScreen, SCH_ITEM* aItemToCopy, UNDO_REDO aTypeCommand,
672 bool aAppend, bool aDirtyConnectivity = true );
673
682 void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList, UNDO_REDO aTypeCommand,
683 bool aAppend, bool aDirtyConnectivity = true );
684
691
703 void ClearUndoORRedoList( UNDO_REDO_LIST whichList, int aItemCount = -1 ) override;
704
708 void SaveCopyForRepeatItem( const SCH_ITEM* aItem );
709 void AddCopyForRepeatItem( const SCH_ITEM* aItem );
710
715 const std::vector<std::unique_ptr<SCH_ITEM>>& GetRepeatItems() const
716 {
717 return m_items_to_repeat;
718 }
719
725 {
726 m_items_to_repeat.clear();
727 }
728
729 EDA_ITEM* GetItem( const KIID& aId ) const override;
730
736
743 bool CreateArchiveLibrary( const wxString& aFileName );
744
756 wxString CreateNewDesignBlockLibrary( const wxString& aLibName = wxEmptyString,
757 const wxString& aProposedName = wxEmptyString );
758
765 bool AddDesignBlockLibrary( const wxString& aFilename, DESIGN_BLOCK_LIB_TABLE* aTable );
766
767 void SaveSheetAsDesignBlock( const wxString& aLibraryName, SCH_SHEET_PATH& aSheetPath );
768
769 void SaveSelectionAsDesignBlock( const wxString& aLibraryName );
770
771 bool DeleteDesignBlockLibrary( const wxString& aLibName, bool aConfirm );
772
773 bool DeleteDesignBlockFromLibrary( const LIB_ID& aLibId, bool aConfirm );
774
775 bool EditDesignBlockProperties( const LIB_ID& aLibId );
776
777
787 DESIGN_BLOCK* GetDesignBlock( const LIB_ID& aLibId, bool aUseCacheLib = false,
788 bool aShowErrorMsg = false );
789
791
795 virtual void PrintPage( const RENDER_SETTINGS* aSettings ) override;
796
797 void SetNetListerCommand( const wxString& aCommand ) { m_netListerCommand = aCommand; }
798
802 void DefaultExecFlags() { m_exec_flags = wxEXEC_SYNC; }
803
809 void SetExecFlags( const int aFlags ) { m_exec_flags |= aFlags; }
810
817 void ClearExecFlags( const int aFlags ) { m_exec_flags &= ~( aFlags ); }
818
819 wxString GetNetListerCommand() const { return m_netListerCommand; }
820
824 void RecalculateConnections( SCH_COMMIT* aCommit, SCH_CLEANUP_FLAGS aCleanupFlags );
825
829 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
830
832
833 void ShowChangedLanguage() override;
834
835 void SetScreen( BASE_SCREEN* aScreen ) override;
836
837 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
838
840
841 void FocusOnItem( SCH_ITEM* aItem );
842
844
853 void SaveSymbolToSchematic( const LIB_SYMBOL& aSymbol, const KIID& aSchematicSymbolUUID );
854
860
861 void ShowAllIntersheetRefs( bool aShow );
862
869 virtual void CheckForAutoSaveFile( const wxFileName& aFileName ) override;
870
871 virtual void DeleteAutoSaveFile( const wxFileName& aFileName ) override;
872
877
881 void ToggleSearch();
882
883 void ToggleProperties() override;
884
885 void ToggleLibraryTree() override;
886
888
890
892
893 wxTreeCtrl* GetNetNavigator() { return m_netNavigator; }
894
896
900 static const wxString SchematicHierarchyPaneName()
901 {
902 return wxT( "SchematicHierarchy" );
903 }
904
908 static const wxString SearchPaneName() { return wxT( "Search" ); }
909
919 void AddSchematicChangeListener( wxEvtHandler* aListener );
920
924 void RemoveSchematicChangeListener( wxEvtHandler* aListener );
925
926 static const wxString NetNavigatorPaneName()
927 {
928 return wxS( "NetNavigator" );
929 }
930
931 void RefreshNetNavigator( const NET_NAVIGATOR_ITEM_DATA* aSelection = nullptr );
932
933 void MakeNetNavigatorNode( const wxString& aNetName, wxTreeItemId aParentId,
934 const NET_NAVIGATOR_ITEM_DATA* aSelection,
935 bool aSingleSheetSchematic );
936
937 void SelectNetNavigatorItem( const NET_NAVIGATOR_ITEM_DATA* aSelection = nullptr );
938
939 void ToggleNetNavigator();
940
942 {
943 return PLUGIN_ACTION_SCOPE::SCHEMATIC;
944 }
945
946 DECLARE_EVENT_TABLE()
947
948protected:
954 bool doAutoSave() override;
955
956 void doReCreateMenuBar() override;
957
961 void sendNetlistToCvpcb();
962
963 void onSize( wxSizeEvent& aEvent );
964
965 void saveProjectSettings() override;
966
967 void onCloseSymbolDiffDialog( wxCommandEvent& aEvent );
968
969 void onCloseErcDialog( wxCommandEvent& aEvent );
970
971 void onCloseSymbolFieldsTableDialog( wxCommandEvent& aEvent );
972
973 void unitsChangeRefresh() override;
974
975 void updateSelectionFilterVisbility() override;
976
977#ifdef KICAD_IPC_API
978 void onPluginAvailabilityChanged( wxCommandEvent& aEvt );
979#endif
980
986 DESIGN_BLOCK_LIB_TABLE* selectDesignBlockLibTable( bool aOptional = false );
987
992 wxString createNewDesignBlockLibrary( const wxString& aLibName, const wxString& aProposedName,
993 DESIGN_BLOCK_LIB_TABLE* aTable );
994
995private:
996 // Called when resizing the Hierarchy Navigator panel
997 void OnResizeHierarchyNavigator( wxSizeEvent& aEvent );
998
999 void onResizeNetNavigator( wxSizeEvent& aEvent );
1000
1001 // Sets up the tool framework
1002 void setupTools();
1003
1004 void OnExit( wxCommandEvent& event );
1005
1006 void OnLoadFile( wxCommandEvent& event );
1007 void OnImportProject( wxCommandEvent& event );
1008
1009 void OnClearFileHistory( wxCommandEvent& aEvent );
1010
1011 bool canCloseWindow( wxCloseEvent& aCloseEvent ) override;
1012 void doCloseWindow() override;
1013
1022 void updateTitle();
1023
1027 void initScreenZoom();
1028
1038
1045 bool importFile( const wxString& aFileName, int aFileType,
1046 const std::map<std::string, UTF8>* aProperties = nullptr );
1047
1055 bool saveSchematicFile( SCH_SHEET* aSheet, const wxString& aSavePath );
1056
1062 void mapExistingAnnotation( std::map<wxString, wxString>& aMap );
1063
1064 bool updateAutoSaveFile();
1065
1066 const wxString& getAutoSaveFileName() const;
1067
1068 wxTreeCtrl* createHighlightedNetNavigator();
1069
1070 void onNetNavigatorSelection( wxTreeEvent& aEvent );
1071
1072 void onNetNavigatorSelChanging( wxTreeEvent& aEvent );
1073
1075
1076private:
1077 // The schematic editor control class should be able to access some internal
1078 // functions of the editor frame.
1081
1084
1085 wxPageSetupDialogData m_pageSetupData;
1086 std::vector<std::unique_ptr<SCH_ITEM>> m_items_to_repeat;
1087
1092
1098
1099
1100 wxTreeCtrl* m_netNavigator;
1101
1102 bool m_syncingPcbToSchSelection; // Recursion guard when synchronizing selection from PCB
1103
1105
1107
1108 std::vector<wxEvtHandler*> m_schematicChangeListeners;
1109
1110 std::vector<LIB_ID> m_designBlockHistoryList;
1111
1113
1114#ifdef KICAD_IPC_API
1115 std::unique_ptr<API_HANDLER_SCH> m_apiHandler;
1116#endif
1117};
1118
1119
1120#endif // SCH_EDIT_FRAME_H
PLUGIN_ACTION_SCOPE
Definition: api_plugin.h:55
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
Specifies whether we are interacting with the undo or redo stacks.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:89
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
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:284
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:78
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:72
Holds all the data relating to one schematic.
Definition: schematic.h:77
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 operaintg 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:699
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.
bool EditSheetProperties(SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy, bool *aIsUndoable=nullptr, bool *aClearAnnotationNewItems=nullptr, bool *aUpdateHierarchyNavigator=nullptr)
Edit an existing sheet or add a new sheet to the schematic.
Definition: sheet.cpp:599
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:107
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 UpdateHierarchyNavigator(bool aRefreshNetNavigator=true)
Update the hierarchy navigation tree and history.
void onSize(wxSizeEvent &aEvent)
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:166
void SetAltPinFunction(SCH_PIN *aPin, const wxString &aFunction)
Definition: picksymbol.cpp:215
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.
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 CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Called after the preferences dialog is run.
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 ReCreateVToolbar() override
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 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:619
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)
Prompts a 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:85
DIALOG_ERC * GetErcDialog()
void sendNetlistToCvpcb()
Send the KiCad netlist over to CVPCB.
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 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:176
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
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
Returns bbox 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:51
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 ReCreateOptToolbar() override
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.
virtual void PrintPage(const RENDER_SETTINGS *aSettings) override
Plot or print the current sheet to the clipboard.
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
Saves any design-related project settings associated with this frame.
void OnExit(wxCommandEvent &event)
void DeleteJunction(SCH_COMMIT *aCommit, SCH_ITEM *aItem)
Removes 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 ReCreateHToolbar() override
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.
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:51
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:166
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:57
Schematic symbol object.
Definition: sch_symbol.h:104
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...