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;
61class DIALOG_ERC;
63class DIALOG_SCH_FIND;
64class RESCUER;
65class HIERARCHY_PANE;
66class API_HANDLER_SCH;
69
70
73{
76};
77
78
79wxDECLARE_EVENT( EDA_EVT_SCHEMATIC_CHANGING, wxCommandEvent );
80wxDECLARE_EVENT( EDA_EVT_SCHEMATIC_CHANGED, wxCommandEvent );
81
82
86class NET_NAVIGATOR_ITEM_DATA : public wxTreeItemData
87{
88public:
89 NET_NAVIGATOR_ITEM_DATA( const SCH_SHEET_PATH& aSheetPath, const SCH_ITEM* aItem ) :
90 m_sheetPath( aSheetPath ),
91 m_item( aItem )
92 {
93 }
94
96 m_item( nullptr )
97 {
98 }
99
101 const SCH_ITEM* GetItem() const { return m_item; }
102
103 bool operator==( const NET_NAVIGATOR_ITEM_DATA& aRhs ) const
104 {
105 return ( m_sheetPath == aRhs.m_sheetPath ) && ( m_item == aRhs.m_item );
106 }
107
109 {
110 if( this == &aItemData )
111 return *this;
112
113 m_sheetPath = aItemData.m_sheetPath;
114 m_item = aItemData.m_item;
115
116 return *this;
117 }
118
119private:
122};
123
124
129{
130public:
131 SCH_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent );
132 ~SCH_EDIT_FRAME() override;
133
134 SCH_SCREEN* GetScreen() const override;
135
136 SELECTION& GetCurrentSelection() override;
137
138 SCHEMATIC& Schematic() const;
139
140 std::unique_ptr<GRID_HELPER> MakeGridHelper() override;
141
145 bool GetShowAllPins() const override;
146
150 void SaveProjectLocalSettings() override;
151
157 bool LoadProjectSettings();
158
162 void LoadDrawingSheet();
163
164 void ShowSchematicSetupDialog( const wxString& aInitialPage = wxEmptyString );
165
166 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
167 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
168
169 void CreateScreens();
170
171 void setupUIConditions() override;
172
178 bool IsContentModified() const override;
179
184 void OnModify() override;
185
186 SEVERITY GetSeverity( int aErrorCode ) const override;
187
191 wxString GetScreenDesc() const override;
192 wxString GetFullScreenDesc() const override;
193
214 void ExecuteRemoteCommand( const char* cmdline ) override;
215
216 void KiwayMailIn( KIWAY_EXPRESS& aEvent ) override;
217
222
226 void AutoRotateItem( SCH_SCREEN* aScreen, SCH_ITEM* aItem );
227
231 void ShowFindReplaceDialog( bool aReplace );
232
236 void UpdateHierarchyNavigator( bool aRefreshNetNavigator = true, bool aClear = false );
237
245
251
252 void ShowFindReplaceStatus( const wxString& aMsg, int aStatusTime );
254
258 void OnFindDialogClose();
259
264
270 void TestDanglingEnds();
271
281 void SendSelectItemsToPcb( const std::vector<EDA_ITEM*>& aItems, bool aForce );
282
288 void SendCrossProbeNetName( const wxString& aNetName );
289
295 void SetCrossProbeConnection( const SCH_CONNECTION* aConnection );
296
301
302 const wxString& GetHighlightedConnection() const
303 {
304 return m_highlightedConn;
305 }
306
307 void SetHighlightedConnection( const wxString& aConnection,
308 const NET_NAVIGATOR_ITEM_DATA* aSelection = nullptr );
309
318 bool ReadyToNetlist( const wxString& aAnnotateMessage );
319
335 bool WriteNetListFile( int aFormat, const wxString& aFullFileName, unsigned aNetlistOptions,
336 REPORTER* aReporter = nullptr );
337
345 void DeleteAnnotation( ANNOTATE_SCOPE_T aAnnotateScope, bool aRecursive, REPORTER& aReporter );
346
371 void AnnotateSymbols( SCH_COMMIT* aCommit, ANNOTATE_SCOPE_T aAnnotateScope,
372 ANNOTATE_ORDER_T aSortOption, ANNOTATE_ALGO_T aAlgoOption,
373 bool aRecursive, int aStartNumber, bool aResetAnnotation,
374 bool aRepairTimestamps, REPORTER& aReporter );
375
392 int CheckAnnotate( ANNOTATION_ERROR_HANDLER aErrorHandler,
393 ANNOTATE_SCOPE_T aAnnotateScope = ANNOTATE_ALL,
394 bool aRecursive = true );
395
402 int ModalAnnotate( const wxString& aMessage );
403
404 // Functions used for hierarchy handling
406
407 void SetCurrentSheet( const SCH_SHEET_PATH& aSheet );
408
409 void UpdateItem( EDA_ITEM* aItem, bool isAddOrDelete = false,
410 bool aUpdateRtree = false ) override;
411
417 void HardRedraw() override;
418
422 void DisplayCurrentSheet();
423
428
435 void OnPageSettingsChange() override;
436
443
444 wxPageSetupDialogData& GetPageSetupData() { return m_pageSetupData; }
445
446 void NewProject();
447 void LoadProject();
448
456 bool SaveProject( bool aSaveAs = false );
457
458 bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl = 0 ) override;
459
460 wxString GetCurrentFileName() const override;
461
469 bool AskToSaveChanges();
470
471 SCH_JUNCTION* AddJunction( SCH_COMMIT* aCommit, SCH_SCREEN* aScreen, const VECTOR2I& aPos );
472
482 bool TrimWire( SCH_COMMIT* aCommit, const VECTOR2I& aStart, const VECTOR2I& aEnd );
483
484 void OnOpenPcbnew();
485 void OnOpenCvpcb();
486 void OnUpdatePCB();
487 void OnAnnotate();
488
496 bool CheckSheetForRecursion( SCH_SHEET* aSheet, SCH_SHEET_PATH* aCurrentSheet );
497
509 bool AllowCaseSensitiveFileNameClashes( const wxString& aOldName,
510 const wxString& aSchematicFileName );
511
545 bool EditSheetProperties( SCH_SHEET* aSheet, SCH_SHEET_PATH* aHierarchy,
546 bool* aIsUndoable = nullptr, bool* aClearAnnotationNewItems = nullptr,
547 bool* aUpdateHierarchyNavigator = nullptr,
548 wxString* aSourceSheetFilename = nullptr );
549
550 void InitSheet( SCH_SHEET* aSheet, const wxString& aNewFilename );
551
602 bool LoadSheetFromFile( SCH_SHEET* aSheet, SCH_SHEET_PATH* aCurrentSheet,
603 const wxString& aFileName, bool aSkipRecursionCheck = false,
604 bool aSkipLibCheck = false );
605
611 void DeleteJunction( SCH_COMMIT* aCommit, SCH_ITEM* aItem );
612
613 void UpdateHopOveredWires( SCH_ITEM* aItem );
614
615 void FlipBodyStyle( SCH_SYMBOL* aSymbol );
616
617 void SelectUnit( SCH_SYMBOL* aSymbol, int aUnit );
618
619 void SetAltPinFunction( SCH_PIN* aPin, const wxString& aFunction );
620
621 /* Undo - redo */
622
639 void SaveCopyInUndoList( SCH_SCREEN* aScreen, SCH_ITEM* aItemToCopy, UNDO_REDO aTypeCommand,
640 bool aAppend, bool aDirtyConnectivity = true );
641
650 void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList, UNDO_REDO aTypeCommand,
651 bool aAppend, bool aDirtyConnectivity = true );
652
659
671 void ClearUndoORRedoList( UNDO_REDO_LIST whichList, int aItemCount = -1 ) override;
672
676 void SaveCopyForRepeatItem( const SCH_ITEM* aItem );
677 void AddCopyForRepeatItem( const SCH_ITEM* aItem );
678
684 const std::vector<std::unique_ptr<SCH_ITEM>>& GetRepeatItems() const
685 {
686 return m_items_to_repeat;
687 }
688
695 {
696 m_items_to_repeat.clear();
697 }
698
699 EDA_ITEM* ResolveItem( const KIID& aId, bool aAllowNullptrReturn = false ) const override;
700
707
714 bool CreateArchiveLibrary( const wxString& aFileName );
715
716 bool SaveSheetAsDesignBlock( const wxString& aLibraryName, SCH_SHEET_PATH& aSheetPath );
717
718 bool SaveSelectionAsDesignBlock( const wxString& aLibraryName );
719
720 bool SaveSheetToDesignBlock( const LIB_ID& aLibId, SCH_SHEET_PATH& aSheetPath );
721
722 bool SaveSelectionToDesignBlock( const LIB_ID& aLibId );
723
725
726 void SetNetListerCommand( const wxString& aCommand ) { m_netListerCommand = aCommand; }
727
731 void DefaultExecFlags() { m_exec_flags = wxEXEC_SYNC; }
732
738 void SetExecFlags( const int aFlags ) { m_exec_flags |= aFlags; }
739
746 void ClearExecFlags( const int aFlags ) { m_exec_flags &= ~( aFlags ); }
747
748 wxString GetNetListerCommand() const { return m_netListerCommand; }
749
753 void RecalculateConnections( SCH_COMMIT* aCommit, SCH_CLEANUP_FLAGS aCleanupFlags,
754 PROGRESS_REPORTER* aProgressReporter = nullptr );
755
759 void CommonSettingsChanged( int aFlags ) override;
760
762
763 void ShowChangedLanguage() override;
764
765 void SetScreen( BASE_SCREEN* aScreen ) override;
766
767 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
768
771
772 void FocusOnItem( EDA_ITEM* aItem ) override;
773
775
784 void SaveSymbolToSchematic( const LIB_SYMBOL& aSymbol, const KIID& aSchematicSymbolUUID );
785
791
795 void IntersheetRefUpdate( SCH_GLOBALLABEL* aItem ) override;
796
797 void ShowAllIntersheetRefs( bool aShow );
798
805 virtual void CheckForAutoSaveFile( const wxFileName& aFileName ) override;
806
807 virtual void DeleteAutoSaveFile( const wxFileName& aFileName ) override;
808
813
817 void ToggleSearch();
818
819 void ToggleProperties() override;
820
821 void ToggleLibraryTree() override;
822
824
826
828
829 wxTreeCtrl* GetNetNavigator() { return m_netNavigator; }
830
832
836 static const wxString SchematicHierarchyPaneName()
837 {
838 return wxT( "SchematicHierarchy" );
839 }
840
844 static const wxString SearchPaneName() { return wxT( "Search" ); }
845
846 bool IsSearchPaneShown() { return m_auimgr.GetPane( SearchPaneName() ).IsShown(); }
847
848 void FocusSearch();
849
859 void AddSchematicChangeListener( wxEvtHandler* aListener );
860
864 void RemoveSchematicChangeListener( wxEvtHandler* aListener );
865
866 static const wxString NetNavigatorPaneName()
867 {
868 return wxS( "NetNavigator" );
869 }
870
871 void RefreshNetNavigator( const NET_NAVIGATOR_ITEM_DATA* aSelection = nullptr );
872
873 void MakeNetNavigatorNode( const wxString& aNetName, wxTreeItemId aParentId,
874 const NET_NAVIGATOR_ITEM_DATA* aSelection,
875 bool aSingleSheetSchematic );
876
877 void SelectNetNavigatorItem( const NET_NAVIGATOR_ITEM_DATA* aSelection = nullptr );
878
879 const SCH_ITEM* SelectNextPrevNetNavigatorItem( bool aNext );
880
881 void ToggleNetNavigator();
882
884 {
885 return PLUGIN_ACTION_SCOPE::SCHEMATIC;
886 }
887
888 DECLARE_EVENT_TABLE()
889
890protected:
896 bool doAutoSave() override;
897
898 void configureToolbars() override;
899
900 void doReCreateMenuBar() override;
901
905 void sendNetlistToCvpcb();
906
907 void onSize( wxSizeEvent& aEvent );
908
909 void saveProjectSettings() override;
910
911 void onCloseSymbolDiffDialog( wxCommandEvent& aEvent );
912
913 void onCloseErcDialog( wxCommandEvent& aEvent );
914
915 void onCloseSymbolFieldsTableDialog( wxCommandEvent& aEvent );
916
917 void unitsChangeRefresh() override;
918
919 void updateSelectionFilterVisbility() override;
920
921#ifdef KICAD_IPC_API
922 void onPluginAvailabilityChanged( wxCommandEvent& aEvt );
923#endif
924
925private:
926 // Called when resizing the Hierarchy Navigator panel
927 void OnResizeHierarchyNavigator( wxSizeEvent& aEvent );
928
929 void onResizeNetNavigator( wxSizeEvent& aEvent );
930
931 // Sets up the tool framework
932 void setupTools();
933
934 void OnExit( wxCommandEvent& event );
935
936 void OnLoadFile( wxCommandEvent& event );
937 void OnImportProject( wxCommandEvent& event );
938
939 void OnClearFileHistory( wxCommandEvent& aEvent );
940
941 bool canCloseWindow( wxCloseEvent& aCloseEvent ) override;
942 void doCloseWindow() override;
943
952 void updateTitle();
953
957 void initScreenZoom();
958
968
975 bool importFile( const wxString& aFileName, int aFileType,
976 const std::map<std::string, UTF8>* aProperties = nullptr );
977
985 bool saveSchematicFile( SCH_SHEET* aSheet, const wxString& aSavePath );
986
992 void mapExistingAnnotation( std::map<wxString, wxString>& aMap );
993
994 bool updateAutoSaveFile();
995
996 const wxString& getAutoSaveFileName() const;
997
998 wxTreeCtrl* createHighlightedNetNavigator();
999
1000 void onNetNavigatorSelection( wxTreeEvent& aEvent );
1001
1002 void onNetNavigatorSelChanging( wxTreeEvent& aEvent );
1003
1005
1006private:
1007 // The schematic editor control class should be able to access some internal
1008 // functions of the editor frame.
1011
1014
1015 wxPageSetupDialogData m_pageSetupData;
1016 std::vector<std::unique_ptr<SCH_ITEM>> m_items_to_repeat;
1017
1022
1029
1030
1031 wxTreeCtrl* m_netNavigator;
1032
1033 bool m_syncingPcbToSchSelection; // Recursion guard when synchronizing selection from PCB
1034
1036
1038
1039 std::vector<wxEvtHandler*> m_schematicChangeListeners;
1040
1041 std::vector<LIB_ID> m_designBlockHistoryList;
1042
1044
1045#ifdef KICAD_IPC_API
1046 std::unique_ptr<API_HANDLER_SCH> m_apiHandler;
1047#endif
1048};
1049
1050
1051#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:108
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:97
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 progress reporter interface for use in multi-threaded environments.
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:87
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()
bool SaveSheetToDesignBlock(const LIB_ID &aLibId, SCH_SHEET_PATH &aSheetPath)
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
SCH_DESIGN_BLOCK_PANE * GetDesignBlockPane() const
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
void mapExistingAnnotation(std::map< wxString, wxString > &aMap)
Fill a map of uuid -> reference from the currently loaded schematic.
Definition: annotate.cpp:39
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
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:720
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
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 SaveSelectionToDesignBlock(const LIB_ID &aLibId)
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 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.
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 RecalculateConnections(SCH_COMMIT *aCommit, SCH_CLEANUP_FLAGS aCleanupFlags, PROGRESS_REPORTER *aProgressReporter=nullptr)
Generate the connection data for the entire schematic hierarchy.
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:622
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()
bool canCloseWindow(wxCloseEvent &aCloseEvent) override
wxTreeCtrl * GetNetNavigator()
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:601
SCH_DESIGN_BLOCK_PANE * m_designBlocksPane
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.
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.
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 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)
double GetSchematicHopOverScale()
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.
EDA_ITEM * ResolveItem(const KIID &aId, bool aAllowNullptrReturn=false) const override
Fetch an item by KIID.
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)
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
void SelectNetNavigatorItem(const NET_NAVIGATOR_ITEM_DATA *aSelection=nullptr)
void AddCopyForRepeatItem(const SCH_ITEM *aItem)
DIALOG_SYMBOL_FIELDS_TABLE * GetSymbolFieldsTableDialog()
void OnResizeHierarchyNavigator(wxSizeEvent &aEvent)
bool SaveSheetAsDesignBlock(const wxString &aLibraryName, SCH_SHEET_PATH &aSheetPath)
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)
bool SaveSelectionAsDesignBlock(const wxString &aLibraryName)
wxTreeCtrl * createHighlightedNetNavigator()
void TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
bool SaveProject(bool aSaveAs=false)
Save the currently-open schematic (including its hierarchy) and associated project.
void IntersheetRefUpdate(SCH_GLOBALLABEL *aItem) override
Callback from schematic ref update.
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
void UpdateHopOveredWires(SCH_ITEM *aItem)
SEVERITY GetSeverity(int aErrorCode) const override
void FocusOnItem(EDA_ITEM *aItem) override
Focus on a particular canvas item.
void onNetNavigatorSelection(wxTreeEvent &aEvent)
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:168
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:42
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
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.
SCH_CLEANUP_FLAGS
Definition: schematic.h:73
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...