27#include <wx/hyperlink.h>
112 m_unitSelectBox(
nullptr ),
113 m_isSymbolFromSchematic( false )
115 SetShowDeMorgan(
false );
116 m_SyncPinEdit =
false;
119 m_treePane =
nullptr;
123 m_aboutTitle =
_HKI(
"KiCad Symbol Editor" );
126 wxIconBundle icon_bundle;
129 icon_bundle.AddIcon( icon );
131 icon_bundle.AddIcon( icon );
133 icon_bundle.AddIcon( icon );
135 icon_bundle.AddIcon( icon );
137 icon_bundle.AddIcon( icon );
139 SetIcons( icon_bundle );
142 LoadSettings( m_settings );
145 bool loadingCancelled =
false;
151 m_libMgr->GetLibraryCount(),
true );
152 m_libMgr->Preload( reporter );
158 SyncLibraries(
false, loadingCancelled );
163 SwitchCanvas( m_canvasType );
170 SetScreen( m_dummyScreen );
171 GetScreen()->m_Center =
true;
173 GetCanvas()->GetViewControls()->SetCrossHairCursorPosition(
VECTOR2D( 0, 0 ),
false );
175 GetRenderSettings()->LoadColors( GetColorSettings() );
176 GetRenderSettings()->m_IsSymbolEditor =
true;
189 UpdateSymbolMsgPanelInfo();
190 RebuildSymbolUnitsList();
193 m_propertiesPanel->SetSplitterProportion( m_settings->m_AuiPanels.properties_splitter );
197 m_auimgr.SetManagedWindow(
this );
202 m_auimgr.AddPane( m_tbTopMain,
EDA_PANE().HToolbar().Name(
"TopMainToolbar" )
205 m_auimgr.AddPane( m_messagePanel,
EDA_PANE().Messages().Name(
"MsgPanel" )
206 .Bottom().Layer( 6 ) );
209 m_auimgr.AddPane( m_treePane,
EDA_PANE().Palette().Name(
"LibraryTree" )
211 .TopDockable(
false ).BottomDockable(
false )
212 .Caption(
_(
"Libraries" ) )
213 .MinSize( FromDIP( 250 ), -1 ).BestSize( FromDIP( 250 ), -1 ) );
217 wxAuiPaneInfo& propertiesPaneInfo = m_auimgr.GetPane( PropertiesPaneName() );
221 wxAuiPaneInfo& selectionFilterPane = m_auimgr.GetPane( wxS(
"SelectionFilter" ) );
223 selectionFilterPane.dock_proportion = 0;
225 propertiesPaneInfo.Show( m_settings->m_AuiPanels.show_properties );
226 updateSelectionFilterVisbility();
228 m_auimgr.AddPane( m_tbLeft,
EDA_PANE().VToolbar().Name(
"LeftToolbar" )
229 .Left().Layer( 2 ) );
231 m_auimgr.AddPane( m_tbRight,
EDA_PANE().VToolbar().Name(
"RightToolbar" )
232 .Right().Layer( 2 ) );
235 m_auimgr.AddPane( GetCanvas(), wxAuiPaneInfo().Name(
"DrawFrame" )
238 FinishAUIInitialization();
242 selTool->
GetFilter() = GetSettings()->m_SelectionFilter;
243 m_selectionFilterPanel->SetCheckboxesFromFilter( selTool->
GetFilter() );
245 if( m_settings->m_LibWidth > 0 )
246 SetAuiPaneSize( m_auimgr, m_auimgr.GetPane(
"LibraryTree" ), m_settings->m_LibWidth, -1 );
252 GetCanvas()->GetView()->UseDrawPriority(
true );
253 GetCanvas()->GetGAL()->SetAxesEnabled(
true );
255 setupUnits( m_settings );
262 bbox.
SetOrigin( -max_size_x /2, -max_size_y/2 );
263 bbox.
SetSize( max_size_x, max_size_y );
264 GetCanvas()->GetView()->SetBoundary( bbox );
269 DragAcceptFiles(
true );
281 if( loadingCancelled )
282 ShowInfoBarWarning(
_(
"Symbol library loading was cancelled by user." ) );
319 wxCHECK_RET(
m_settings,
"Call to SYMBOL_EDIT_FRAME::LoadSettings with null m_boardAdapter" );
333 wxCHECK_RET(
m_settings,
"Call to SYMBOL_EDIT_FRAME::LoadSettings with null m_boardAdapter" );
417#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
418#define CHECK( x ) ACTION_CONDITIONS().Check( x )
420 auto haveSymbolCond =
426 auto isEditableCond =
434 auto isEditableInAliasCond =
443 auto symbolModifiedCondition =
450 auto libSelectedCondition =
456 auto canEditProperties =
462 auto saveSymbolAsCondition =
468 const auto isSymbolFromSchematicCond =
528 auto hiddenFieldCond =
534 auto showPinAltIconsCond =
540 auto showLibraryTreeCond =
546 auto propertiesCond =
566 auto demorganStandardCond =
572 auto demorganAlternateCond =
578 auto multiUnitModeCond =
584 auto hasMultipleUnitsCond =
590 auto syncedPinsModeCond =
596 auto haveDatasheetCond =
613#define EDIT_TOOL( tool ) ACTION_CONDITIONS().Enable( isEditableCond ).Check( cond.CurrentTool( tool ) )
639 wxString msg =
_(
"Save changes to '%s' before closing?" );
672 && aEvent.GetId() == wxEVT_QUERY_END_SESSION
735 propertiesPaneInfo.Show( show );
803 int i =
event.GetSelection();
805 if( i == wxNOT_FOUND )
830 if( !libNickname.empty() )
835 libNickname = wxEmptyString;
906 int infobarFlags = wxICON_INFORMATION;
910 msgs.push_back( wxString::Format(
_(
"Editing symbol %s from schematic. Saving will "
911 "update the schematic only." ),
914 wxString link = wxString::Format(
_(
"Open symbol from library %s" ), libName );
915 wxHyperlinkCtrl* button =
new wxHyperlinkCtrl( &infobar, wxID_ANY, link, wxEmptyString );
917 button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<
void( wxHyperlinkEvent& aEvent )>(
918 [
this, symbolName, libName]( wxHyperlinkEvent& aEvent )
927 msgs.push_back(
_(
"Symbols in legacy libraries are not editable. Use Manage Symbol "
928 "Libraries to migrate to current format." ) );
930 wxString link =
_(
"Manage symbol libraries" );
931 wxHyperlinkCtrl* button =
new wxHyperlinkCtrl( &infobar, wxID_ANY, link, wxEmptyString );
933 button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<
void( wxHyperlinkEvent& aEvent )>(
934 [
this]( wxHyperlinkEvent& aEvent )
943 msgs.push_back( wxString::Format(
_(
"Symbol %s is a derived symbol. Symbol graphics will "
944 "not be editable." ),
952 wxString rootSymbolName = rootSymbol->GetName();
953 wxString link = wxString::Format(
_(
"Open %s" ),
UnescapeString( rootSymbolName ) );
955 wxHyperlinkCtrl* button =
new wxHyperlinkCtrl( &infobar, wxID_ANY, link,
958 button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<
void( wxHyperlinkEvent& aEvent )>(
959 [
this, rootSymbolName, unit, bodyStyle]( wxHyperlinkEvent& aEvent )
972 msgs.push_back(
_(
"Library is read-only. Changes cannot be saved to this library." ) );
974 wxString link = wxString::Format(
_(
"Create an editable copy" ) );
975 wxHyperlinkCtrl* button =
new wxHyperlinkCtrl( &infobar, wxID_ANY, link, wxEmptyString );
977 button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<
void( wxHyperlinkEvent& aEvent )>(
978 [
this, symbolName, libName]( wxHyperlinkEvent& aEvent )
980 wxString msg = wxString::Format(
_(
"Create an editable copy of the symbol or "
981 "the entire library (%s)?" ),
984 KIDIALOG errorDlg(
this, msg,
_(
"Select type of item to save" ),
985 wxYES_NO | wxCANCEL | wxICON_QUESTION );
987 errorDlg.SetYesNoCancelLabels(
_(
"Copy symbol" ),
_(
"Cancel" ),
988 _(
"Copy library" ) );
1015 wxString msg = wxJoin( msgs,
'\n',
'\0' );
1042 if( !GetTitle().StartsWith(
"*" ) )
1049 wxCHECK( aUnit > 0 && aUnit <=
GetCurSymbol()->GetUnitCount(), );
1080 return wxEmptyString;
1089 return wxEmptyString;
1092 wxString libName = fn.GetName();
1094 if( libName.IsEmpty() )
1095 return wxEmptyString;
1099 DisplayError(
this, wxString::Format(
_(
"Library '%s' already exists." ), libName ) );
1100 return wxEmptyString;
1107 DisplayError(
this, wxString::Format(
_(
"Could not create the library file '%s'.\n"
1108 "Make sure you have write permissions and "
1110 fn.GetFullPath() ) );
1111 return wxEmptyString;
1118 DisplayError(
this,
_(
"Could not open the library file." ) );
1119 return wxEmptyString;
1126 std::string packet = fn.GetFullPath().ToStdString();
1129 return fn.GetFullPath();
1141 wxFileName fn = wxFileName( aLibFile );
1143 wxString libName = fn.GetName();
1145 if( libName.IsEmpty() )
1150 DisplayError(
this, wxString::Format(
_(
"Library '%s' already exists." ), libName ) );
1156 DisplayError(
this,
_(
"Could not open the library file." ) );
1163 std::string packet = fn.GetFullPath().ToStdString();
1215 std::vector<LIB_ID> ids;
1228 const wxString& aForceRefresh )
1241 [&](
int progress,
int max,
const wxString& libName )
1243 progressDlg.
Update( progress, wxString::Format(
_(
"Loading library '%s'..." ),
1247 else if( !aPreloadCancelled )
1250 [&](
int progress,
int max,
const wxString& libName )
1257 wxDataViewItem found;
1272 if( !found && selected.
IsValid() )
1305 if( aTreeItem.IsOk() )
1316 if( aOriginalFile.FileExists() )
1318 wxFileName backupFileName( aOriginalFile );
1319 backupFileName.SetExt( aBackupExt );
1321 if( backupFileName.FileExists() )
1322 wxRemoveFile( backupFileName.GetFullPath() );
1324 if( !wxCopyFile( aOriginalFile.GetFullPath(), backupFileName.GetFullPath() ) )
1326 DisplayError(
this, wxString::Format(
_(
"Failed to save backup to '%s'." ),
1327 backupFileName.GetFullPath() ) );
1409 bool tree_shown = tree_pane_info.IsShown();
1410 tree_pane_info.Caption(
_(
"Libraries" ) );
1411 tree_pane_info.Show( tree_shown );
1470 item.ClearSelected();
1509 if(
pin->m_Uuid == lastBrightenedItemID )
1513 std::vector<SCH_FIELD*> fields;
1518 if( field->m_Uuid == lastBrightenedItemID )
1523 if( lastItem && lastItem != aItem )
1528 lastBrightenedItemID =
niluuid;
1538 lastBrightenedItemID = aItem->
m_Uuid;
1548 const std::string& payload = mail.
GetPayload();
1553 if( !payload.empty() )
1555 wxString libFileName( payload );
1556 wxString libNickname;
1564 msg.Printf(
_(
"The current configuration does not include the symbol library '%s'." ),
1566 msg += wxS(
"\n" ) +
_(
"Use Manage Symbol Libraries to edit the configuration." );
1573 if( !libTable->
HasLibrary( libNickname,
true ) )
1575 msg.Printf(
_(
"The symbol library '%s' is not enabled in the current configuration." ),
1577 msg += wxS(
"\n" ) +
_(
"Use Manage Symbol Libraries to edit the configuration." );
1586 LIB_ID id( libNickname, wxEmptyString );
1603 if( !currentLib.empty() && libTable && !libTable->
HasLibrary( currentLib,
true ) )
1621 wxLogTrace(
"KICAD_LIB_WATCH",
"Received refresh symbol request for %s",
1624 if( !tbl || !symbol )
1633 wxFileName libfullname( row->
GetFullURI(
true ) );
1636 wxLogTrace(
"KICAD_LIB_WATCH",
1637 "Received refresh symbol request for %s, current symbols is %s",
1638 changedLib.GetFullPath(), libfullname.GetFullPath() );
1640 if( changedLib == libfullname )
1642 wxLogTrace(
"KICAD_LIB_WATCH",
"Refreshing symbol %s", symbol->
GetName() );
1648 wxCHECK2_MSG( lib_symbol,
break, wxString::Format(
"Symbol %s not found in library %s",
1649 symbol->
GetName(), libName ) );
1718 if( aItemCount == 0 )
1723 if( aItemCount < 0 )
1729 for(
int ii = 0; ii < aItemCount; ii++ )
1755 std::unique_ptr<LIB_SYMBOL> symbol = aSymbol->
GetLibSymbolRef()->Flatten();
1758 symbol->SetLibId( aSymbol->
GetLibId() );
1765 std::vector<SCH_FIELD> fullSetOfFields;
1770 SCH_FIELD libField( symbol.get(), field.GetId() );
1782 switch( orientation )
1785 std::swap( pos.
x, pos.
y );
1789 std::swap( pos.
x, pos.
y );
1802 fullSetOfFields.emplace_back( std::move( libField ) );
1805 symbol->SetFields( fullSetOfFields );
1812 m_reference = symbol->GetReferenceField().GetText();
1820 tools->SetDrawSpecificUnit( symbol->UnitsLocked() );
1851 wxFileName fn = aLibFile;
1852 wxFileName libTableFileName(
Prj().GetProjectPath(),
1854 wxString libNickname = fn.GetName();
1865 tmp.Printf(
"%s%d", fn.GetName(), suffix );
1874 wxString normalizedPath =
NormalizePath( aLibFile, &envVars,
Prj().GetProjectPath() );
1882 normalizedPath =
NormalizePath( aLibFile, &envVars, wxEmptyString );
1887 wxCHECK( libTable->
InsertRow( row ),
false );
1891 libTable->
Save( libTableFileName.GetFullPath() );
1895 wxString msg = aScope ==
GLOBAL_LIB_TABLE ?
_(
"Error saving global library table." )
1896 :
_(
"Error saving project library table." );
1898 wxMessageDialog dlg(
this, msg,
_(
"File Save Error" ), wxOK | wxICON_ERROR );
1899 dlg.SetExtendedMessage( ioe.
What() );
1910 const wxString& aLibFile )
1914 bool isGlobalTable =
true;
1922 libTableFileName.SetPath(
Prj().GetProjectPath() );
1925 isGlobalTable =
false;
1926 row = libTable->
FindRow( aLibNickname );
1929 wxCHECK( row,
false );
1931 wxString projectPath;
1933 if( !isGlobalTable )
1936 wxString normalizedPath =
NormalizePath( aLibFile, &envVars, projectPath );
1943 libTable->
Save( libTableFileName.GetFullPath() );
1947 wxString msg = isGlobalTable ?
_(
"Error saving global library table." )
1948 :
_(
"Error saving project library table." );
1950 wxMessageDialog dlg(
this, msg,
_(
"File Save Error" ), wxOK | wxICON_ERROR );
1951 dlg.SetExtendedMessage( ioe.
What() );
1979 eda_text->ClearBoundingBoxCache();
1980 eda_text->ClearRenderCache();
1989 wxAuiPaneInfo& selectionFilterPane =
m_auimgr.GetPane( wxS(
"SelectionFilter" ) );
1993 bool showFilter = ( treePane.IsShown() && treePane.IsDocked() )
1994 || ( propertiesPane.IsShown() && propertiesPane.IsDocked() );
1996 selectionFilterPane.Show( showFilter );
BASE_SCREEN class implementation.
constexpr EDA_IU_SCALE schIUScale
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
static TOOL_ACTION toggleGrid
static TOOL_ACTION cancelInteractive
static TOOL_ACTION millimetersUnits
static TOOL_ACTION unselectAll
static TOOL_ACTION revert
static TOOL_ACTION showLibraryTree
static TOOL_ACTION showDatasheet
static TOOL_ACTION milsUnits
static TOOL_ACTION toggleBoundingBoxes
static TOOL_ACTION saveAll
static TOOL_ACTION duplicate
static TOOL_ACTION inchesUnits
static TOOL_ACTION toggleCursorStyle
static TOOL_ACTION doDelete
static TOOL_ACTION selectionTool
static TOOL_ACTION zoomFitScreen
static TOOL_ACTION deleteTool
static TOOL_ACTION zoomTool
static TOOL_ACTION showProperties
static TOOL_ACTION ddAddLibrary
static TOOL_ACTION copyAsText
static TOOL_ACTION toggleGridOverrides
static TOOL_ACTION selectAll
Manage TOOL_ACTION objects.
void SetConditions(const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
Set the conditions the UI elements for activating a specific tool action should use for determining t...
wxProgressDialog with the option to also update the application progress on the taskbar
virtual bool Update(int aValue, const wxString &aNewMsg=wxEmptyString, bool *aSkip=nullptr) override
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
wxString m_ColorTheme
Active color theme name.
Handles how to draw a screen (a board, a schematic ...)
void SetContentModified(bool aModified=true)
constexpr void SetOrigin(const Vec &pos)
constexpr void SetSize(const SizeVec &size)
Color settings are a bit different than most of the settings objects in that there can be more than o...
COLOR4D GetColor(int aLayer) const
Handle actions that are shared between different applications.
UNDO_REDO_CONTAINER m_undoList
void ShowChangedLanguage() override
Redraw the menus and what not in current language.
virtual void setupUIConditions()
Setup the UI conditions for the various actions and their controls in this frame.
virtual void ClearUndoRedoList()
Clear the undo and redo list using ClearUndoORRedoList()
SETTINGS_MANAGER * GetSettingsManager() const
UNDO_REDO_LIST
Specify whether we are interacting with the undo or redo stacks.
virtual void OnModify()
Must be called after a model change in order to set the "modify" flag and do other frame-specific pro...
virtual void RecreateToolbars()
UNDO_REDO_CONTAINER m_redoList
virtual void OnDropFiles(wxDropFilesEvent &aEvent)
Handle event fired when a file is dropped to the window.
bool m_isClosing
Set by the close window event handler after frames are asked if they can close.
void ReCreateMenuBar()
Recreate the menu bar.
WX_INFOBAR * GetInfoBar()
COLOR_SETTINGS * m_colorSettings
bool LibraryFileBrowser(bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false, bool aIsGlobal=false, const wxString &aGlobalPath=wxEmptyString)
virtual void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Change the current rendering backend.
GAL_DISPLAY_OPTIONS_IMPL & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
static const wxString PropertiesPaneName()
void FocusOnLocation(const VECTOR2I &aPos)
Useful to focus on a particular location, in find functions.
virtual void SetScreen(BASE_SCREEN *aScreen)
PROPERTIES_PANEL * m_propertiesPanel
void ForceRefresh()
Force a redraw.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Set a dispatcher that processes events and forwards them to tools.
A base class for most all the KiCad significant classes used in schematics and boards.
virtual const VECTOR2I GetFocusPosition() const
Similar to GetPosition() but allows items to return their visual center rather than their anchor.
bool IsBrightened() const
Specialization of the wxAuiPaneInfo class for KiCad panels.
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
virtual const wxString & GetText() const
Return the string associated with the text object.
Class that groups generic conditions for editor states.
SELECTION_CONDITION NoActiveTool()
Create a functor testing if there are no tools active in the frame.
SELECTION_CONDITION BoundingBoxes()
SELECTION_CONDITION RedoAvailable()
Create a functor that tests if there are any items in the redo queue.
SELECTION_CONDITION CurrentTool(const TOOL_ACTION &aTool)
Create a functor testing if the specified tool is the current active tool in the frame.
virtual SELECTION_CONDITION UndoAvailable()
Create a functor that tests if there are any items in the undo queue.
SELECTION_CONDITION Units(EDA_UNITS aUnit)
Create a functor that tests if the frame has the specified units.
SELECTION_CONDITION GridVisible()
Create a functor testing if the grid is visible in a frame.
SELECTION_CONDITION GridOverrides()
Create a functor testing if the grid overrides wires is enabled in a frame.
SELECTION_CONDITION FullscreenCursor()
Create a functor testing if the cursor is full screen in a frame.
void ReadWindowSettings(WINDOW_SETTINGS &aCfg)
Read GAL config options from application-level config.
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()
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
bool m_axesEnabled
Fullscreen crosshair or small cross.
void SetAxesEnabled(bool aAxesEnabled)
Enable drawing the axes.
void SetAxesColor(const COLOR4D &aAxesColor)
Set the axes color.
void SetDefaultFont(const wxString &aFont)
void ClearHiddenFlags()
Clear the hide flag of all items in the view.
void Clear()
Remove all items from the view.
void UpdateAllItems(int aUpdateFlags)
Update all items in the view according to the given flags.
Carry a payload from one KIWAY_PLAYER to another within a PROJECT.
std::string & GetPayload()
Return the payload, which can be any text but it typically self identifying s-expression.
MAIL_T Command()
Returns the MAIL_T associated with this mail.
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
Send aPayload to aDestination from aSource.
Module editor specific tools.
A logical library item identifier and consists of various portions much like a URI.
int SetLibItemName(const UTF8 &aLibItemName)
Override the library item name portion of the LIB_ID to aLibItemName.
bool IsValid() const
Check if this LID_ID is valid.
const UTF8 & GetLibItemName() const
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
const wxString GetFullLibraryName() const
Symbol library management helper that is specific to the symbol library editor frame.
void Sync(const wxString &aForceRefresh, std::function< void(int, int, const wxString &)> aProgressCallback)
Updates the SYMBOL_LIBRARY_MANAGER data to synchronize with Symbol Library Table.
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > & GetAdapter()
Return the adapter object that provides the stored data.
Define a library symbol object.
const LIB_ID & GetLibId() const override
bool IsMulti() const override
std::vector< SCH_PIN * > GetPins(int aUnit, int aBodyStyle) const
Return a list of pin object pointers from the draw item list.
void GetFields(std::vector< SCH_FIELD * > &aList, bool aVisibleOnly=false) const override
Populate a std::vector with SCH_FIELDs, sorted in ordinal order.
bool UnitsLocked() const
Check whether symbol units are interchangeable.
SCH_FIELD & GetDatasheetField()
Return reference to the datasheet field.
bool IsRoot() const override
For symbols derived from other symbols, IsRoot() indicates no derivation.
wxString GetUnitDisplayName(int aUnit) override
Return the user-defined display name for aUnit for symbols with units.
LIB_ITEMS_CONTAINER & GetDrawItems()
Return a reference to the draw item list.
wxString GetName() const override
wxString GetLibNickname() const override
Sets the Description field text value.
int GetUnitCount() const override
std::unique_ptr< LIB_SYMBOL > Flatten() const
Return a flattened symbol inheritance to the caller.
LIB_SYMBOL_SPTR GetRootSymbol() const
Get the parent symbol that does not have another parent.
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
void SetFullURI(const wxString &aFullURI)
Change the full URI for the library.
void SetNickName(const wxString &aNickName)
Change the logical name of this library, useful for an editor.
const wxString & GetNickName() const
const wxString GetFullURI(bool aSubstituted=false) const
Return the full location specifying URI for the LIB, either in original UI form or in environment var...
bool HasLibrary(const wxString &aNickname, bool aCheckEnabled=false) const
Test for the existence of aNickname in the library table.
bool InsertRow(LIB_TABLE_ROW *aRow, bool doReplace=false)
Adds aRow if it does not already exist or if doReplace is true.
const LIB_TABLE_ROW * FindRowByURI(const wxString &aURI)
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
void RefreshLibTree()
Refresh the tree (mainly to update highlighting and asterisking)
void CenterLibId(const LIB_ID &aLibId)
Ensure that an item is visible (preferably centered).
int GetSelectionCount() const
void ShowChangedLanguage()
void FocusSearchFieldIfExists()
Focus the search widget if it exists.
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
LIB_TREE_MODEL_ADAPTER::SORT_MODE GetSortMode() const
int GetSelectedLibIds(std::vector< LIB_ID > &aSelection, std::vector< int > *aUnit=nullptr) const
Retrieve a list of selections for trees that allow multi-selection.
void Unselect()
Unselect currently selected item in wxDataViewCtrl.
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit symbols, if the user selects the symbol itself rather than picking an individual unit,...
void ExpandLibId(const LIB_ID &aLibId)
Expand and item i the tree widget.
void Regenerate(bool aKeepState)
Regenerate the tree.
static wxString GetDefaultUserSymbolsPath()
Gets the default path we point users to create projects.
virtual ENV_VAR_MAP & GetLocalEnvVariables() const
virtual SETTINGS_MANAGER & GetSettingsManager() const
A holder to handle information on schematic or board items.
void ClearListAndDeleteItems(std::function< void(EDA_ITEM *)> aItemDeleter)
Delete the list of pickers AND the data pointed by #m_PickedItem or #m_PickedItemLink according to th...
bool IsCancelled() const override
static SYMBOL_LIB_TABLE * SchSymbolLibTable(PROJECT *aProject)
Accessor for project symbol library table.
virtual const wxString GetProjectPath() const
Return the full path of the project.
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...
float SplitterProportion() const
Gather all the actions that are shared by tools.
static TOOL_ACTION rotateCCW
static TOOL_ACTION importSymbol
static TOOL_ACTION newSymbol
static TOOL_ACTION saveLibraryAs
static TOOL_ACTION mirrorV
static TOOL_ACTION clearSelection
Clears the current selection.
static TOOL_ACTION editLibSymbolWithLibEdit
static TOOL_ACTION showDeMorganAlternate
static TOOL_ACTION drawArc
static TOOL_ACTION pinTable
static TOOL_ACTION drawSymbolLines
static TOOL_ACTION placeSymbolPin
static TOOL_ACTION drawSymbolTextBox
static TOOL_ACTION drawRectangle
static TOOL_ACTION drawCircle
static TOOL_ACTION importGraphics
static TOOL_ACTION drawBezier
static TOOL_ACTION saveSymbolCopyAs
static TOOL_ACTION rotateCW
static TOOL_ACTION showElectricalTypes
static TOOL_ACTION drawSymbolPolygon
static TOOL_ACTION showHiddenFields
static TOOL_ACTION placeSymbolAnchor
static TOOL_ACTION showHiddenPins
static TOOL_ACTION setUnitDisplayName
static TOOL_ACTION mirrorH
static TOOL_ACTION runERC
Inspection and Editing.
static TOOL_ACTION symbolProperties
static TOOL_ACTION placeSymbolText
static TOOL_ACTION toggleSyncedPinsMode
static TOOL_ACTION togglePinAltIcons
static TOOL_ACTION showDeMorganStandard
static TOOL_ACTION saveSymbolAs
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
SCH_RENDER_SETTINGS * GetRenderSettings()
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
SYMBOL_EDITOR_SETTINGS * libeditconfig() const
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
SYMBOL_LIB_TABLE * SelectSymLibTable(bool aOptional=false)
Display a dialog asking the user to select a symbol library table.
void CommonSettingsChanged(int aFlags) override
Notification event that some of the common (suite-wide) settings have changed.
bool saveSymbolLibTables(bool aGlobal, bool aProject)
Save Symbol Library Tables to disk.
virtual void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false, bool aUpdateRtree=false)
Mark an item for refresh.
void setSymWatcher(const LIB_ID *aSymbol)
Creates (or removes) a watcher on the specified symbol library.
KIGFX::SCH_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
void DisplaySymbol(LIB_SYMBOL *aSymbol)
Schematic editor (Eeschema) main window.
void SaveSymbolToSchematic(const LIB_SYMBOL &aSymbol, const KIID &aSchematicSymbolUUID)
Update a schematic symbol from a LIB_SYMBOL.
void SetPosition(const VECTOR2I &aPosition) override
static const wxString ShowType(SCH_FILE_T aFileType)
Return a brief name for a plugin, given aFileType enum.
Base class for any item which can be embedded within the SCHEMATIC container class,...
virtual void ClearCaches()
Tool that displays edit points allowing to modify items by dragging the points.
bool m_ShowPinsElectricalType
bool m_ShowGraphicsDisabled
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly) const override
Populate a std::vector with SCH_FIELDs, sorted in ordinal order.
VECTOR2I GetPosition() const override
const LIB_ID & GetLibId() const override
int GetOrientation() const override
Get the display symbol orientation.
std::unique_ptr< LIB_SYMBOL > & GetLibSymbolRef()
static bool Idle(const SELECTION &aSelection)
Test if there no items selected or being edited.
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieve a color settings object that applications can read colors from.
T * GetToolbarSettings(const wxString &aFilename)
Return a handle to the given toolbar settings.
T * GetAppSettings(const wxString &aFilename)
Return a handle to the a given settings by type.
Handle actions for the various symbol editor and viewers.
bool m_ShowPinElectricalType
SCH_SELECTION_FILTER_OPTIONS m_SelectionFilter
bool m_ShowPinAltIcons
When true, dragging an outline edge will drag pins rooted on it.
The symbol library editor main window.
bool m_isSymbolFromSchematic
void OnExitKiCad(wxCommandEvent &event)
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
std::unique_ptr< GRID_HELPER > MakeGridHelper() override
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false, bool aUpdateRtree=false) override
Mark an item for refresh.
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
APP_SETTINGS_BASE * config() const override
Return 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.
bool IsLibraryTreeShown() const override
const BOX2I GetDocumentExtents(bool aIncludeAllVisible=true) const override
Return bounding box 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 GetShowInvisibleFields()
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 CommonSettingsChanged(int aFlags) override
Called after the preferences dialog is run.
void FocusLibraryTreeInput() 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.
void FocusOnLibId(const LIB_ID &aLibID)
bool IsSymbolAlias() const
Return true if aLibId is an alias for the editor screen symbol.
void ToggleProperties() override
SYMBOL_EDITOR_SETTINGS * m_settings
void HardRedraw() override
Rebuild the GAL and redraw the screen.
bool GetShowDeMorgan() 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 SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
bool CanCloseSymbolFromSchematic(bool doClose)
void RebuildSymbolUnitsList()
bool IsSymbolFromLegacyLibrary() const
bool replaceLibTableEntry(const wxString &aLibNickname, const wxString &aLibFile)
Replace the file path of the symbol library table entry aLibNickname with aLibFile.
bool IsSymbolFromSchematic() const
static bool m_showDeMorgan
void SetScreen(BASE_SCREEN *aScreen) override
SYMBOL_EDITOR_SETTINGS * GetSettings() const
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
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 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
LIB_ID GetTargetLibId() const override
Return either the symbol selected in the symbol tree (if context menu is active) or the symbol on the...
int m_bodyStyle
Flag if the symbol being edited was loaded directly from a schematic.
bool saveAllLibraries(bool aRequireConfirmation)
Save the current symbol.
bool GetShowInvisiblePins()
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.
LIB_TREE * GetLibTree() const override
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.
bool LoadSymbolFromCurrentLib(const wxString &aSymbolName, int aUnit=0, int aBodyStyle=0)
Load a symbol from the current active library, optionally setting the selected unit and convert.
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.
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Returns a pointer to the active color theme settings.
LIB_SYMBOL_LIBRARY_MANAGER & GetLibManager()
void SaveSymbolCopyAs(bool aOpenCopy)
Save the currently selected symbol to a new name and/or location.
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.
~SYMBOL_EDIT_FRAME() override
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 ToggleLibraryTree() 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)
bool IsLibraryReadOnly(const wxString &aLibrary) const
Return true if the library is stored in a read-only file.
bool LibraryExists(const wxString &aLibrary, bool aCheckEnabled=false) const
Return true if library exists.
LIB_SYMBOL * GetBufferedSymbol(const wxString &aSymbolName, const wxString &aLibrary)
Return the symbol copy from the buffer.
SCH_SCREEN * GetScreen(const wxString &aSymbolName, const wxString &aLibrary)
Return the screen used to edit a specific symbol.
bool AddLibrary(const wxString &aFilePath, SYMBOL_LIB_TABLE &aTable)
Add an existing library.
bool IsLibraryModified(const wxString &aLibrary) const
Return true if library has unsaved modifications.
LIB_SYMBOL * GetSymbol(const wxString &aSymbolName, 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...
wxArrayString GetLibraryNames() const
Return the array of library names.
wxString GetUniqueLibraryName() const
Return a library name that is not currently in use.
bool CreateLibrary(const wxString &aFilePath, SYMBOL_LIB_TABLE &aTable)
Create an empty library and adds it to the library table.
bool HasModifications() const
bool IsSymbolModified(const wxString &aSymbolName, const wxString &aLibrary) const
Return true if symbol has unsaved modifications.
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 UpdateLibraryBuffer(const wxString &aLibrary)
Update the library buffer with a new version of the library.
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_IO object i...
void SetType(const wxString &aType) override
Change the schematic plugin type represented by this row.
const wxString GetType() const override
Return the type of symbol library table represented by this row.
static SYMBOL_LIB_TABLE & GetGlobalLibTable()
static const wxString GetSymbolLibTableFileName()
static wxString GetGlobalTableFileName()
Fetch the global symbol library table file name.
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
Library Editor pane with symbol tree and symbol library table selector.
A holder to handle a list of undo (or redo) commands.
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
A modified version of the wxInfoBar class that allows us to:
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
void AddButton(wxButton *aButton)
Add an already created button to the infobar.
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Multi-thread safe progress reporter dialog, intended for use of tasks that parallel reporting back of...
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.
void DisplayError(wxWindow *aParent, const wxString &aText)
Display an error or warning message box with aMessage.
This file is part of the common library.
static bool empty(const wxTextEntryBase *aCtrl)
#define KICAD_DEFAULT_DRAWFRAME_STYLE
#define LIB_EDIT_FRAME_NAME
@ ID_LIBEDIT_SELECT_UNIT_NUMBER
const wxAuiPaneInfo & defaultSchSelectionFilterPaneInfo(wxWindow *aWindow)
const wxAuiPaneInfo & defaultPropertiesPaneInfo(wxWindow *aWindow)
wxString NormalizePath(const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
Normalize a file path to an environmental variable, if possible.
Helper functions to substitute paths with environmental variables.
@ FRAME_SCH_SYMBOL_EDITOR
static const std::string KiCadSymbolLibFileExtension
static wxString KiCadSymbolLibFileWildcard()
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
This file is part of the common library.
@ LAYER_SCHEMATIC_GRID_AXES
@ ALL
All except INITIAL_ADD.
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
void InvokeSchEditSymbolLibTable(KIWAY *aKiway, wxWindow *aParent)
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
PGM_BASE & Pgm()
The global program "get" accessor.
KIWAY Kiway(KFCTL_STANDALONE)
wxString UnescapeString(const wxString &aSource)
Functors that can be used to figure out how the action controls should be displayed in the UI and if ...
ACTION_CONDITIONS & Enable(const SELECTION_CONDITION &aCondition)
ACTION_CONDITIONS & Check(const SELECTION_CONDITION &aCondition)
constexpr int mmToIU(double mm) const
float properties_splitter
int properties_panel_width
Definition for symbol library class.
VECTOR2< int32_t > VECTOR2I
VECTOR2< double > VECTOR2D
Definition of file extensions used in Kicad.
void SetAuiPaneSize(wxAuiManager &aManager, wxAuiPaneInfo &aPane, int aWidth, int aHeight)
Sets the size of an AUI pane, working around http://trac.wxwidgets.org/ticket/13180.