54#include <wx/choicdlg.h>
55#include <wx/filedlg.h>
56#include <wx/fswatcher.h>
63 _(
"Writing/modifying legacy libraries (.mod files) is not allowed\n"\
64 "Please save the current library to the new .pretty format\n"\
65 "and update your footprint lib table\n"\
66 "to save your footprint (a .kicad_mod file) in the .pretty library folder" ) );
69 _(
"Modifying legacy libraries (.mod files) is not allowed\n"\
70 "Please save the current library under the new .pretty format\n"\
71 "and update your footprint lib table\n"\
72 "before deleting a footprint" ) );
86 static int lastFilterIndex = 0;
87 wxString fileFiltersStr;
88 std::vector<std::string> allExtensions;
89 std::set<wxString> allWildcardsSet;
103 if( !fileFiltersStr.IsEmpty() )
104 fileFiltersStr += wxChar(
'|' );
110 allExtensions.emplace_back( ext );
115 wxString allWildcardsStr;
116 for(
const wxString& wildcard : allWildcardsSet )
117 allWildcardsStr << wildcard;
119 fileFiltersStr =
_(
"All supported formats" ) + wxT(
"|" ) + allWildcardsStr + wxT(
"|" )
122 wxFileDialog dlg(
this,
_(
"Import Footprint" ),
m_mruPath, wxEmptyString, fileFiltersStr,
123 wxFD_OPEN | wxFD_FILE_MUST_EXIST );
125 dlg.SetFilterIndex( lastFilterIndex );
127 if( dlg.ShowModal() == wxID_CANCEL )
130 lastFilterIndex = dlg.GetFilterIndex();
138 if( !wxFileExists( fn.GetFullPath() ) )
140 wxString msg = wxString::Format(
_(
"File '%s' not found." ), fn.GetFullPath() );
156 if( pi->GetLibraryFileDesc().m_FileExtensions.empty() )
159 if( pi->CanReadFootprint( fn.GetFullPath() ) )
173 wxString footprintName;
179 footprint = pi->ImportFootprint( fn.GetFullPath(), footprintName);
183 wxString msg = wxString::Format(
_(
"Unable to load footprint '%s' from '%s'" ),
184 footprintName, fn.GetFullPath() );
202 footprint->
SetFPID(
LIB_ID( wxEmptyString, footprintName ) );
239 wxFileDialog dlg(
this,
_(
"Export Footprint" ), fn.GetPath(), fn.GetFullName(),
240 wildcard, wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
242 if( dlg.ShowModal() == wxID_CANCEL )
262 pcb_io.
Format( aFootprint );
264 FILE* fp = wxFopen( dlg.GetPath(), wxT(
"wt" ) );
268 DisplayErrorMessage(
this, wxString::Format(
_(
"Insufficient permissions to write file '%s'." ),
282 wxString msg = wxString::Format(
_(
"Footprint exported to file '%s'." ), dlg.GetPath() );
288 const wxString& aProposedName )
295 const wxString& aProposedName )
304 const wxString& aProposedName,
311 if( aTable ==
nullptr )
312 return wxEmptyString;
314 wxString initialPath = aProposedName.IsEmpty() ?
Prj().
GetProjectPath() : aProposedName;
319 if( aLibName.IsEmpty() )
327 return wxEmptyString;
336 if( !fn.IsAbsolute() )
338 fn.SetName( aLibName );
339 fn.MakeAbsolute( initialPath );
345 wxString libPath = fn.GetFullPath();
351 bool writable =
false;
356 writable = pi->IsLibraryWritable( libPath );
368 wxString msg = wxString::Format(
_(
"Library %s is read only." ), libPath );
370 return wxEmptyString;
374 wxString msg = wxString::Format(
_(
"Library %s already exists." ), libPath );
375 KIDIALOG dlg(
this, msg,
_(
"Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
376 dlg.SetOKLabel(
_(
"Overwrite" ) );
380 return wxEmptyString;
382 pi->DeleteLibrary( libPath );
386 pi->CreateLibrary( libPath );
391 return wxEmptyString;
404 if(
Prj().IsNullProject() )
410 wxMessageDialog dlg(
this,
_(
"Add the library to the global library table?" ),
411 _(
"Add To Global Library Table" ), wxYES_NO );
413 if( dlg.ShowModal() != wxID_OK )
420 wxArrayString libTableNames;
421 libTableNames.Add(
_(
"Global" ) );
422 libTableNames.Add(
_(
"Project" ) );
424 wxSingleChoiceDialog dlg(
this,
_(
"Choose the Library Table to add the library to:" ),
425 _(
"Add To Library Table" ), libTableNames );
429 dlg.FindWindow( wxID_CANCEL )->SetLabel(
_(
"Skip" ) );
430 dlg.FindWindow( wxID_OK )->SetLabel(
_(
"Add" ) );
433 if( dlg.ShowModal() != wxID_OK )
436 switch( dlg.GetSelection() )
440 default:
return nullptr;
447 if( aTable ==
nullptr )
450 if( aTable ==
nullptr )
451 return wxEmptyString;
455 wxFileName fn( aFilename );
457 if( aFilename.IsEmpty() )
467 wxString libPath = fn.GetFullPath();
468 wxString libName = fn.GetName();
470 if( libName.IsEmpty() )
484 libName = fn.GetFullName();
509 LIB_ID libID( libName, wxEmptyString );
510 editor->SyncLibraryTree(
true );
511 editor->FocusOnLibID( libID );
517 viewer->ReCreateLibraryList();
543 wxString msg = wxString::Format(
_(
"Library '%s' is read only." ), nickname );
549 wxString msg = wxString::Format(
_(
"Delete footprint '%s' from library '%s'?" ),
551 nickname.GetData() );
553 if( aConfirm && !
IsOK(
this, msg ) )
566 msg.Printf(
_(
"Footprint '%s' deleted from library '%s'" ),
568 nickname.GetData() );
570 SetStatusText( msg );
579 if(
GetBoard()->GetFirstFootprint() ==
nullptr )
585 wxString footprintName;
587 auto resetReference =
590 aFootprint->SetReference(
"REF**" );
597 parentGroup->RemoveItem( aFootprint );
600 if( !aStoreInNewLib )
610 bool map =
IsOK(
this, wxString::Format(
_(
"Update footprints on board to refer to %s?" ),
621 if( !footprint->GetFPID().GetLibItemName().empty() )
626 resetReference( fpCopy );
627 resetGroup( fpCopy );
641 LIB_ID id = footprint->GetFPID();
643 footprint->SetFPID(
id );
653 if( libPath.IsEmpty() )
659 wxString libNickname;
660 bool map =
IsOK(
this,
_(
"Update footprints on board to refer to new library?" ) );
677 if( !footprint->GetFPID().GetLibItemName().empty() )
682 resetReference( fpCopy );
683 resetGroup( fpCopy );
685 pi->FootprintSave( libPath, fpCopy );
697 LIB_ID id = footprint->GetFPID();
699 footprint->SetFPID(
id );
732 else if( libraryName.IsEmpty() || footprintName.IsEmpty() )
750 wxString libfullname;
805 wxString newName = footprintName;
809 newName.Printf(
"%s_%d", footprintName, i++ );
813 if( aFootprint->
GetValue() == footprintName )
821 const wxString& aLibraryName )
831 if( aFootprint ==
GetBoard()->GetFirstFootprint() )
852 if( pcbframe ==
nullptr )
866 sourceFootprint =
nullptr;
870 if( editorFootprint->
GetLink() == candidate->m_Uuid )
872 sourceFootprint = candidate;
878 if( !aAddNew && sourceFootprint ==
nullptr )
880 DisplayError(
this,
_(
"Unable to find the footprint on the main board.\nCannot save." ) );
888 DisplayError(
this,
_(
"Previous footprint placement still in progress." ) );
910 fixUuid(
const_cast<KIID&
>( newFootprint->
m_Uuid ) );
915 fixUuid(
const_cast<KIID&
>( aChild->
m_Uuid ) );
923 if( sourceFootprint )
929 commit.
Push(
_(
"Update Footprint" ) );
936 commit.
Add( newFootprint );
942 commit.
Push(
_(
"Insert Footprint" ) );
961 const wxString& aLibraryPreselect,
962 std::function<
bool( wxString libName, wxString fpName )> aValidator ) :
970 wxArrayString headers;
971 std::vector<wxArrayString> itemsToDisplay;
973 headers.Add(
_(
"Nickname" ) );
974 headers.Add(
_(
"Description" ) );
976 for(
const wxString& nickname : nicknames )
985 itemsToDisplay.push_back( item );
989 for(
const wxString& nickname : nicknames )
996 item.Add( nickname );
998 itemsToDisplay.push_back( item );
1001 initDialog( headers, itemsToDisplay, aLibraryPreselect );
1006 wxBoxSizer* bNameSizer =
new wxBoxSizer( wxHORIZONTAL );
1008 wxStaticText* label =
new wxStaticText(
this, wxID_ANY,
_(
"Name:" ) );
1009 bNameSizer->Add( label, 0, wxALIGN_CENTER_VERTICAL|wxTOP|wxBOTTOM|wxLEFT, 5 );
1011 m_fpNameCtrl =
new wxTextCtrl(
this, wxID_ANY, aFootprintName );
1012 bNameSizer->Add(
m_fpNameCtrl, 1, wxALIGN_CENTER_VERTICAL|wxALL, 5 );
1014 wxTextValidator nameValidator( wxFILTER_EXCLUDE_CHAR_LIST );
1020 m_ButtonsSizer->Prepend( newLibraryButton, 0, wxALIGN_CENTER_VERTICAL|wxLEFT|wxRIGHT, 10 );
1022 GetSizer()->Prepend( bNameSizer, 0, wxEXPAND|wxTOP|wxLEFT|wxRIGHT, 5 );
1025 [
this]( wxCommandEvent& )
1039 GetSizer()->Fit(
this );
1047 footprintName.Trim(
true );
1048 footprintName.Trim(
false );
1049 return footprintName;
1066 if( aFootprint ==
nullptr )
1075 bool updateValue = aFootprint->
GetValue() == footprintName;
1077 bool footprintExists =
false;
1082 [&](
const wxString& newLib,
const wxString& newName )
1084 if( newLib.IsEmpty() )
1086 wxMessageBox( _(
"A library must be specified." ) );
1090 if( newName.IsEmpty() )
1092 wxMessageBox( _(
"Footprint must have a name." ) );
1110 if( footprintExists )
1112 wxString msg = wxString::Format(
_(
"Footprint %s already exists in %s." ),
1116 KIDIALOG errorDlg(
this, msg,
_(
"Confirmation" ),
1117 wxOK | wxCANCEL | wxICON_WARNING );
1118 errorDlg.SetOKLabel(
_(
"Overwrite" ) );
1126 int ret = dlg.ShowModal();
1128 if( ret == wxID_CANCEL )
1132 else if( ret == wxID_OK )
1135 libraryName = dlg.GetTextSelection();
1141 libraryName = newLibrary.GetName();
1145 aFootprint->
SetFPID(
LIB_ID( libraryName, footprintName ) );
1148 aFootprint->
SetValue( footprintName );
1156 wxString fmt = footprintExists ?
_(
"Footprint '%s' replaced in '%s'" )
1157 :
_(
"Footprint '%s' added to '%s'" );
1159 wxString msg = wxString::Format( fmt, footprintName.GetData(), libraryName.GetData() );
1160 SetStatusText( msg );
1172 wxString msg = wxString::Format(
_(
"Revert '%s' to last version saved?" ),
1202 std::function<
bool( wxString newName )> aValidator ) :
1204 aName,
_(
"Footprint type:" ),
1205 {
_(
"Through hole" ),
_(
"SMD" ),
_(
"Other" ) },
1213 name.Trim(
true ).Trim(
false );
1229 const wxString& aLibName,
bool aQuiet )
1232 wxString footprintName = aFootprintName;
1236 static int footprintType = 1;
1237 int footprintTranslated =
FP_SMD;
1240 if( footprintName.IsEmpty() && !aQuiet )
1243 [&]( wxString newName )
1245 if( newName.IsEmpty() )
1247 wxMessageBox( _(
"Footprint must have a name." ) );
1251 if( !aLibName.IsEmpty() && tbl->
FootprintExists( aLibName, newName ) )
1253 msg = wxString::Format( _(
"Footprint '%s' already exists in library '%s'." ),
1254 newName, aLibName );
1256 KIDIALOG errorDlg( this, msg, _(
"Confirmation" ),
1257 wxOK | wxCANCEL | wxICON_WARNING );
1258 errorDlg.SetOKLabel( _(
"Overwrite" ) );
1260 return errorDlg.ShowModal() == wxID_OK;
1268 if( dlg.ShowModal() != wxID_OK )
1271 footprintName = dlg.GetFPName();
1272 footprintType = dlg.GetChoice();
1274 switch( footprintType )
1277 case 1: footprintTranslated =
FP_SMD;
break;
1278 default: footprintTranslated = 0;
break;
1286 footprint->
SetFPID(
LIB_ID( wxEmptyString, footprintName ) );
1326 if( footprint->
GetValue().IsEmpty() )
1327 footprint->
SetValue( footprintName );
1351 wxArrayString headers;
1353 headers.Add(
_(
"Nickname" ) );
1354 headers.Add(
_(
"Description" ) );
1359 std::vector< wxArrayString > itemsToDisplay;
1362 for(
const wxString& nickname : nicknames )
1371 itemsToDisplay.push_back( item );
1375 for(
const wxString& nickname : nicknames )
1382 item.Add( nickname );
1384 itemsToDisplay.push_back( item );
1388 EDA_LIST_DIALOG dlg(
this,
_(
"Select Library" ), headers, itemsToDisplay, aNicknameExisting,
1391 if( dlg.ShowModal() != wxID_OK )
1392 return wxEmptyString;
void SetContentModified(bool aModified=true)
virtual void Push(const wxString &aMessage=wxEmptyString, int aCommitFlags=0) override
Revert the commit by restoring the modified items state.
Container for design settings for a BOARD object.
std::vector< TEXT_ITEM_INFO > m_DefaultFPTextItems
bool GetTextUpright(PCB_LAYER_ID aLayer) const
int GetTextThickness(PCB_LAYER_ID aLayer) const
Return the default text thickness from the layer class for the given layer.
bool GetTextItalic(PCB_LAYER_ID aLayer) const
VECTOR2I GetTextSize(PCB_LAYER_ID aLayer) const
Return the default text size from the layer class for the given layer.
Handle actions specific to the board editor in PcbNew.
bool PlacingFootprint() const
Re-entrancy checker for above.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
PCB_GROUP * GetParentGroup() const
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Information pertinent to a Pcbnew printed circuit board.
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
FOOTPRINTS & Footprints()
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
COMMIT & Add(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been added.
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
void SetupStandardButtons(std::map< int, wxString > aLabels={})
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 SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
bool LibraryFileBrowser(bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false, bool aIsGlobal=false, const wxString &aGlobalPath=wxEmptyString)
virtual void Zoom_Automatique(bool aWarpPointer)
Redraw the screen with best zoom level and the best centering that shows all the page or the board.
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
KICAD_T Type() const
Returns the type of object.
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
virtual void SetParent(EDA_ITEM *aParent)
wxBoxSizer * m_ButtonsSizer
void SetOKLabel(const wxString &aLabel)
void initDialog(const wxArrayString &aItemHeaders, const std::vector< wxArrayString > &aItemList, const wxString &aPreselectText)
wxString GetTextSelection(int aColumn=0)
Return the selected text from aColumn in the wxListCtrl in the dialog.
void SetListLabel(const wxString &aLabel)
void SetTextSize(VECTOR2I aNewSize, bool aEnforceMinTextSize=true)
virtual void SetVisible(bool aVisible)
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
void SetKeepUpright(bool aKeepUpright)
virtual void SetText(const wxString &aText)
void SetItalic(bool aItalic)
Hold a record identifying a library accessed by the appropriate footprint library #PLUGIN object in t...
const FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an FP_LIB_TABLE_ROW if aNickName is found in this table or in any chained fall back table frag...
void FootprintDelete(const wxString &aNickname, const wxString &aFootprintName)
Delete the aFootprintName from the library given by aNickname.
bool FootprintExists(const wxString &aNickname, const wxString &aFootprintName)
Indicates whether or not the given footprint already exists in the given library.
SAVE_T FootprintSave(const wxString &aNickname, const FOOTPRINT *aFootprint, bool aOverwrite=true)
Write aFootprint to an existing library given by aNickname.
static wxString GetGlobalTableFileName()
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.
void DoNotShowCheckbox(wxString file, int line)
Checks the 'do not show again' setting for the dialog.
An interface for classes handling user events controlling the view behavior such as zooming,...
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Move the graphic crosshair cursor to the requested position expressed in world coordinates.
VECTOR2D GetCursorPosition() const
Return the current cursor position in world coordinates.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
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.
A logical library item identifier and consists of various portions much like a URI.
bool IsValid() const
Check if this LID_ID is valid.
int SetLibNickname(const UTF8 &aLibNickname)
Override the logical library name portion of the LIB_ID to aLibNickname.
const UTF8 & GetLibItemName() const
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
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...
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.
bool InsertRow(LIB_TABLE_ROW *aRow, bool doReplace=false)
Adds aRow if it does not already exist or if doReplace is true.
wxString GetFullURI(const wxString &aLibNickname, bool aExpandEnvVars=true) const
Return the full URI of the library mapped to aLibNickname.
const LIB_TABLE_ROW * FindRowByURI(const wxString &aURI)
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
static const wxString GetPinningSymbol()
NEW_FP_DIALOG(PCB_BASE_FRAME *aParent, const wxString &aName, int aFootprintType, std::function< bool(wxString newName)> aValidator)
std::function< bool(wxString newName)> m_validator
bool TransferDataFromWindow() override
static wxString GetDefaultUserFootprintsPath()
Gets the default path we point users to create projects.
static TOOL_ACTION recombinePad
static TOOL_ACTION selectionClear
Clear the current selection.
static TOOL_ACTION placeFootprint
bool AddLibrary(const wxString &aLibName=wxEmptyString, FP_LIB_TABLE *aTable=nullptr)
Add an existing library to either the global or project library table.
wxString CreateNewLibrary(const wxString &aLibName=wxEmptyString, const wxString &aProposedName=wxEmptyString)
If a library name is given, creates a new footprint library in the project folder with the given name...
wxString createNewLibrary(const wxString &aLibName, const wxString &aProposedName, FP_LIB_TABLE *aTable)
Create a new library in the given table (presumed to be either the global or project library table).
wxString CreateNewProjectLibrary(const wxString &aLibName=wxEmptyString, const wxString &aProposedName=wxEmptyString)
FP_LIB_TABLE * selectLibTable(bool aOptional=false)
Prompts a user to select global or project library tables.
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
void setFPWatcher(FOOTPRINT *aFootprint)
Creates (or removes) a watcher on the specified footprint.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
wxString SelectLibrary(const wxString &aNicknameExisting)
Put up a dialog and allows the user to pick a library, for unspecified use.
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
virtual BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Returns the BOARD_DESIGN_SETTINGS for the open project.
void PlaceFootprint(FOOTPRINT *aFootprint, bool aRecreateRatsnest=true)
Places aFootprint at the current cursor position and updates footprint coordinates with the new posit...
FOOTPRINT * CreateNewFootprint(const wxString &aFootprintName, const wxString &aLibName, bool aQuiet)
Creates a new footprint, at position 0,0.
virtual void Update3DView(bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr)
Update the 3D view, if the viewer is opened by this frame.
The main frame for Pcbnew.
void ExportFootprintsToLibrary(bool aStoreInNewLib, const wxString &aLibName=wxEmptyString, wxString *aLibPath=nullptr)
Save footprints in a library:
void ExchangeFootprint(FOOTPRINT *aExisting, FOOTPRINT *aNew, BOARD_COMMIT &aCommit, bool deleteExtraTexts=true, bool resetTextLayers=true, bool resetTextEffects=true, bool resetFabricationAttrs=true, bool reset3DModels=true, bool *aUpdated=nullptr)
Replace aExisting footprint by aNew footprint using the Existing footprint settings (position,...
A set of BOARD_ITEMs (i.e., without duplicates).
A #PLUGIN derivation for saving and loading Pcbnew s-expression formatted files.
void Format(const BOARD_ITEM *aItem, int aNestLevel=0) const
Output aItem to aFormatter in s-expression format.
std::string GetStringOutput(bool doClear)
static PLUGIN_REGISTRY * Instance()
static PCB_IO * PluginFind(PCB_FILE_T aFileType)
Return a #PLUGIN which the caller can use to import, export, save, or load design documents.
PCB_FILE_T
The set of file types that the PCB_IO_MGR knows about, and for which there has been a plugin written,...
@ KICAD_SEXP
S-expression Pcbnew file format.
@ LEGACY
Legacy Pcbnew file formats prior to s-expression.
static PCB_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath, int aCtl=0)
Return a plugin type given a footprint library's libPath.
static const wxString ShowType(PCB_FILE_T aFileType)
Return a brief name for a plugin given aFileType enum.
virtual void SetPosition(const VECTOR2I &aPos) override
The backing store for a PROJECT, in JSON format.
static FP_LIB_TABLE * PcbFootprintLibs(PROJECT *aProject)
Return the table of footprint libraries without Kiway.
Container for project specific data.
virtual const wxString GetProjectPath() const
Return the full path of the project.
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...
bool TransferDataFromWindow() override
SAVE_AS_DIALOG(FOOTPRINT_EDIT_FRAME *aParent, const wxString &aFootprintName, const wxString &aLibraryPreselect, std::function< bool(wxString libName, wxString fpName)> aValidator)
std::function< bool(wxString libName, wxString symbolName)> m_validator
wxTextCtrl * m_fpNameCtrl
std::function< bool(wxString libName, wxString fpName)> m_validator
A KICAD version of wxTextEntryDialog which supports the various improvements/work-arounds from DIALOG...
void SetTextValidator(wxTextValidatorStyle style)
wxString EnsureFileExtension(const wxString &aFilename, const wxString &aExtension)
It's annoying to throw up nag dialogs when the extension isn't right.
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.
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
bool ConfirmRevertDialog(wxWindow *parent, const wxString &aMessage)
Display a confirmation dialog for a revert action.
This file is part of the common library.
FP_LIB_TABLE GFootprintTable
The global footprint library table.
wxString NormalizePath(const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
Normalize a file path to an environmental variable, if possible.
static const std::string KiCadFootprintLibPathExtension
static const std::string KiCadFootprintFileExtension
static wxString KiCadFootprintLibFileWildcard()
static wxString KiCadFootprintLibPathWildcard()
std::unique_ptr< T > IO_RELEASER
Helper to hold and release an IO_BASE object when exceptions are thrown.
PCB_LAYER_ID
A quick note on layer IDs:
This file contains miscellaneous commonly used macros and functions.
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Class to handle a set of BOARD_ITEMs.
#define CTL_FOR_LIBRARY
Format output for a footprint library instead of clipboard or BOARD.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
MODEL3D_FORMAT_TYPE fileType(const char *aFileName)
std::vector< wxString > pinned_fp_libs
Container that describes file type info.
std::vector< std::string > m_FileExtensions
Filter used for file pickers if m_IsFile is true.
wxString FileFilter() const
static int ID_MAKE_NEW_LIBRARY
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
@ PCB_FIELD_T
class PCB_FIELD, text associated with a footprint property
Custom text control validator definitions.
VECTOR2< double > VECTOR2D
wxString formatWildcardExt(const wxString &aWildcard)
Format wildcard extension to support case sensitive file dialogs.
Definition of file extensions used in Kicad.