KiCad PCB EDA Suite
invoke_pcb_dialog.h File Reference

Go to the source code of this file.

Functions

void InvokePcbLibTableEditor (KIWAY *aKiway, wxWindow *aCaller)
 Function InvokePcbLibTableEditor shows the modal DIALOG_FP_LIB_TABLE for purposes of editing the global and project library tables. More...
 
void InvokePluginOptionsEditor (wxWindow *aCaller, const wxString &aNickname, const wxString &aPluginType, const wxString &aOptions, wxString *aResult)
 Function InvokePluginOptionsEditor calls DIALOG_FP_PLUGIN_OPTIONS dialog so that plugin options set can be edited. More...
 
bool InvokeExportSVG (PCB_EDIT_FRAME *aCaller, BOARD *aBoard)
 Function InvokeExportSVG shows the Export SVG dialog. More...
 

Function Documentation

◆ InvokeExportSVG()

bool InvokeExportSVG ( PCB_EDIT_FRAME aCaller,
BOARD aBoard 
)

Function InvokeExportSVG shows the Export SVG dialog.

Parameters
aCalleris the PCB_EDIT_FRAME which is invoking the dialog.
aBoardis the currently edited board.
Returns
bool - true if user pressed OK (did not abort), else false.

Definition at line 373 of file dialog_export_svg.cpp.

374 {
375  DIALOG_EXPORT_SVG dlg( aCaller, aBoard );
376 
377  dlg.ShowModal();
378 
379  return true;
380 }

Referenced by PCB_EDIT_FRAME::ExportSVG().

◆ InvokePcbLibTableEditor()

void InvokePcbLibTableEditor ( KIWAY aKiway,
wxWindow *  aCaller 
)

Function InvokePcbLibTableEditor shows the modal DIALOG_FP_LIB_TABLE for purposes of editing the global and project library tables.

Parameters
aCalleris the wxWindow which is invoking the dialog.
Returns
true if either table changed.

Definition at line 1038 of file panel_fp_lib_table.cpp.

1039 {
1040  FP_LIB_TABLE* globalTable = &GFootprintTable;
1041  wxString globalTablePath = FP_LIB_TABLE::GetGlobalTableFileName();
1042  FP_LIB_TABLE* projectTable = aKiway->Prj().PcbFootprintLibs();
1043  wxString projectTablePath = aKiway->Prj().FootprintLibTblName();
1044  wxString msg;
1045 
1046  DIALOG_EDIT_LIBRARY_TABLES dlg( aCaller, _( "Footprint Libraries" ) );
1047  dlg.SetKiway( &dlg, aKiway );
1048 
1049  if( aKiway->Prj().IsNullProject() )
1050  projectTable = nullptr;
1051 
1052  dlg.InstallPanel( new PANEL_FP_LIB_TABLE( &dlg, globalTable, globalTablePath,
1053  projectTable, projectTablePath,
1054  aKiway->Prj().GetProjectPath() ) );
1055 
1056  if( dlg.ShowModal() == wxID_CANCEL )
1057  return;
1058 
1059  if( dlg.m_GlobalTableChanged )
1060  {
1061  try
1062  {
1063  globalTable->Save( globalTablePath );
1064  }
1065  catch( const IO_ERROR& ioe )
1066  {
1067  msg.Printf( _( "Error saving global library table:\n\n%s" ), ioe.What() );
1068  wxMessageBox( msg, _( "File Save Error" ), wxOK | wxICON_ERROR );
1069  }
1070  }
1071 
1072  if( projectTable && dlg.m_ProjectTableChanged )
1073  {
1074  try
1075  {
1076  projectTable->Save( projectTablePath );
1077  }
1078  catch( const IO_ERROR& ioe )
1079  {
1080  msg.Printf( _( "Error saving project-specific library table:\n\n%s" ), ioe.What() );
1081  wxMessageBox( msg, _( "File Save Error" ), wxOK | wxICON_ERROR );
1082  }
1083  }
1084 
1085  auto editor = (FOOTPRINT_EDIT_FRAME*) aKiway->Player( FRAME_FOOTPRINT_EDITOR, false );
1086 
1087  if( editor )
1088  {
1089  editor->SyncLibraryTree( true );
1090  editor->RefreshLibraryTree();
1091  }
1092 
1093  auto viewer = (FOOTPRINT_VIEWER_FRAME*) aKiway->Player( FRAME_FOOTPRINT_VIEWER, false );
1094 
1095  if( viewer )
1096  viewer->ReCreateLibraryList();
1097 }
FP_LIB_TABLE GFootprintTable
!!!!!!!!!!!!!! This code is obsolete because of the merge into pcbnew, don't bother with it.
Definition: cvpcb.cpp:120
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:173
Component library viewer main window.
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:357
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:123
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
virtual bool IsNullProject() const
Check if this project is a null project (i.e.
Definition: project.cpp:135
virtual FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:285
#define _(s)
Definition: 3d_actions.cpp:33
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
Dialog to show and edit symbol library tables.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
virtual const wxString FootprintLibTblName() const
Returns the path and filename of this project's footprint library table.
Definition: project.cpp:147
static wxString GetGlobalTableFileName()

References _, editor, PROJECT::FootprintLibTblName(), FRAME_FOOTPRINT_EDITOR, FRAME_FOOTPRINT_VIEWER, FP_LIB_TABLE::GetGlobalTableFileName(), PROJECT::GetProjectPath(), GFootprintTable, DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), PROJECT::IsNullProject(), DIALOG_EDIT_LIBRARY_TABLES::m_GlobalTableChanged, DIALOG_EDIT_LIBRARY_TABLES::m_ProjectTableChanged, PROJECT::PcbFootprintLibs(), KIWAY::Player(), KIWAY::Prj(), LIB_TABLE::Save(), KIWAY_HOLDER::SetKiway(), and IO_ERROR::What().

Referenced by PCB::IFACE::CreateWindow().

◆ InvokePluginOptionsEditor()

void InvokePluginOptionsEditor ( wxWindow *  aCaller,
const wxString &  aNickname,
const wxString &  aPluginType,
const wxString &  aOptions,
wxString *  aResult 
)

Function InvokePluginOptionsEditor calls DIALOG_FP_PLUGIN_OPTIONS dialog so that plugin options set can be edited.

Parameters
aCalleris the wxTopLevelWindow which is invoking the dialog.
aNicknameis the footprint library whose options are being edited.
aPluginTypeis something that will pass through IO_MGR::EnumFromStr().
aOptionsis the options string on calling into this function.
aResultis where to put the result of the editing.

Definition at line 292 of file dialog_fp_plugin_options.cpp.

295 {
296  DIALOG_FP_PLUGIN_OPTIONS dlg( aCaller, aNickname, aPluginType, aOptions, aResult );
297 
298  dlg.ShowModal();
299 }
DIALOG_FP_PLUGIN_OPTIONS is an options editor in the form of a two column name/value spreadsheet like...

Referenced by FP_GRID_TRICKS::optionsEditor().