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;
60class DIALOG_ERC;
62class DIALOG_SCH_FIND;
63class RESCUER;
64class HIERARCHY_PANE;
65class API_HANDLER_SCH;
66
67
70{
73};
74
75
77{
81};
82
83
84wxDECLARE_EVENT( EDA_EVT_SCHEMATIC_CHANGING, wxCommandEvent );
85wxDECLARE_EVENT( EDA_EVT_SCHEMATIC_CHANGED, wxCommandEvent );
86
87
91class NET_NAVIGATOR_ITEM_DATA : public wxTreeItemData
92{
93public:
94 NET_NAVIGATOR_ITEM_DATA( const SCH_SHEET_PATH& aSheetPath, const SCH_ITEM* aItem ) :
95 m_sheetPath( aSheetPath ),
96 m_item( aItem )
97 {
98 }
99
101 m_item( nullptr )
102 {
103 }
104
106 const SCH_ITEM* GetItem() const { return m_item; }
107
108 bool operator==( const NET_NAVIGATOR_ITEM_DATA& aRhs ) const
109 {
110 return ( m_sheetPath == aRhs.m_sheetPath ) && ( m_item == aRhs.m_item );
111 }
112
114 {
115 if( this == &aItemData )
116 return *this;
117
118 m_sheetPath = aItemData.m_sheetPath;
119 m_item = aItemData.m_item;
120
121 return *this;
122 }
123
124private:
127};
128
129
134{
135public:
136 SCH_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent );
137 ~SCH_EDIT_FRAME() override;
138
139 SCH_SCREEN* GetScreen() const override;
140
141 SELECTION& GetCurrentSelection() override;
142
143 SCHEMATIC& Schematic() const;
144
148 bool GetShowAllPins() const override;
149
153 void SaveProjectLocalSettings() override;
154
160 bool LoadProjectSettings();
161
162 void ShowSchematicSetupDialog( const wxString& aInitialPage = wxEmptyString );
163
164 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
165 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
166
167 void CreateScreens();
168 void ReCreateHToolbar() override;
169 void ReCreateVToolbar() override;
170 void ReCreateOptToolbar() override;
171
172 void setupUIConditions() override;
173
179 bool IsContentModified() const override;
180
185 void OnModify() override;
186
187 SEVERITY GetSeverity( int aErrorCode ) const override;
188
192 wxString GetScreenDesc() const override;
193 wxString GetFullScreenDesc() const override;
194
213 void ExecuteRemoteCommand( const char* cmdline ) override;
214
215 void KiwayMailIn( KIWAY_EXPRESS& aEvent ) override;
216
221
225 void AutoRotateItem( SCH_SCREEN* aScreen, SCH_ITEM* aItem );
226
230 void ShowFindReplaceDialog( bool aReplace );
231
235 void UpdateHierarchyNavigator( bool aRefreshNetNavigator = true );
236
243
249
250 void ShowFindReplaceStatus( const wxString& aMsg, int aStatusTime );
252
256 void OnFindDialogClose();
257
266 void BreakSegment( SCH_COMMIT* aCommit, SCH_LINE* aSegment, const VECTOR2I& aPoint,
267 SCH_LINE** aNewSegment, SCH_SCREEN* aScreen );
268
277 bool BreakSegments( SCH_COMMIT* aCommit, const VECTOR2I& aPoint, SCH_SCREEN* aScreen );
278
286 bool BreakSegmentsOnJunctions( SCH_COMMIT* aCommit, SCH_SCREEN* aScreen );
287
292 void TestDanglingEnds();
293
303 void SendSelectItemsToPcb( const std::vector<EDA_ITEM*>& aItems, bool aForce );
304
310 void SendCrossProbeNetName( const wxString& aNetName );
311
317 void SetCrossProbeConnection( const SCH_CONNECTION* aConnection );
318
323
324 const wxString& GetHighlightedConnection() const
325 {
326 return m_highlightedConn;
327 }
328
329 void SetHighlightedConnection( const wxString& aConnection,
330 const NET_NAVIGATOR_ITEM_DATA* aSelection = nullptr );
331
340 bool ReadyToNetlist( const wxString& aAnnotateMessage );
341
357 bool WriteNetListFile( int aFormat, const wxString& aFullFileName, unsigned aNetlistOptions,
358 REPORTER* aReporter = nullptr );
359
365 void DeleteAnnotation( ANNOTATE_SCOPE_T aAnnotateScope, bool aRecursive );
366
389 void AnnotateSymbols( SCH_COMMIT* aCommit, ANNOTATE_SCOPE_T aAnnotateScope,
390 ANNOTATE_ORDER_T aSortOption, ANNOTATE_ALGO_T aAlgoOption,
391 bool aRecursive, int aStartNumber, bool aResetAnnotation,
392 bool aRepairTimestamps, REPORTER& aReporter );
393
410 int CheckAnnotate( ANNOTATION_ERROR_HANDLER aErrorHandler,
411 ANNOTATE_SCOPE_T aAnnotateScope = ANNOTATE_ALL,
412 bool aRecursive = true );
413
420 int ModalAnnotate( const wxString& aMessage );
421
422 // Functions used for hierarchy handling
424
425 void SetCurrentSheet( const SCH_SHEET_PATH& aSheet );
426
427 void UpdateItem( EDA_ITEM* aItem, bool isAddOrDelete = false,
428 bool aUpdateRtree = false ) override;
429
433 void HardRedraw() override;
434
438 void DisplayCurrentSheet();
439
444
451 void OnPageSettingsChange() override;
452
459
460 wxPageSetupDialogData& GetPageSetupData() { return m_pageSetupData; }
461
462 void NewProject();
463 void LoadProject();
464
472 bool SaveProject( bool aSaveAs = false );
473
474 bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl = 0 ) override;
475
476 wxString GetCurrentFileName() const override;
477
483 bool AppendSchematic();
484
493 bool AddSheetAndUpdateDisplay( const wxString aFullFileName );
494
502 bool AskToSaveChanges();
503
504 SCH_JUNCTION* AddJunction( SCH_COMMIT* aCommit, SCH_SCREEN* aScreen, const VECTOR2I& aPos );
505
512 void SchematicCleanUp( SCH_COMMIT* aCommit, SCH_SCREEN* aScreen = nullptr );
513
522 bool TrimWire( SCH_COMMIT* aCommit, const VECTOR2I& aStart, const VECTOR2I& aEnd );
523
524 void OnOpenPcbnew( wxCommandEvent& event );
525 void OnOpenCvpcb( wxCommandEvent& event );
526 void OnUpdatePCB( wxCommandEvent& event );
527 void OnAnnotate( wxCommandEvent& event );
528
536 bool CheckSheetForRecursion( SCH_SHEET* aSheet, SCH_SHEET_PATH* aCurrentSheet );
537
549 bool AllowCaseSensitiveFileNameClashes( const wxString& aOldName, const wxString& aSchematicFileName );
550
581 bool EditSheetProperties( SCH_SHEET* aSheet, SCH_SHEET_PATH* aHierarchy,
582 bool* aClearAnnotationNewItems,
583 bool* aUpdateHierarchyNavigator = nullptr );
584
585 void InitSheet( SCH_SHEET* aSheet, const wxString& aNewFilename );
586
631 bool LoadSheetFromFile( SCH_SHEET* aSheet, SCH_SHEET_PATH* aCurrentSheet,
632 const wxString& aFileName );
633
639 void DeleteJunction( SCH_COMMIT* aCommit, SCH_ITEM* aItem );
640
641 void FlipBodyStyle( SCH_SYMBOL* aSymbol );
642
643 void SelectUnit( SCH_SYMBOL* aSymbol, int aUnit );
644
645 void SetAltPinFunction( SCH_PIN* aPin, const wxString& aFunction );
646
647 /* Undo - redo */
648
665 void SaveCopyInUndoList( SCH_SCREEN* aScreen, SCH_ITEM* aItemToCopy, UNDO_REDO aTypeCommand,
666 bool aAppend, bool aDirtyConnectivity = true );
667
676 void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList, UNDO_REDO aTypeCommand,
677 bool aAppend, bool aDirtyConnectivity = true );
678
685
697 void ClearUndoORRedoList( UNDO_REDO_LIST whichList, int aItemCount = -1 ) override;
698
702 void SaveCopyForRepeatItem( const SCH_ITEM* aItem );
703 void AddCopyForRepeatItem( const SCH_ITEM* aItem );
704
709 const std::vector<std::unique_ptr<SCH_ITEM>>& GetRepeatItems() const
710 {
711 return m_items_to_repeat;
712 }
713
714 EDA_ITEM* GetItem( const KIID& aId ) const override;
715
721
728 bool CreateArchiveLibrary( const wxString& aFileName );
729
733 virtual void PrintPage( const RENDER_SETTINGS* aSettings ) override;
734
735 void SetNetListerCommand( const wxString& aCommand ) { m_netListerCommand = aCommand; }
736
740 void DefaultExecFlags() { m_exec_flags = wxEXEC_SYNC; }
741
747 void SetExecFlags( const int aFlags ) { m_exec_flags |= aFlags; }
748
755 void ClearExecFlags( const int aFlags ) { m_exec_flags &= ~( aFlags ); }
756
757 wxString GetNetListerCommand() const { return m_netListerCommand; }
758
762 void RecalculateConnections( SCH_COMMIT* aCommit, SCH_CLEANUP_FLAGS aCleanupFlags );
763
767 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
768
770
771 void ShowChangedLanguage() override;
772
773 void SetScreen( BASE_SCREEN* aScreen ) override;
774
775 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
776
778
779 void FocusOnItem( SCH_ITEM* aItem );
780
782
791 void SaveSymbolToSchematic( const LIB_SYMBOL& aSymbol, const KIID& aSchematicSymbolUUID );
792
798
799 void ShowAllIntersheetRefs( bool aShow );
800
807 virtual void CheckForAutoSaveFile( const wxFileName& aFileName ) override;
808
809 virtual void DeleteAutoSaveFile( const wxFileName& aFileName ) override;
810
815
819 void ToggleSearch();
820
821 void ToggleProperties() 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
855 void AddSchematicChangeListener( wxEvtHandler* aListener );
856
860 void RemoveSchematicChangeListener( wxEvtHandler* aListener );
861
862 static const wxString NetNavigatorPaneName()
863 {
864 return wxS( "NetNavigator" );
865 }
866
867 void RefreshNetNavigator( const NET_NAVIGATOR_ITEM_DATA* aSelection = nullptr );
868
869 void MakeNetNavigatorNode( const wxString& aNetName, wxTreeItemId aParentId,
870 const NET_NAVIGATOR_ITEM_DATA* aSelection = nullptr );
871
872 void SelectNetNavigatorItem( const NET_NAVIGATOR_ITEM_DATA* aSelection = nullptr );
873
874 void ToggleNetNavigator();
875
877 {
878 return PLUGIN_ACTION_SCOPE::SCHEMATIC;
879 }
880
881 DECLARE_EVENT_TABLE()
882
883protected:
889 bool doAutoSave() override;
890
891 void doReCreateMenuBar() override;
892
896 void sendNetlistToCvpcb();
897
898 void onSize( wxSizeEvent& aEvent );
899
900 void saveProjectSettings() override;
901
902 void onCloseSymbolDiffDialog( wxCommandEvent& aEvent );
903
904 void onCloseErcDialog( wxCommandEvent& aEvent );
905
906 void onCloseSymbolFieldsTableDialog( wxCommandEvent& aEvent );
907
908 void unitsChangeRefresh() override;
909
910 void updateSelectionFilterVisbility() override;
911
912private:
913 // Called when resizing the Hierarchy Navigator panel
914 void OnResizeHierarchyNavigator( wxSizeEvent& aEvent );
915
916 void onResizeNetNavigator( wxSizeEvent& aEvent );
917
918 // Sets up the tool framework
919 void setupTools();
920
921 void OnExit( wxCommandEvent& event );
922
923 void OnLoadFile( wxCommandEvent& event );
924 void OnAppendProject( wxCommandEvent& event );
925 void OnImportProject( wxCommandEvent& event );
926
927 void OnClearFileHistory( wxCommandEvent& aEvent );
928
929 bool canCloseWindow( wxCloseEvent& aCloseEvent ) override;
930 void doCloseWindow() override;
931
940 void updateTitle();
941
945 void initScreenZoom();
946
956
963 bool importFile( const wxString& aFileName, int aFileType,
964 const STRING_UTF8_MAP* aProperties = nullptr );
965
973 bool saveSchematicFile( SCH_SHEET* aSheet, const wxString& aSavePath );
974
980 void mapExistingAnnotation( std::map<wxString, wxString>& aMap );
981
982 bool updateAutoSaveFile();
983
984 const wxString& getAutoSaveFileName() const;
985
986 wxTreeCtrl* createHighlightedNetNavigator();
987
988 void onNetNavigatorSelection( wxTreeEvent& aEvent );
989
990 void onNetNavigatorSelChanging( wxTreeEvent& aEvent );
991
992private:
993 // The schematic editor control class should be able to access some internal
994 // functions of the editor frame.
995 friend class SCH_EDITOR_CONTROL;
997
1000
1001 wxPageSetupDialogData m_pageSetupData;
1002 std::vector<std::unique_ptr<SCH_ITEM>> m_items_to_repeat;
1003
1008
1014
1015
1016 wxTreeCtrl* m_netNavigator;
1017
1018 bool m_syncingPcbToSchSelection; // Recursion guard when synchronizing selection from PCB
1019
1021
1023
1024 std::vector<wxEvtHandler*> m_schematicChangeListeners;
1025
1026#ifdef KICAD_IPC_API
1027 std::unique_ptr<API_HANDLER_SCH> m_apiHandler;
1028#endif
1029};
1030
1031
1032#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:88
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:279
Define a library symbol object.
Definition: lib_symbol.h:77
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:71
Holds all the data relating to one schematic.
Definition: schematic.h:75
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:41
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 LoadSheetFromFile(SCH_SHEET *aSheet, SCH_SHEET_PATH *aCurrentSheet, const wxString &aFileName)
Load a the KiCad schematic file aFileName into the sheet aSheet.
Definition: sheet.cpp:166
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
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 OnOpenCvpcb(wxCommandEvent &event)
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:693
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 doCloseWindow() override
DIALOG_BOOK_REPORTER * m_diffSymbolDialog
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 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.
bool importFile(const wxString &aFileName, int aFileType, const STRING_UTF8_MAP *aProperties=nullptr)
Load the given filename but sets the path to the current project path.
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)
void SetAltPinFunction(SCH_PIN *aPin, const wxString &aFunction)
Definition: picksymbol.cpp:165
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.
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:193
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)
bool GetShowAllPins() const override
Allow edit frame to show/hide hidden pins.
void OnAppendProject(wxCommandEvent &event)
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:613
bool EditSheetProperties(SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy, bool *aClearAnnotationNewItems, bool *aUpdateHierarchyNavigator=nullptr)
Edit an existing sheet or add a new sheet to the schematic.
Definition: sheet.cpp:593
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()
void OnUpdatePCB(wxCommandEvent &event)
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 OnOpenPcbnew(wxCommandEvent &event)
void ToggleSchematicHierarchy()
Toggle the show/hide state of the left side schematic navigation panel.
void FlipBodyStyle(SCH_SYMBOL *aSymbol)
Definition: picksymbol.cpp:126
void OnAnnotate(wxCommandEvent &event)
void SendCrossProbeNetName(const wxString &aNetName)
Send a net name to Pcbnew for highlighting.
void DeleteAnnotation(ANNOTATE_SCOPE_T aAnnotateScope, bool aRecursive)
Clear the current symbol annotation.
Definition: annotate.cpp:61
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.
void OnPageSettingsChange() override
Called when modifying the page settings.
bool AddSheetAndUpdateDisplay(const wxString aFullFileName)
Add a sheet file into the current sheet and updates display.
void SelectUnit(SCH_SYMBOL *aSymbol, int aUnit)
Definition: picksymbol.cpp:93
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 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:441
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
bool AppendSchematic()
Import a KiCad schematic into the current sheet.
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)
wxString GetCurrentFileName() const override
Get the full filename + path of the currently opened file in the frame.
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.
bool SaveProject(bool aSaveAs=false)
Save the currently-open schematic (including its hierarchy) and associated project.
void saveProjectSettings() override
Saves any design-related project settings associated with this frame.
void OnExit(wxCommandEvent &event)
void MakeNetNavigatorNode(const wxString &aNetName, wxTreeItemId aParentId, const NET_NAVIGATOR_ITEM_DATA *aSelection=nullptr)
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
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:174
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:105
A name/value tuple with unique names and optional values.
Base window classes and related definitions.
STL namespace.
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...