KiCad PCB EDA Suite
Loading...
Searching...
No Matches
symbol_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) 2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
6 * Copyright (C) 2004-2024 KiCad Developers, see AUTHORS.txt for contributors.
7 * Copyright (C) 2017 CERN
8 * @author Maciej Suminski <[email protected]>
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, you may find one here:
22 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
23 * or you may search the http://www.gnu.org website for the version 2 license,
24 * or you may write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
26 */
27
28#ifndef SYMBOL_EDIT_FRAME_H
29#define SYMBOL_EDIT_FRAME_H
30
31#include <sch_base_frame.h>
32#include <sch_screen.h>
33#include <ee_collectors.h>
34#include <optional>
35
36class SCH_EDIT_FRAME;
38class LIB_SYMBOL;
40class LIB_TREE_NODE;
41class LIB_ID;
44class EDA_LIST_DIALOG;
45
46
51{
52public:
53 SYMBOL_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent );
54
55 ~SYMBOL_EDIT_FRAME() override;
56
60 void SwitchCanvas( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType ) override;
61
67 bool IsContentModified() const override;
68
77 bool HasLibModifications() const;
78
79 bool CanCloseSymbolFromSchematic( bool doClose );
80
84 wxString GetCurLib() const;
85
89 wxString SetCurLib( const wxString& aLibNickname );
90
92
96 LIB_ID GetTreeLIBID( int* aUnit = nullptr ) const;
97
98 int GetTreeSelectionCount() const;
99
100 int GetTreeLIBIDs( std::vector<LIB_ID>& aSelection ) const;
101
107 LIB_SYMBOL* GetCurSymbol() const { return m_symbol; }
108
112 void SetCurSymbol( LIB_SYMBOL* aSymbol, bool aUpdateZoom );
113
115
116 SELECTION& GetCurrentSelection() override;
117
118 // See comments for m_SyncPinEdit.
119 bool SynchronizePins();
120
124 wxString AddLibraryFile( bool aCreateNew );
125
129 void DdAddLibrary( wxString aLibFile );
130
137 void CreateNewSymbol( const wxString& newName = wxEmptyString );
138
139 void ImportSymbol();
140 void ExportSymbol();
141
145 void Save();
146
150 void SaveSymbolCopyAs();
151
155 void SaveLibraryAs();
156
160 void SaveAll();
161
165 void Revert( bool aConfirm = true );
166 void RevertAll();
167
169
171
172 void LoadSymbol( const wxString& aLibrary, const wxString& aSymbol, int Unit );
173
179 void DuplicateSymbol( bool aFromClipboard );
180
181 void OnSelectUnit( wxCommandEvent& event );
182
183 void OnToggleSymbolTree( wxCommandEvent& event );
184
185 void ToggleProperties() override;
186
187 bool IsSymbolTreeShown() const;
188 void FreezeLibraryTree();
189 void ThawLibraryTree();
190
191 void OnUpdateUnitNumber( wxUpdateUIEvent& event );
192
193 void UpdateAfterSymbolProperties( wxString* aOldName = nullptr );
195
196 bool canCloseWindow( wxCloseEvent& aCloseEvent ) override;
197 void doCloseWindow() override;
198 void OnExitKiCad( wxCommandEvent& event );
199 void ReCreateHToolbar() override;
200 void ReCreateVToolbar() override;
201 void ReCreateOptToolbar() override;
202
203 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
204 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
205
207 {
208 return m_settings;
209 }
210
211 APP_SETTINGS_BASE* config() const override;
212
213 COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
214
221 void CloseWindow( wxCommandEvent& event )
222 {
223 // Generate a wxCloseEvent
224 Close( false );
225 }
226
231 void OnModify() override;
232
233 int GetUnit() const { return m_unit; }
234 void SetUnit( int aUnit ) { m_unit = aUnit; }
235
236 int GetBodyStyle() const { return m_bodyStyle; }
237 void SetBodyStyle( int aBodyStyle ) { m_bodyStyle = aBodyStyle; }
238
239 bool GetShowDeMorgan() const { return m_showDeMorgan; }
240 void SetShowDeMorgan( bool show ) { m_showDeMorgan = show; }
241
244
245 void ClearMsgPanel() override
246 {
248 }
249
250 void UpdateMsgPanel() override
251 {
253 }
254
259 void UpdateTitle();
260
262 {
263 // If we've already vetted closing this window, then we have no symbol anymore
264 if( m_isClosing )
265 return false;
266
268 }
269
270 bool IsSymbolFromLegacyLibrary() const;
271
276
277 // General editing
284 void SaveCopyInUndoList( const wxString& aDescription, LIB_SYMBOL* aSymbol,
285 UNDO_REDO aUndoType = UNDO_REDO::LIBEDIT );
286
287 void PushSymbolToUndoList( const wxString& aDescription, LIB_SYMBOL* aSymbolCopy,
288 UNDO_REDO aUndoType = UNDO_REDO::LIBEDIT );
289
292
305 void ClearUndoORRedoList( UNDO_REDO_LIST whichList, int aItemCount = -1 ) override;
306
315 bool LoadSymbol( const LIB_ID& aLibId, int aUnit, int aBodyStyle );
316
320 void PrintPage( const RENDER_SETTINGS* aSettings ) override;
321
327 void SVGPlotSymbol( const wxString& aFullFileName, const VECTOR2I& aOffset );
328
333 void SyncLibraries( bool aShowProgress, bool aPreloadCancelled = false,
334 const wxString& aForceRefresh = wxEmptyString );
335
342
346 void RefreshLibraryTree();
347
351 void UpdateLibraryTree( const wxDataViewItem& aTreeItem, LIB_SYMBOL* aSymbol );
352
357 LIB_ID GetTargetLibId() const;
358
362 std::vector<LIB_ID> GetSelectedLibIds() const;
363
364 void FocusOnLibId( const LIB_ID& aLibID );
365
369 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
370
371 void ShowChangedLanguage() override;
372
373 void SetScreen( BASE_SCREEN* aScreen ) override;
374
375 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
376
377 void RebuildView();
378
379 void UpdateItem( EDA_ITEM* aItem, bool isAddOrDelete = false,
380 bool aUpdateRtree = false ) override;
381
385 void HardRedraw() override;
386
387 void KiwayMailIn( KIWAY_EXPRESS& mail ) override;
388
389 void FocusOnItem( SCH_ITEM* aItem );
390
396 void LoadSymbolFromSchematic( SCH_SYMBOL* aSymbol );
397
408 bool IsSymbolEditable() const;
409
410 bool IsSymbolAlias() const;
411
413 bool IsCurrentSymbol( const LIB_ID& aLibId ) const;
414
416 void emptyScreen();
417
418protected:
419 void setupUIConditions() override;
420
421 void doReCreateMenuBar() override;
422
423 void updateSelectionFilterVisbility() override;
424
425private:
426 // Set up the tool framework
427 void setupTools();
428
429 void saveSymbolCopyAs();
430
441 bool saveLibrary( const wxString& aLibrary, bool aNewFile );
442
449 void SelectActiveLibrary( const wxString& aLibrary = wxEmptyString );
450
460 bool LoadSymbolFromCurrentLib( const wxString& aAliasName, int aUnit = 0, int aBodyStyle = 0 );
461
472 bool LoadOneLibrarySymbolAux( LIB_SYMBOL* aLibEntry, const wxString& aLibrary, int aUnit,
473 int aBodyStyle );
474
476 bool backupFile( const wxFileName& aOriginalFile, const wxString& aBackupExt );
477
480
483 wxString getTargetLib() const;
484
485 void centerItemIdleHandler( wxIdleEvent& aEvent );
486
487 /*
488 * Return true when the operation has succeeded (all requested libraries have been saved
489 * or none was selected and confirmed by OK).
490 *
491 * @param aRequireConfirmation when true, the user must be asked to confirm.
492 */
493 bool saveAllLibraries( bool aRequireConfirmation );
494
496 bool saveCurrentSymbol();
497
499 void storeCurrentSymbol();
500
502 void ensureUniqueName( LIB_SYMBOL* aSymbol, const wxString& aLibrary );
503
505 {
508 };
509
519 bool addLibTableEntry( const wxString& aLibFile, TABLE_SCOPE aScope = GLOBAL_LIB_TABLE );
520
531 bool replaceLibTableEntry( const wxString& aLibNickname, const wxString& aLibFile );
532
533 DECLARE_EVENT_TABLE()
534
535public:
558
559private:
562
563 LIB_SYMBOL* m_symbol; // a symbol I own, it is not in any library, but a
564 // copy could be.
565 wxComboBox* m_unitSelectBox; // a ComboBox to select a unit to edit (if the
566 // symbol has multiple units)
567 SYMBOL_TREE_PANE* m_treePane; // symbol search tree widget
568 LIB_SYMBOL_LIBRARY_MANAGER* m_libMgr; // manager taking care of temporary modifications
569 SYMBOL_EDITOR_SETTINGS* m_settings; // Handle to the settings
570
572
573 // The unit number to edit and show
575
576 // Show the normal shape (m_bodyStyle <= 1) or the DeMorgan converted shape (m_bodyStyle > 1)
578
582
584 wxString m_reference;
585
586 // True to force DeMorgan/normal tools selection enabled.
587 // They are enabled when the loaded symbol has graphic items for converted shape
588 // But under some circumstances (New symbol created) these tools must left enabled
589 static bool m_showDeMorgan;
590};
591
592#endif // SYMBOL_EDIT_FRAME_H
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
Color settings are a bit different than most of the settings objects in that there can be more than o...
UNDO_REDO_LIST
Specifies whether we are interacting with the undo or redo stacks.
bool m_isClosing
Set by NonUserClose() to indicate that the user did not request the current close.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:88
A dialog which shows:
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
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
Symbol library management helper that is specific to the symbol library editor frame.
Define a library symbol object.
Definition: lib_symbol.h:78
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
Schematic editor (Eeschema) main window.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:172
Schematic symbol object.
Definition: sch_symbol.h:108
The symbol library editor main window.
void ClearMsgPanel() override
Clear all messages from the message panel.
void OnExitKiCad(wxCommandEvent &event)
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false, bool aUpdateRtree=false) override
Mark an item for refresh.
void UpdateAfterSymbolProperties(wxString *aOldName=nullptr)
void SaveAll()
Save all modified symbols and libraries.
void DeleteSymbolFromLibrary()
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
APP_SETTINGS_BASE * config() const override
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
bool addLibTableEntry(const wxString &aLibFile, TABLE_SCOPE aScope=GLOBAL_LIB_TABLE)
Add aLibFile to the symbol library table defined by aScope.
void storeCurrentSymbol()
Rename LIB_SYMBOL aliases to avoid conflicts before adding a symbol to a library.
const BOX2I GetDocumentExtents(bool aIncludeAllVisible=true) const override
Returns bbox of document with option to not include some items.
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
wxString getTargetLib() const
bool IsCurrentSymbol(const LIB_ID &aLibId) const
Restore the empty editor screen, without any symbol or library selected.
bool backupFile(const wxFileName &aOriginalFile, const wxString &aBackupExt)
Return currently edited symbol.
void FocusOnItem(SCH_ITEM *aItem)
void RefreshLibraryTree()
Redisplay the library tree.
void updateSelectionFilterVisbility() override
Selection filter panel doesn't have a dedicated visibility control, so show it if any other AUI panel...
void ReCreateVToolbar() override
wxComboBox * m_unitSelectBox
int GetTreeLIBIDs(std::vector< LIB_ID > &aSelection) const
LIB_ID GetTreeLIBID(int *aUnit=nullptr) const
Return the LIB_ID of the library or symbol selected in the symbol tree.
LIB_SYMBOL_LIBRARY_MANAGER * m_libMgr
wxString GetCurLib() const
The nickname of the current library being edited and empty string if none.
LIB_ID GetTargetLibId() const
Return either the symbol selected in the symbol tree (if context menu is active) or the symbol on the...
void FocusOnLibId(const LIB_ID &aLibID)
void SVGPlotSymbol(const wxString &aFullFileName, const VECTOR2I &aOffset)
Create the SVG print file for the current edited symbol.
bool IsSymbolAlias() const
Return true if aLibId is an alias for the editor screen symbol.
void PrintPage(const RENDER_SETTINGS *aSettings) override
Print a page.
void ToggleProperties() override
void Save()
Save the selected symbol or library.
SYMBOL_EDITOR_SETTINGS * m_settings
void LoadSymbol(const wxString &aLibrary, const wxString &aSymbol, int Unit)
int GetBodyStyle() const
void HardRedraw() override
Rebuild the GAL and redraw the screen.
bool GetShowDeMorgan() const
bool IsSymbolTreeShown() const
bool m_SyncPinEdit
Set to true to synchronize pins at the same position when editing symbols with multiple units or mult...
int GetTreeSelectionCount() const
void PushSymbolToUndoList(const wxString &aDescription, LIB_SYMBOL *aSymbolCopy, UNDO_REDO aUndoType=UNDO_REDO::LIBEDIT)
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
bool CanCloseSymbolFromSchematic(bool doClose)
void Revert(bool aConfirm=true)
Revert unsaved changes in a symbol, restoring to the last saved state.
bool IsSymbolFromLegacyLibrary() const
void centerItemIdleHandler(wxIdleEvent &aEvent)
bool replaceLibTableEntry(const wxString &aLibNickname, const wxString &aLibFile)
Replace the file path of the symbol library table entry aLibNickname with aLibFile.
bool IsSymbolFromSchematic() const
void OnToggleSymbolTree(wxCommandEvent &event)
static bool m_showDeMorgan
void SetScreen(BASE_SCREEN *aScreen) override
void SaveSymbolCopyAs()
Save the currently selected symbol to a new name and/or location.
void SaveCopyInUndoList(const wxString &aDescription, LIB_SYMBOL *aSymbol, UNDO_REDO aUndoType=UNDO_REDO::LIBEDIT)
Create a copy of the current symbol, and save it in the undo list.
SYMBOL_EDITOR_SETTINGS * GetSettings() const
void DuplicateSymbol(bool aFromClipboard)
Insert a duplicate symbol.
SCH_SCREEN * m_dummyScreen
< Helper screen used when no symbol is loaded
void KiwayMailIn(KIWAY_EXPRESS &mail) override
Receive KIWAY_EXPRESS messages from other players.
void SetCurSymbol(LIB_SYMBOL *aSymbol, bool aUpdateZoom)
Take ownership of aSymbol and notes that it is the one currently being edited.
KIID m_schematicSymbolUUID
RefDes of the symbol (only valid if symbol was loaded from schematic)
bool IsSymbolEditable() const
Test if a symbol is loaded and can be edited.
std::vector< LIB_ID > GetSelectedLibIds() const
LIB_TREE_NODE * GetCurrentTreeNode() const
void SyncLibraries(bool aShowProgress, bool aPreloadCancelled=false, const wxString &aForceRefresh=wxEmptyString)
Synchronize the library manager to the symbol library table, and then the symbol tree to the library ...
void RegenerateLibraryTree()
Filter, sort, and redisplay the library tree.
void OnSelectUnit(wxCommandEvent &event)
LIB_SYMBOL * GetCurSymbol() const
Return the current symbol being edited or NULL if none selected.
void UpdateSymbolMsgPanelInfo()
Display the documentation of the selected symbol.
bool canCloseWindow(wxCloseEvent &aCloseEvent) override
void SetBodyStyle(int aBodyStyle)
bool saveLibrary(const wxString &aLibrary, bool aNewFile)
Save the changes to the current library.
void SelectActiveLibrary(const wxString &aLibrary=wxEmptyString)
Set the current active library to aLibrary.
int m_bodyStyle
Flag if the symbol being edited was loaded directly from a schematic.
bool saveAllLibraries(bool aRequireConfirmation)
Save the current symbol.
void SetUnit(int aUnit)
void UpdateMsgPanel() override
Redraw the message panel.
void ClearUndoORRedoList(UNDO_REDO_LIST whichList, int aItemCount=-1) override
Free the undo or redo list from aList element.
void CreateNewSymbol(const wxString &newName=wxEmptyString)
Create a new symbol in the selected library.
wxString SetCurLib(const wxString &aLibNickname)
Set the current library nickname and returns the old library nickname.
void UpdateTitle()
Update the main window title bar with the current library name and read only status of the library.
void ReCreateHToolbar() override
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Called after the preferences dialog is run.
bool HasLibModifications() const
Check if any pending libraries have been modified.
SYMBOL_TREE_PANE * m_treePane
void LoadSymbolFromSchematic(SCH_SYMBOL *aSymbol)
Load a symbol from the schematic to edit in place.
bool LoadOneLibrarySymbolAux(LIB_SYMBOL *aLibEntry, const wxString &aLibrary, int aUnit, int aBodyStyle)
Create a copy of aLibEntry into memory.
bool LoadSymbolFromCurrentLib(const wxString &aAliasName, int aUnit=0, int aBodyStyle=0)
Load a symbol from the current active library, optionally setting the selected unit and convert.
bool saveCurrentSymbol()
Store the currently modified symbol in the library manager buffer.
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Returns a pointer to the active color theme settings.
LIB_SYMBOL_LIBRARY_MANAGER & GetLibManager()
void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType) override
Switch currently used canvas ( Cairo / OpenGL).
void doCloseWindow() override
void DdAddLibrary(wxString aLibFile)
Add a library dropped file to the symbol library table.
wxString AddLibraryFile(bool aCreateNew)
Create or add an existing library to the symbol library table.
void ReCreateOptToolbar() override
void ensureUniqueName(LIB_SYMBOL *aSymbol, const wxString &aLibrary)
void CloseWindow(wxCommandEvent &event)
Trigger the wxCloseEvent, which is handled by the function given to EVT_CLOSE() macro:
void UpdateLibraryTree(const wxDataViewItem &aTreeItem, LIB_SYMBOL *aSymbol)
Update a symbol node in the library tree.
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current symbol.
void SetShowDeMorgan(bool show)
void ShowChangedLanguage() override
void SaveLibraryAs()
Save the currently selected library to a new file.
bool IsContentModified() const override
Get if any symbols or libraries have been modified but not saved.
void doReCreateMenuBar() override
LIB_SYMBOL * getTargetSymbol() const
Return either the library selected in the symbol tree, if context menu is active or the library that ...
void OnUpdateUnitNumber(wxUpdateUIEvent &event)
Library Editor pane with symbol tree and symbol library table selector.
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...