45#include <wx/clipbrd.h>
46#include <wx/filedlg.h>
51#if wxCHECK_VERSION( 3, 1, 7 )
69 title += wxS(
" " ) +
_(
"[from schematic]" );
79 title += wxS(
" " ) +
_(
"[Read Only Library]" );
83 title =
_(
"[no symbol loaded]" );
86 title += wxT(
" \u2014 " ) +
_(
"Symbol Editor" );
93 wxString selectedLib = aLibrary;
95 if( selectedLib.empty() )
98 if( !selectedLib.empty() )
150 if( lib->SchLibType() == SCH_IO_MGR::SCH_DATABASE
151 || lib->SchLibType() == SCH_IO_MGR::SCH_CADSTAR_ARCHIVE )
155 LIB_SYMBOL* readOnlySym =
Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
164 msg.Printf(
_(
"Error loading symbol %s from library '%s'." ),
224 alias =
Prj().SchSymbolLibTable()->LoadSymbol(
GetCurLib(), aAliasName );
230 msg.Printf(
_(
"Error loading symbol %s from library '%s'." ),
255 int aUnit,
int aConvert )
257 bool rebuildMenuAndToolbar =
false;
259 if( !aEntry || aLibrary.empty() )
262 if( aEntry->
GetName().IsEmpty() )
264 wxLogWarning(
"Symbol in library '%s' has empty name field.", aLibrary );
280 rebuildMenuAndToolbar =
true;
284 wxCHECK( lib_symbol,
false );
286 m_unit = aUnit > 0 ? aUnit : 1;
296 if( rebuildMenuAndToolbar )
335 wxArrayString rootSymbols;
350 wxString _inheritSymbolName;
351 wxString _infoMessage;
355 if( !inheritFromSymbolName.IsEmpty() )
359 if( inheritFromSymbol && !inheritFromSymbol->
IsRoot() )
361 std::shared_ptr<LIB_SYMBOL> parent = inheritFromSymbol->
GetParent().lock();
362 wxString rootSymbolName = parent->GetName();
363 _inheritSymbolName = rootSymbolName;
364 _infoMessage = wxString::Format(
_(
"Deriving from '%s', the root symbol of '%s'." ),
366 inheritFromSymbolName);
370 _inheritSymbolName = inheritFromSymbolName;
375 dlg.SetMinSize( dlg.GetSize() );
377 if( dlg.ShowModal() == wxID_CANCEL )
382 wxMessageBox(
_(
"This new symbol has no name and cannot be created." ) );
389 name.Replace(
" ",
"_" );
394 wxString msg = wxString::Format(
_(
"Symbol '%s' already exists in library '%s'." ),
398 KIDIALOG errorDlg(
this, msg,
_(
"Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
399 errorDlg.SetOKLabel(
_(
"Overwrite" ) );
402 if( errorDlg.
ShowModal() == wxID_CANCEL )
410 if( parentSymbolName.IsEmpty() )
458 wxCHECK( parentField, );
460 *field = *parentField;
478 field->
SetText( wxEmptyString );
507 if( libName.empty() )
513 wxString msg = wxString::Format(
_(
"Symbol library '%s' is not writable." ),
515 wxString msg2 =
_(
"You must save to a different location." );
556 const wxString& aLibraryPreselect )
562 wxArrayString headers;
563 std::vector<wxArrayString> itemsToDisplay;
565 headers.Add(
_(
"Nickname" ) );
566 headers.Add(
_(
"Description" ) );
568 for(
const wxString& nickname : libNicknames )
576 itemsToDisplay.push_back( item );
580 for(
const wxString& nickname : libNicknames )
586 item.Add( nickname );
588 itemsToDisplay.push_back( item );
593 itemsToDisplay, aLibraryPreselect,
false );
598 wxBoxSizer* bNameSizer =
new wxBoxSizer( wxHORIZONTAL );
600 wxStaticText* label =
new wxStaticText( dlg, wxID_ANY,
_(
"Name:" ) );
601 bNameSizer->Add( label, 0, wxALIGN_CENTER_VERTICAL|wxTOP|wxBOTTOM|wxLEFT, 5 );
603 wxTextCtrl* nameTextCtrl =
new wxTextCtrl( dlg,
ID_SAVE_AS_NAME, aSymbolName );
604 bNameSizer->Add( nameTextCtrl, 1, wxALIGN_CENTER_VERTICAL|wxALL, 5 );
608 dlg->
m_ButtonsSizer->Prepend( newLibraryButton, 0, wxALIGN_CENTER_VERTICAL|wxLEFT|wxRIGHT, 10 );
610 dlg->GetSizer()->Prepend( bNameSizer, 0, wxEXPAND|wxTOP|wxLEFT|wxRIGHT, 5 );
612 dlg->Bind( wxEVT_BUTTON,
613 [dlg]( wxCommandEvent& )
619 if( dlg->GetChildren().DeleteObject( nameTextCtrl ) )
620 dlg->GetChildren().Insert( nameTextCtrl );
625 dlg->GetSizer()->Fit( dlg );
642 std::unique_ptr<EDA_LIST_DIALOG> dlg;
648 int ret = dlg->ShowModal();
650 if( ret == wxID_CANCEL )
654 else if( ret == wxID_OK )
661 libraryName = newLibrary.GetName();
665 libraryName = dlg->GetTextSelection();
667 if( libraryName.IsEmpty() )
669 DisplayError(
this,
_(
"No library specified. Symbol could not be saved." ) );
678 DisplayError(
this,
_(
"Derived symbols must be saved in the same library as their "
679 "parent symbol." ) );
683 symbolName =
static_cast<wxTextCtrl*
>( dlg->FindWindow(
ID_SAVE_AS_NAME ) )->GetValue();
684 symbolName.Trim(
true );
685 symbolName.Trim(
false );
686 symbolName.Replace(
" ",
"_" );
688 if( symbolName.IsEmpty() )
697 wxString msg = wxString::Format(
_(
"Symbol '%s' already exists in library '%s'" ),
701 KIDIALOG errorDlg(
this, msg,
_(
"Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
702 errorDlg.SetOKLabel(
_(
"Overwrite" ) );
705 if( errorDlg.
ShowModal() == wxID_CANCEL )
710 new_symbol.
SetName( symbolName );
731 wxString msg = wxString::Format(
_(
"Symbol name '%s' already in use." ),
763 if( toDelete.empty() )
766 for(
LIB_ID& libId : toDelete )
769 && !
IsOK(
this, wxString::Format(
_(
"The symbol '%s' has been modified.\n"
770 "Do you want to remove it from the library?" ),
771 libId.GetUniStringLibItemName() ) ) )
781 _(
"The symbol %s is used to derive other symbols.\n"
782 "Deleting this symbol will delete all of the symbols derived from it.\n\n"
783 "Do you wish to delete this symbol and all of its derivatives?" ),
784 libId.GetLibItemName().wx_str() );
786 wxMessageDialog::ButtonLabel yesButtonLabel(
_(
"Delete Symbol" ) );
787 wxMessageDialog::ButtonLabel noButtonLabel(
_(
"Keep Symbol" ) );
789 wxMessageDialog dlg(
this, msg,
_(
"Warning" ),
790 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION | wxCENTER );
791 dlg.SetYesNoLabels( yesButtonLabel, noButtonLabel );
793 if( dlg.ShowModal() == wxID_NO )
809 std::vector<LIB_ID> symbols;
816 for(
LIB_ID& libId : symbols )
819 libId.GetLibNickname() );
824 std::unique_ptr<LIB_SYMBOL> tmp = symbol->
Flatten();
830 auto clipboard = wxTheClipboard;
831 wxClipboardLocker clipboardLock( clipboard );
833 if( !clipboardLock || !clipboard->IsOpened() )
836 auto data =
new wxTextDataObject( wxString( formatter.
GetString().c_str(), wxConvUTF8 ) );
837 clipboard->SetData( data );
851 std::vector<LIB_SYMBOL*> newSymbols;
857 auto clipboard = wxTheClipboard;
858 wxClipboardLocker clipboardLock( clipboard );
861 || !( clipboard->IsSupported( wxDF_TEXT )
862 || clipboard->IsSupported( wxDF_UNICODETEXT ) ) )
867 wxTextDataObject data;
868 clipboard->GetData( data );
869 wxString symbolSource = data.GetText();
871 std::unique_ptr<STRING_LINE_READER> reader = std::make_unique<STRING_LINE_READER>(
TO_UTF8( symbolSource ), wxS(
"Clipboard" ) );
882 wxLogMessage( wxS(
"Can not paste: %s" ), e.
Problem() );
887 newSymbols.emplace_back( newSymbol );
897 wxCHECK( srcSymbol, );
899 newSymbols.emplace_back(
new LIB_SYMBOL( *srcSymbol ) );
904 std::shared_ptr< LIB_SYMBOL > srcParent = srcSymbol->
GetParent().lock();
906 wxCHECK( srcParent, );
908 newSymbols.back()->SetParent( srcParent.get() );
912 if( newSymbols.empty() )
936 wxString newName = aSymbol->
GetName();
940 newName.Printf(
"%s_%d", aSymbol->
GetName(), i++ );
954 wxString msg = wxString::Format(
_(
"Revert '%s' to last version saved?" ),
955 symbolName.IsEmpty() ? libName : symbolName );
960 bool reload_currentSymbol =
false;
961 wxString curr_symbolName = symbolName;
967 if( symbolName.IsEmpty() )
972 if( reload_currentSymbol )
983 if( reload_currentSymbol )
986 if( symbolName.IsEmpty() )
1007 wxCHECK_RET(
m_libMgr,
"Library manager object not created." );
1032 DisplayError(
this, wxString::Format(
_(
"Symbol %s not found in library '%s'." ),
1053 SCH_IO_MGR::SCH_FILE_T
fileType = SCH_IO_MGR::SCH_FILE_T::SCH_KICAD;
1058 if( !aNewFile && ( aLibrary.empty() || !prj.SchSymbolLibTable()->HasLibrary( aLibrary ) ) )
1074 fn.SetName( aLibrary );
1079 wxFileDialog dlg(
this, wxString::Format(
_(
"Save Library '%s' As..." ), aLibrary ),
1080 default_path, fn.GetFullName(), wildcards,
1081 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1083#if wxCHECK_VERSION( 3, 1, 7 )
1085 dlg.SetCustomizeHook( saveAsHook );
1090 if( dlg.ShowModal() == wxID_CANCEL )
1097 if( fn.GetExt().IsEmpty() )
1100#if wxCHECK_VERSION( 3, 1, 7 )
1105 wxCHECK( sah,
false );
1112 fn = prj.SchSymbolLibTable()->GetFullURI( aLibrary );
1128 msg.Printf(
_(
"Failed to save changes to symbol library file '%s'." ),
1140 bool resyncLibTree =
false;
1142 wxString forceRefresh;
1146 case SYMBOL_SAVEAS_TYPE::REPLACE_TABLE_ENTRY:
1148 forceRefresh = originalLibNickname;
1151 case SYMBOL_SAVEAS_TYPE::ADD_GLOBAL_TABLE_ENTRY:
1155 case SYMBOL_SAVEAS_TYPE::ADD_PROJECT_TABLE_ENTRY:
1172 msg.Printf(
_(
"Symbol library file '%s' saved." ), fn.GetFullPath() );
1184 bool applyToAll =
false;
1197 if( aRequireConfirmation && !applyToAll )
1199 msg.Printf(
_(
"Save changes to '%s' before closing?" ), libNickname );
1203 case wxID_YES: doSave =
true;
break;
1204 case wxID_NO: doSave =
false;
break;
1206 case wxID_CANCEL:
return false;
1221 msg.Printf(
_(
"Symbol library '%s' is not writable." ), libNickname );
1222 msg2 =
_(
"You must save to a different location." );
1224 if( dirtyCount == 1 )
1236 2000, wxICON_EXCLAMATION );
1272 msg = parent ? parent->GetName() :
_(
"Undefined!" );
1276 static wxChar UnitLetter[] = wxT(
"?ABCDEFGHIJKLMNOPQRSTUVWXYZ" );
1277 msg = UnitLetter[
m_unit];
1282 msg =
_(
"Convert" );
1284 msg =
_(
"Normal" );
1289 msg =
_(
"Power Symbol" );
1291 msg =
_(
"Symbol" );
static TOOL_ACTION cancelInteractive
static TOOL_ACTION zoomFitScreen
void SetContentModified(bool aModified=true)
wxString GetReference(void)
wxString GetParentSymbolName() const
wxString GetName(void) const override
bool GetIncludeOnBoard() const
bool GetShowPinNumber(void)
bool GetShowPinName(void)
bool GetAlternateBodyStyle(void)
int GetPinTextPosition(void)
bool GetPowerSymbol(void)
bool GetPinNameInside(void)
bool GetUnitsInterchangeable(void)
bool GetIncludeInBom() const
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
virtual void ClearUndoRedoList()
Clear the undo and redo list using ClearUndoORRedoList()
void ShowInfoBarError(const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left o...
void ReCreateMenuBar()
Recreates the menu bar.
WX_INFOBAR * GetInfoBar()
virtual void ClearMsgPanel()
Clear all messages from the message panel.
void AppendMsgPanel(const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
Append a message to the message panel.
virtual void SetParent(EDA_ITEM *aParent)
wxBoxSizer * m_ButtonsSizer
void SetOKLabel(const wxString &aLabel)
void SetListLabel(const wxString &aLabel)
virtual const wxString & GetText() const
Return the string associated with the text object.
virtual void SetText(const wxString &aText)
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
virtual const wxString Problem() const
what was the problem?
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
void DoNotShowCheckbox(wxString file, int line)
Checks the 'do not show again' setting for the dialog.
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Field object used in symbol libraries.
A logical library item identifier and consists of various portions much like a URI.
bool IsValid() const
Check if this LID_ID is valid.
wxString GetUniStringLibId() const
const wxString GetUniStringLibItemName() const
Get strings for display messages in dialogs.
const UTF8 & GetLibItemName() const
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Define a library symbol object.
void SetIncludeOnBoard(bool aIncludeOnBoard)
Set or clear include in board netlist flag.
void SetShowPinNames(bool aShow)
Set or clear the pin name visibility flag.
int GetPinNameOffset() const
wxString GetKeyWords() const
void SetConversion(bool aSetConvert, bool aDuplicatePins=true)
Set or clear the alternate body style (DeMorgan) for the symbol.
LIB_FIELD & GetReferenceField()
Return reference to the reference designator field.
void SetUnitCount(int aCount, bool aDuplicateDrawItems=true)
Set the units per symbol count.
bool UnitsLocked() const
Check whether symbol units are interchangeable.
bool IsRoot() const override
For symbols derived from other symbols, IsRoot() indicates no derivation.
LIB_FIELD * GetFieldById(int aId) const
Return pointer to the requested field.
void SetPinNameOffset(int aOffset)
Set the offset in mils of the pin name text from the pin symbol.
LIB_ID GetSourceLibId() const
void LockUnits(bool aLockUnits)
Set interchangeable the property for symbol units.
void SetShowPinNumbers(bool aShow)
Set or clear the pin number visibility flag.
LIB_ID GetLibId() const override
void SetParent(LIB_SYMBOL *aParent=nullptr)
wxString GetName() const override
wxString GetDescription() override
std::unique_ptr< LIB_SYMBOL > Flatten() const
Return a flattened symbol inheritance to the caller.
LIB_FIELD & GetDatasheetField()
Return reference to the datasheet field.
void SetIncludeInBom(bool aIncludeInBom)
Set or clear the include in schematic bill of materials flag.
bool HasConversion() const
Test if symbol has more than one body conversion type (DeMorgan).
LIB_SYMBOL_REF & GetParent()
virtual void SetName(const wxString &aName)
const wxString GetDescription(const wxString &aNickname)
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.
static const wxString GetPinningSymbol()
void RefreshLibTree()
Refreshes the tree (mainly to update highlighting and asterisking)
void CenterLibId(const LIB_ID &aLibId)
Ensure that an item is visible (preferably centered).
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
void ExpandLibId(const LIB_ID &aLibId)
Expand and item i the tree widget.
The backing store for a PROJECT, in JSON format.
Container for project specific data.
virtual PROJECT_FILE & GetProjectFile() const
virtual void SetRString(RSTRING_T aStringId, const wxString &aString)
Store a "retained string", which is any session and project specific string identified in enum RSTRIN...
virtual const wxString & GetRString(RSTRING_T aStringId)
Return a "retained string", which is any session and project specific string identified in enum RSTRI...
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
wxString SelectLibraryFromList()
Display a list of loaded libraries and allows the user to select a library.
void setSymWatcher(const LIB_ID *aSymbol)
Creates (or removes) a watcher on the specified symbol library.
Schematic editor (Eeschema) main window.
void SaveSymbolToSchematic(const LIB_SYMBOL &aSymbol, const KIID &aSchematicSymbolUUID)
Update a schematic symbol from a LIB_SYMBOL.
static SCH_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath)
Return a plugin type given a symbol library using the file extension of aLibPath.
static void FormatLibSymbol(LIB_SYMBOL *aPart, OUTPUTFORMATTER &aFormatter)
static LIB_SYMBOL * ParseLibSymbol(LINE_READER &aReader, int aVersion=SEXPR_SCHEMATIC_FILE_VERSION)
Look for files in a number of paths.
const wxString LastVisitedPath(const wxString &aSubPathToSearch=wxEmptyString)
A quirky function inherited from old code that seems to serve particular needs in the UI.
Is a LINE_READER that reads from a multiline 8 bit wide std::string.
bool m_isSymbolFromSchematic
void CreateNewSymbol(const wxString &inheritFromSymbolName=wxEmptyString)
Create a new symbol in the selected library.
void ClearMsgPanel() override
Clear all messages from the message panel.
int m_convert
Flag if the symbol being edited was loaded directly from a schematic.
void UpdateAfterSymbolProperties(wxString *aOldName=nullptr)
void SaveAll()
Save all modified symbols and libraries.
void DeleteSymbolFromLibrary()
bool addLibTableEntry(const wxString &aLibFile, TABLE_SCOPE aScope=GLOBAL_LIB_TABLE)
Add aLibFile to the symbol library table defined by aScope.
void updateTitle()
Update the main window title bar with the current library name and read only status of the library.
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.
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
bool LoadOneLibrarySymbolAux(LIB_SYMBOL *aLibEntry, const wxString &aLibrary, int aUnit, int aConvert)
Create a copy of aLibEntry into memory.
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 Save()
Save the selected symbol or library.
void LoadSymbol(const wxString &aLibrary, const wxString &aSymbol, int Unit)
bool LoadSymbolFromCurrentLib(const wxString &aAliasName, int aUnit=0, int aConvert=0)
Load a symbol from the current active library, optionally setting the selected unit and convert.
void SaveSymbolAs()
Save the currently selected symbol to a new name and/or location.
bool IsSymbolTreeShown() const
bool m_SyncPinEdit
Set to true to synchronize pins at the same position when editing symbols with multiple units or mult...
void RebuildSymbolUnitsList()
void Revert(bool aConfirm=true)
Revert unsaved changes in a symbol, restoring to the last saved state.
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 SetScreen(BASE_SCREEN *aScreen) override
void DuplicateSymbol(bool aFromClipboard)
Insert a duplicate symbol.
SCH_SCREEN * m_dummyScreen
< Helper screen used when no symbol is loaded
LIB_ID m_centerItemOnIdle
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)
std::vector< LIB_ID > GetSelectedLibIds() 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 ...
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 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.
bool saveAllLibraries(bool aRequireConfirmation)
Save the current symbol.
EDA_LIST_DIALOG * buildSaveAsDialog(const wxString &aSymbolName, const wxString &aLibraryPreselect)
void UpdateMsgPanel() override
Redraw the message panel.
wxString SetCurLib(const wxString &aLibNickname)
Set the current library nickname and returns the old library nickname.
void ReCreateHToolbar() override
SYMBOL_TREE_PANE * m_treePane
bool saveCurrentSymbol()
Store the currently modified symbol in the library manager buffer.
void CopySymbolToClipboard()
wxString AddLibraryFile(bool aCreateNew)
Create or add an existing library to the symbol library table.
void ensureUniqueName(LIB_SYMBOL *aSymbol, const wxString &aLibrary)
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 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.
LIB_SYMBOL * getTargetSymbol() const
Return either the library selected in the symbol tree, if context menu is active or the library that ...
SYMBOL_SAVEAS_TYPE GetOption() const
Helper control to inquire user what to do on library save as operation.
SYMBOL_SAVEAS_TYPE GetOption() const
static SYMBOL_SAVEAS_TYPE m_option
static wxWindow * Create(wxWindow *aParent)
Create a new panel to add to a wxFileDialog object.
LIB_SYMBOL * GetBufferedSymbol(const wxString &aAlias, const wxString &aLibrary)
Return the symbol copy from the buffer.
bool UpdateSymbolAfterRename(LIB_SYMBOL *aSymbol, const wxString &oldAlias, const wxString &aLibrary)
Update the symbol buffer with a new version of the symbol when the name has changed.
bool IsLibraryReadOnly(const wxString &aLibrary) const
Return true if the library is stored in a read-only file.
bool ClearSymbolModified(const wxString &aAlias, const wxString &aLibrary) const
Clear the modified flag for a symbol.
bool LibraryExists(const wxString &aLibrary, bool aCheckEnabled=false) const
Return true if library exists.
bool ClearLibraryModified(const wxString &aLibrary) const
Clear the modified flag for all symbols in a library.
LIB_SYMBOL * GetAlias(const wxString &aAlias, const wxString &aLibrary) const
Return either an alias of a working LIB_SYMBOL copy, or alias of the original symbol if there is no w...
SCH_SCREEN * GetScreen(const wxString &aAlias, const wxString &aLibrary)
Return the screen used to edit a specific symbol.
bool IsLibraryModified(const wxString &aLibrary) const
Return true if library has unsaved modifications.
wxArrayString GetLibraryNames() const
Return the array of library names.
void GetRootSymbolNames(const wxString &aLibName, wxArrayString &aRootSymbolNames)
bool SymbolExists(const wxString &aAlias, const wxString &aLibrary) const
Return true if symbol with a specific alias exists in library (either original one or buffered).
bool RemoveSymbol(const wxString &aName, const wxString &aLibrary)
Remove the symbol from the symbol buffer.
bool IsSymbolModified(const wxString &aAlias, const wxString &aLibrary) const
Return true if symbol has unsaved modifications.
bool RevertLibrary(const wxString &aLibrary)
Revert unsaved changes for a symbolicular library.
bool RevertAll()
Revert all pending changes.
LIB_ID RevertSymbol(const wxString &aAlias, const wxString &aLibrary)
Revert unsaved changes for a symbolicular symbol.
SYMBOL_LIB_TABLE_ROW * GetLibrary(const wxString &aLibrary) const
Find a single library within the (aggregate) library table.
bool UpdateSymbol(LIB_SYMBOL *aSymbol, const wxString &aLibrary)
Update the symbol buffer with a new version of the symbol.
bool SaveLibrary(const wxString &aLibrary, const wxString &aFileName, SCH_IO_MGR::SCH_FILE_T aFileType=SCH_IO_MGR::SCH_FILE_T::SCH_LEGACY)
Save library to a file, including unsaved changes.
bool HasDerivedSymbols(const wxString &aSymbolName, const wxString &aLibraryName)
Check if symbol aSymbolName in library aLibraryName is a root symbol that has derived symbols.
bool FlushSymbol(const wxString &aAlias, const wxString &aLibrary)
Save symbol changes to the library copy used by the schematic editor.
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
LIB_TREE * GetLibTree() const
void ShowMessageFor(const wxString &aMessage, int aTime, int aFlags=wxICON_INFORMATION, MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
Show the infobar with the provided message and icon for a specific period of time.
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
int OKOrCancelDialog(wxWindow *aParent, const wxString &aWarning, const wxString &aMessage, const wxString &aDetailedMessage, const wxString &aOKLabel, const wxString &aCancelLabel, bool *aApplyToAll)
Display a warning dialog with aMessage and returns the user response.
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
int UnsavedChangesDialog(wxWindow *parent, const wxString &aMessage, bool *aApplyToAll)
A specialized version of HandleUnsavedChanges which handles an apply-to-all checkbox.
bool ConfirmRevertDialog(wxWindow *parent, const wxString &aMessage)
Display a confirmation dialog for a revert action.
This file is part of the common library.
static bool empty(const wxTextEntryBase *aCtrl)
const std::string KiCadSymbolLibFileExtension
wxString KiCadSymbolLibFileWildcard()
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
MODEL3D_FORMAT_TYPE fileType(const char *aFileName)
wxString UnescapeString(const wxString &aSource)
std::vector< wxString > pinned_symbol_libs
static int ID_MAKE_NEW_LIBRARY
static int ID_SAVE_AS_NAME
Definition for symbol library class.
@ DATASHEET_FIELD
name of datasheet
@ FOOTPRINT_FIELD
Field Name Module PCB, i.e. "16DIP300".
@ VALUE_FIELD
Field Value of part, i.e. "3.3K".
@ MANDATORY_FIELDS
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
@ REFERENCE_FIELD
Field Reference of part, i.e. "IC21".
Definition of file extensions used in Kicad.