KiCad PCB EDA Suite
PANEL_SYM_LIB_TABLE Class Reference

Dialog to show and edit symbol library tables. More...

#include <panel_sym_lib_table.h>

Inheritance diagram for PANEL_SYM_LIB_TABLE:
PANEL_SYM_LIB_TABLE_BASE

Public Member Functions

 PANEL_SYM_LIB_TABLE (DIALOG_EDIT_LIBRARY_TABLES *aParent, PROJECT *m_project, SYMBOL_LIB_TABLE *aGlobal, const wxString &aGlobalTablePath, SYMBOL_LIB_TABLE *aProject, const wxString &aProjectTablePath)
 
virtual ~PANEL_SYM_LIB_TABLE ()
 

Protected Attributes

wxNotebook * m_notebook
 
wxPanel * m_global_panel
 
WX_GRIDm_global_grid
 
wxPanel * m_project_panel
 
WX_GRIDm_project_grid
 
wxBitmapButton * m_append_button
 
wxBitmapButton * m_browse_button
 
wxBitmapButton * m_move_up_button
 
wxBitmapButton * m_move_down_button
 
wxBitmapButton * m_delete_button
 
wxButton * m_convertLegacy
 
WX_GRIDm_path_subs_grid
 

Private Member Functions

bool verifyTables ()
 Trim important fields, removes blank row entries, and checks for duplicates. More...
 
void OnUpdateUI (wxUpdateUIEvent &event) override
 
void browseLibrariesHandler (wxCommandEvent &event) override
 
void appendRowHandler (wxCommandEvent &event) override
 
void deleteRowHandler (wxCommandEvent &event) override
 
void moveUpHandler (wxCommandEvent &event) override
 
void moveDownHandler (wxCommandEvent &event) override
 
void onSizeGrid (wxSizeEvent &event) override
 
void adjustPathSubsGridColumns (int aWidth)
 
void onConvertLegacyLibraries (wxCommandEvent &event) override
 
bool TransferDataFromWindow () override
 
void populateEnvironReadOnlyTable ()
 Populate the readonly environment variable table with names and values by examining all the full_uri columns. More...
 
bool convertLibrary (const wxString &aLibrary, const wxString &legacyFilepath, const wxString &newFilepath)
 
SYMBOL_LIB_TABLE_GRIDglobal_model () const
 
SYMBOL_LIB_TABLE_GRIDproject_model () const
 
SYMBOL_LIB_TABLE_GRIDcur_model () const
 

Private Attributes

SYMBOL_LIB_TABLEm_globalTable
 
SYMBOL_LIB_TABLEm_projectTable
 
PROJECTm_project
 
DIALOG_EDIT_LIBRARY_TABLESm_parent
 
WX_GRIDm_cur_grid
 changed based on tab choice More...
 
wxString m_lastProjectLibDir
 

Static Private Attributes

static size_t m_pageNdx = 0
 Remember the last notebook page selected. More...
 

Detailed Description

Dialog to show and edit symbol library tables.

Definition at line 35 of file panel_sym_lib_table.h.

Constructor & Destructor Documentation

◆ PANEL_SYM_LIB_TABLE()

PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE ( DIALOG_EDIT_LIBRARY_TABLES aParent,
PROJECT m_project,
SYMBOL_LIB_TABLE aGlobal,
const wxString &  aGlobalTablePath,
SYMBOL_LIB_TABLE aProject,
const wxString &  aProjectTablePath 
)

Definition at line 199 of file panel_sym_lib_table.cpp.

203  :
204  PANEL_SYM_LIB_TABLE_BASE( aParent ),
205  m_globalTable( aGlobalTable ),
206  m_projectTable( aProjectTable ),
207  m_project( aProject ),
208  m_parent( aParent )
209 {
210  // wxGrid only supports user owned tables if they exist past end of ~wxGrid(),
211  // so make it a grid owned table.
213 
214  wxArrayString pluginChoices;
215 
216  pluginChoices.Add( SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_KICAD ) );
217  pluginChoices.Add( SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY ) );
218 
219  EESCHEMA_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();
220 
221  if( cfg->m_lastSymbolLibDir.IsEmpty() )
223 
225 
226  auto setupGrid =
227  [&]( WX_GRID* aGrid )
228  {
229  // Give a bit more room for combobox editors
230  aGrid->SetDefaultRowSize( aGrid->GetDefaultRowSize() + 4 );
231 
232  // add Cut, Copy, and Paste to wxGrids
233  aGrid->PushEventHandler( new SYMBOL_GRID_TRICKS( m_parent, aGrid ) );
234 
235  aGrid->SetSelectionMode( wxGrid::wxGridSelectRows );
236  aGrid->AutoSizeColumns( false );
237 
238  // Set special attributes
239  wxGridCellAttr* attr;
240 
241  attr = new wxGridCellAttr;
242 
243  wxString wildcards = AllSymbolLibFilesWildcard()
245  + "|" + LegacySymbolLibFileWildcard();
246  attr->SetEditor( new GRID_CELL_PATH_EDITOR( m_parent, aGrid,
247  &cfg->m_lastSymbolLibDir, wildcards,
248  true, m_project->GetProjectPath() ) );
249  aGrid->SetColAttr( COL_URI, attr );
250 
251  attr = new wxGridCellAttr;
252  attr->SetEditor( new wxGridCellChoiceEditor( pluginChoices ) );
253  aGrid->SetColAttr( COL_TYPE, attr );
254 
255  attr = new wxGridCellAttr;
256  attr->SetRenderer( new wxGridCellBoolRenderer() );
257  attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
258  aGrid->SetColAttr( COL_ENABLED, attr );
259 
260  // all but COL_OPTIONS, which is edited with Option Editor anyways.
261  aGrid->AutoSizeColumn( COL_NICKNAME, false );
262  aGrid->AutoSizeColumn( COL_TYPE, false );
263  aGrid->AutoSizeColumn( COL_URI, false );
264  aGrid->AutoSizeColumn( COL_DESCR, false );
265  aGrid->AutoSizeColumn( COL_ENABLED, false );
266 
267  // would set this to width of title, if it was easily known.
268  aGrid->SetColSize( COL_OPTIONS, 80 );
269 
270  // Gives a selection to each grid, mainly for delete button. wxGrid's wake up with
271  // a currentCell which is sometimes not highlighted.
272  if( aGrid->GetNumberRows() > 0 )
273  aGrid->SelectRow( 0 );
274  };
275 
276  setupGrid( m_global_grid );
277 
278  if( m_projectTable )
279  {
281  setupGrid( m_project_grid );
282  }
283  else
284  {
285  m_pageNdx = 0;
286  m_notebook->DeletePage( 1 );
287  m_project_grid = nullptr;
288  }
289 
290  // add Cut, Copy, and Paste to wxGrids
291  m_path_subs_grid->PushEventHandler( new GRID_TRICKS( m_path_subs_grid ) );
292 
294 
295  // select the last selected page
296  m_notebook->SetSelection( m_pageNdx );
298 
299  m_path_subs_grid->SetColLabelValue( 0, _( "Name" ) );
300  m_path_subs_grid->SetColLabelValue( 1, _( "Value" ) );
301 
302  // for ALT+A handling, we want the initial focus to be on the first selected grid.
304 
305  // Configure button logos
311 }
wxString AllSymbolLibFilesWildcard()
static const wxString ShowType(SCH_FILE_T aFileType)
Return a brief name for a plugin, given aFileType enum.
Definition: sch_io_mgr.cpp:79
WX_GRID * m_cur_grid
changed based on tab choice
Add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.
Definition: grid_tricks.h:55
static size_t m_pageNdx
Remember the last notebook page selected.
void SetTable(wxGridTableBase *table, bool aTakeOwnership=false)
Hide wxGrid's SetTable() method with one which doesn't mess up the grid column widths when setting th...
Definition: wx_grid.cpp:72
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:122
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:97
void populateEnvironReadOnlyTable()
Populate the readonly environment variable table with names and values by examining all the full_uri ...
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.
SYMBOL_LIB_TABLE * m_projectTable
PANEL_SYM_LIB_TABLE_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxTAB_TRAVERSAL, const wxString &name=wxEmptyString)
#define _(s)
wxString KiCadSymbolLibFileWildcard()
Editor for wxGrid cells that adds a file/folder browser to the grid input field.
wxString LegacySymbolLibFileWildcard()
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105
DIALOG_EDIT_LIBRARY_TABLES * m_parent
static wxString GetDefaultUserSymbolsPath()
Gets the default path we point users to create projects.
Definition: paths.cpp:97
SYMBOL_LIB_TABLE * m_globalTable

References _, AllSymbolLibFilesWildcard(), COL_DESCR, COL_ENABLED, COL_NICKNAME, COL_OPTIONS, COL_TYPE, COL_URI, PATHS::GetDefaultUserSymbolsPath(), PROJECT::GetProjectPath(), KiBitmap(), KiCadSymbolLibFileWildcard(), LegacySymbolLibFileWildcard(), PANEL_SYM_LIB_TABLE_BASE::m_append_button, PANEL_SYM_LIB_TABLE_BASE::m_browse_button, m_cur_grid, PANEL_SYM_LIB_TABLE_BASE::m_delete_button, PANEL_SYM_LIB_TABLE_BASE::m_global_grid, m_globalTable, m_lastProjectLibDir, EESCHEMA_SETTINGS::m_lastSymbolLibDir, PANEL_SYM_LIB_TABLE_BASE::m_move_down_button, PANEL_SYM_LIB_TABLE_BASE::m_move_up_button, PANEL_SYM_LIB_TABLE_BASE::m_notebook, m_pageNdx, m_parent, PANEL_SYM_LIB_TABLE_BASE::m_path_subs_grid, m_project, PANEL_SYM_LIB_TABLE_BASE::m_project_grid, m_projectTable, Pgm(), populateEnvironReadOnlyTable(), DIALOG_SHIM::SetInitialFocus(), WX_GRID::SetTable(), SCH_IO_MGR::ShowType(), small_down, small_folder, small_plus, small_trash, and small_up.

◆ ~PANEL_SYM_LIB_TABLE()

PANEL_SYM_LIB_TABLE::~PANEL_SYM_LIB_TABLE ( )
virtual

Definition at line 314 of file panel_sym_lib_table.cpp.

315 {
316  // When the dialog is closed it will hide the current notebook page first, which will
317  // in turn select the other one. We then end up saving its index as the "current page".
318  // So flip them back again:
319  m_pageNdx = m_pageNdx == 1 ? 0 : 1;
320 
321  // Delete the GRID_TRICKS.
322  // Any additional event handlers should be popped before the window is deleted.
323  m_global_grid->PopEventHandler( true );
324 
325  if( m_project_grid )
326  m_project_grid->PopEventHandler( true );
327 
328  m_path_subs_grid->PopEventHandler( true );
329 }
static size_t m_pageNdx
Remember the last notebook page selected.

References PANEL_SYM_LIB_TABLE_BASE::m_global_grid, m_pageNdx, PANEL_SYM_LIB_TABLE_BASE::m_path_subs_grid, and PANEL_SYM_LIB_TABLE_BASE::m_project_grid.

Member Function Documentation

◆ adjustPathSubsGridColumns()

void PANEL_SYM_LIB_TABLE::adjustPathSubsGridColumns ( int  aWidth)
private

Definition at line 966 of file panel_sym_lib_table.cpp.

967 {
968  // Account for scroll bars
969  aWidth -= ( m_path_subs_grid->GetSize().x - m_path_subs_grid->GetClientSize().x );
970 
971  m_path_subs_grid->AutoSizeColumn( 0 );
972 
973  int remaining_width = aWidth - m_path_subs_grid->GetColSize( 0 );
974 
975  if( remaining_width < 0 )
976  m_path_subs_grid->SetColSize( 1, -1 );
977  else
978  m_path_subs_grid->SetColSize( 1, remaining_width );
979 }

References PANEL_SYM_LIB_TABLE_BASE::m_path_subs_grid.

Referenced by onSizeGrid(), and populateEnvironReadOnlyTable().

◆ appendRowHandler()

void PANEL_SYM_LIB_TABLE::appendRowHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 572 of file panel_sym_lib_table.cpp.

573 {
575  return;
576 
577  if( m_cur_grid->AppendRows( 1 ) )
578  {
579  int row = m_cur_grid->GetNumberRows() - 1;
580 
581  // wx documentation is wrong, SetGridCursor does not make visible.
582  m_cur_grid->MakeCellVisible( row, 0 );
583  m_cur_grid->SetGridCursor( row, 1 );
584  m_cur_grid->EnableCellEditControl( true );
585  m_cur_grid->ShowCellEditControl();
586  }
587 }
WX_GRID * m_cur_grid
changed based on tab choice
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:190

References WX_GRID::CommitPendingChanges(), and m_cur_grid.

◆ browseLibrariesHandler()

void PANEL_SYM_LIB_TABLE::browseLibrariesHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 481 of file panel_sym_lib_table.cpp.

482 {
483  wxString wildcards = AllSymbolLibFilesWildcard()
485  + "|" + LegacySymbolLibFileWildcard();
486 
487  EESCHEMA_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();
488 
489  wxString openDir = cfg->m_lastSymbolLibDir;
490 
491  if( m_cur_grid == m_project_grid )
492  openDir = m_lastProjectLibDir;
493 
494  wxFileDialog dlg( this, _( "Select Library" ), openDir, wxEmptyString, wildcards,
495  wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE );
496 
497  if( dlg.ShowModal() == wxID_CANCEL )
498  return;
499 
500  if( m_cur_grid == m_global_grid )
501  cfg->m_lastSymbolLibDir = dlg.GetPath();
502  else
503  m_lastProjectLibDir = dlg.GetPath();
504 
505  const ENV_VAR_MAP& envVars = Pgm().GetLocalEnvVariables();
506  bool addDuplicates = false;
507  bool applyToAll = false;
508  wxString warning = _( "Warning: Duplicate Nickname" );
509  wxString msg = _( "A library nicknamed '%s' already exists." );
510  wxString detailedMsg = _( "One of the nicknames will need to be changed after "
511  "adding this library." );
512 
513  wxArrayString files;
514  dlg.GetFilenames( files );
515 
516  for( const wxString& file : files )
517  {
518  wxString filePath = dlg.GetDirectory() + wxFileName::GetPathSeparator() + file;
519  wxFileName fn( filePath );
520  wxString nickname = LIB_ID::FixIllegalChars( fn.GetName(), true );
521  bool doAdd = true;
522 
523  if( cur_model()->ContainsNickname( nickname ) )
524  {
525  if( !applyToAll )
526  {
527  // The cancel button adds the library to the table anyway
528  addDuplicates = OKOrCancelDialog( this, warning, wxString::Format( msg, nickname ),
529  detailedMsg, _( "Skip" ), _( "Add Anyway" ),
530  &applyToAll ) == wxID_CANCEL;
531  }
532 
533  doAdd = addDuplicates;
534  }
535 
536  if( doAdd && m_cur_grid->AppendRows( 1 ) )
537  {
538  int last_row = m_cur_grid->GetNumberRows() - 1;
539 
540  m_cur_grid->SetCellValue( last_row, COL_NICKNAME, nickname );
541 
542  // attempt to auto-detect the plugin type
543  for( SCH_IO_MGR::SCH_FILE_T piType : SCH_IO_MGR::SCH_FILE_T_vector )
544  {
545  if( SCH_IO_MGR::GetLibraryFileExtension( piType ).Lower() == fn.GetExt().Lower() )
546  {
547  m_cur_grid->SetCellValue( last_row, COL_TYPE, SCH_IO_MGR::ShowType( piType ) );
548  break;
549  }
550  }
551 
552  // try to use path normalized to an environmental variable or project path
553  wxString path = NormalizePath( filePath, &envVars, m_project->GetProjectPath() );
554 
555  // Do not use the project path in the global library table. This will almost
556  // assuredly be wrong for a different project.
557  if( m_pageNdx == 0 && path.Contains( "${KIPRJMOD}" ) )
558  path = fn.GetFullPath();
559 
560  m_cur_grid->SetCellValue( last_row, COL_URI, path );
561  }
562  }
563 
564  if( !files.IsEmpty() )
565  {
566  m_cur_grid->MakeCellVisible( m_cur_grid->GetNumberRows() - 1, 0 );
567  m_cur_grid->SetGridCursor( m_cur_grid->GetNumberRows() - 1, 1 );
568  }
569 }
wxString AllSymbolLibFilesWildcard()
static UTF8 FixIllegalChars(const UTF8 &aLibItemName, bool aLib)
Replace illegal LIB_ID item name characters with underscores '_'.
Definition: lib_id.cpp:189
bool ContainsNickname(const wxString &aNickname)
static const wxString ShowType(SCH_FILE_T aFileType)
Return a brief name for a plugin, given aFileType enum.
Definition: sch_io_mgr.cpp:79
WX_GRID * m_cur_grid
changed based on tab choice
static const wxString GetLibraryFileExtension(SCH_FILE_T aFileType)
Return the symbol library file extension (if any) for aFileType.
Definition: sch_io_mgr.cpp:136
static size_t m_pageNdx
Remember the last notebook page selected.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:122
SYMBOL_LIB_TABLE_GRID * cur_model() const
#define _(s)
wxString KiCadSymbolLibFileWildcard()
wxString LegacySymbolLibFileWildcard()
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.
Definition: confirm.cpp:252
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
wxString NormalizePath(const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
Normalize a file path to an environmental variable, if possible.
Definition: env_paths.cpp:69

References _, AllSymbolLibFilesWildcard(), COL_NICKNAME, COL_TYPE, COL_URI, LIB_TABLE_GRID::ContainsNickname(), cur_model(), LIB_ID::FixIllegalChars(), Format(), SCH_IO_MGR::GetLibraryFileExtension(), PROJECT::GetProjectPath(), KiCadSymbolLibFileWildcard(), LegacySymbolLibFileWildcard(), m_cur_grid, PANEL_SYM_LIB_TABLE_BASE::m_global_grid, m_lastProjectLibDir, EESCHEMA_SETTINGS::m_lastSymbolLibDir, m_pageNdx, m_project, PANEL_SYM_LIB_TABLE_BASE::m_project_grid, NormalizePath(), OKOrCancelDialog(), path, Pgm(), and SCH_IO_MGR::ShowType().

◆ convertLibrary()

bool PANEL_SYM_LIB_TABLE::convertLibrary ( const wxString &  aLibrary,
const wxString &  legacyFilepath,
const wxString &  newFilepath 
)
private

Definition at line 809 of file panel_sym_lib_table.cpp.

811 {
812  SCH_PLUGIN::SCH_PLUGIN_RELEASER legacyPI( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_LEGACY ) );
813  SCH_PLUGIN::SCH_PLUGIN_RELEASER kicadPI( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
814  std::vector<LIB_SYMBOL*> symbols;
815  std::vector<LIB_SYMBOL*> newSymbols;
816  std::map<LIB_SYMBOL*, LIB_SYMBOL*> symbolMap;
817 
818  try
819  {
820  // Write a stub file; SaveSymbol() expects something to be there already.
821  FILE_OUTPUTFORMATTER* formatter = new FILE_OUTPUTFORMATTER( newFilepath );
822 
823  formatter->Print( 0, "(kicad_symbol_lib (version %d) (generator kicad_converter))",
825 
826  // This will write the file
827  delete formatter;
828 
829  legacyPI->EnumerateSymbolLib( symbols, legacyFilepath );
830 
831  // Copy non-aliases first so we can build a map from symbols to newSymbols
832  for( LIB_SYMBOL* symbol : symbols )
833  {
834  if( symbol->IsAlias() )
835  continue;
836 
837  symbol->SetName( EscapeString( symbol->GetName(), CTX_LIBID ) );
838 
839  newSymbols.push_back( new LIB_SYMBOL( *symbol ) );
840  symbolMap[symbol] = newSymbols.back();
841  }
842 
843  // Now do the aliases using the map to hook them up to their newSymbol parents
844  for( LIB_SYMBOL* symbol : symbols )
845  {
846  if( !symbol->IsAlias() )
847  continue;
848 
849  symbol->SetName( EscapeString( symbol->GetName(), CTX_LIBID ) );
850 
851  newSymbols.push_back( new LIB_SYMBOL( *symbol ) );
852  newSymbols.back()->SetParent( symbolMap[ symbol->GetParent().lock().get() ] );
853  }
854 
855  // Finally write out newSymbols
856  for( LIB_SYMBOL* symbol : newSymbols )
857  {
858  kicadPI->SaveSymbol( newFilepath, symbol );
859  }
860  }
861  catch( ... )
862  {
863  return false;
864  }
865 
866  return true;
867 }
#define SEXPR_SYMBOL_LIB_FILE_VERSION
This file contains the file format version information for the s-expression schematic and symbol libr...
Define a library symbol object.
Definition: lib_symbol.h:96
Helper object to release a SCH_PLUGIN in the context of a potential thrown exception through its dest...
Definition: sch_io_mgr.h:479
Used for text file output.
Definition: richio.h:456
wxString EscapeString(const wxString &aSource, ESCAPE_CONTEXT aContext)
The Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which are:...
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426

References CTX_LIBID, EscapeString(), OUTPUTFORMATTER::Print(), and SEXPR_SYMBOL_LIB_FILE_VERSION.

Referenced by onConvertLegacyLibraries().

◆ cur_model()

SYMBOL_LIB_TABLE_GRID * PANEL_SYM_LIB_TABLE::cur_model ( ) const
private

Definition at line 1002 of file panel_sym_lib_table.cpp.

1003 {
1004  return (SYMBOL_LIB_TABLE_GRID*) m_cur_grid->GetTable();
1005 }
WX_GRID * m_cur_grid
changed based on tab choice
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.

References m_cur_grid.

Referenced by browseLibrariesHandler(), moveDownHandler(), moveUpHandler(), and verifyTables().

◆ deleteRowHandler()

void PANEL_SYM_LIB_TABLE::deleteRowHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 590 of file panel_sym_lib_table.cpp.

591 {
593  return;
594 
595  int curRow = m_cur_grid->GetGridCursorRow();
596  int curCol = m_cur_grid->GetGridCursorCol();
597 
598  // In a wxGrid, collect rows that have a selected cell, or are selected
599  // It is not so easy: it depends on the way the selection was made.
600  // Here, we collect rows selected by clicking on a row label, and rows that contain
601  // previously-selected cells.
602  // If no candidate, just delete the row with the grid cursor.
603  wxArrayInt selectedRows = m_cur_grid->GetSelectedRows();
604  wxGridCellCoordsArray cells = m_cur_grid->GetSelectedCells();
605  wxGridCellCoordsArray blockTopLeft = m_cur_grid->GetSelectionBlockTopLeft();
606  wxGridCellCoordsArray blockBotRight = m_cur_grid->GetSelectionBlockBottomRight();
607 
608  // Add all row having cell selected to list:
609  for( unsigned ii = 0; ii < cells.GetCount(); ii++ )
610  selectedRows.Add( cells[ii].GetRow() );
611 
612  // Handle block selection
613  if( !blockTopLeft.IsEmpty() && !blockBotRight.IsEmpty() )
614  {
615  for( int i = blockTopLeft[0].GetRow(); i <= blockBotRight[0].GetRow(); ++i )
616  selectedRows.Add( i );
617  }
618 
619  // Use the row having the grid cursor only if we have no candidate:
620  if( selectedRows.size() == 0 && m_cur_grid->GetGridCursorRow() >= 0 )
621  selectedRows.Add( m_cur_grid->GetGridCursorRow() );
622 
623  if( selectedRows.size() == 0 )
624  {
625  wxBell();
626  return;
627  }
628 
629  std::sort( selectedRows.begin(), selectedRows.end() );
630 
631  // Remove selected rows (note: a row can be stored more than once in list)
632  int last_row = -1;
633 
634  for( int ii = selectedRows.GetCount()-1; ii >= 0; ii-- )
635  {
636  int row = selectedRows[ii];
637 
638  if( row != last_row )
639  {
640  last_row = row;
641  m_cur_grid->DeleteRows( row, 1 );
642  }
643  }
644 
645  if( m_cur_grid->GetNumberRows() > 0 && curRow >= 0 )
646  m_cur_grid->SetGridCursor( std::min( curRow, m_cur_grid->GetNumberRows() - 1 ), curCol );
647 }
WX_GRID * m_cur_grid
changed based on tab choice
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:190

References WX_GRID::CommitPendingChanges(), and m_cur_grid.

◆ global_model()

SYMBOL_LIB_TABLE_GRID * PANEL_SYM_LIB_TABLE::global_model ( ) const
private

Definition at line 990 of file panel_sym_lib_table.cpp.

991 {
992  return (SYMBOL_LIB_TABLE_GRID*) m_global_grid->GetTable();
993 }
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.

References PANEL_SYM_LIB_TABLE_BASE::m_global_grid.

Referenced by populateEnvironReadOnlyTable(), TransferDataFromWindow(), and verifyTables().

◆ moveDownHandler()

void PANEL_SYM_LIB_TABLE::moveDownHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 680 of file panel_sym_lib_table.cpp.

681 {
683  return;
684 
686  int curRow = m_cur_grid->GetGridCursorRow();
687 
688  // @todo: add multiple selection moves.
689  if( unsigned( curRow + 1 ) < tbl->rows.size() )
690  {
691  boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
692  tbl->rows.release( tbl->rows.begin() + curRow );
693 
694  ++curRow;
695  tbl->rows.insert( tbl->rows.begin() + curRow, move_me.release() );
696 
697  if( tbl->GetView() )
698  {
699  // Update the wxGrid
700  wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow - 1, 0 );
701  tbl->GetView()->ProcessTableMessage( msg );
702  }
703 
704  m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
705  m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
706  }
707 }
WX_GRID * m_cur_grid
changed based on tab choice
LIB_TABLE_ROWS rows
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.
SYMBOL_LIB_TABLE_GRID * cur_model() const
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:190

References WX_GRID::CommitPendingChanges(), cur_model(), m_cur_grid, and LIB_TABLE::rows.

◆ moveUpHandler()

void PANEL_SYM_LIB_TABLE::moveUpHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 650 of file panel_sym_lib_table.cpp.

651 {
653  return;
654 
656  int curRow = m_cur_grid->GetGridCursorRow();
657 
658  // @todo: add multiple selection moves.
659  if( curRow >= 1 )
660  {
661  boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
662  tbl->rows.release( tbl->rows.begin() + curRow );
663 
664  --curRow;
665  tbl->rows.insert( tbl->rows.begin() + curRow, move_me.release() );
666 
667  if( tbl->GetView() )
668  {
669  // Update the wxGrid
670  wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow, 0 );
671  tbl->GetView()->ProcessTableMessage( msg );
672  }
673 
674  m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
675  m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
676  }
677 }
WX_GRID * m_cur_grid
changed based on tab choice
LIB_TABLE_ROWS rows
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.
SYMBOL_LIB_TABLE_GRID * cur_model() const
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:190

References WX_GRID::CommitPendingChanges(), cur_model(), m_cur_grid, and LIB_TABLE::rows.

◆ onConvertLegacyLibraries()

void PANEL_SYM_LIB_TABLE::onConvertLegacyLibraries ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 710 of file panel_sym_lib_table.cpp.

711 {
713  return;
714 
715  wxArrayInt selectedRows = m_cur_grid->GetSelectedRows();
716 
717  if( selectedRows.empty() && m_cur_grid->GetGridCursorRow() >= 0 )
718  selectedRows.push_back( m_cur_grid->GetGridCursorRow() );
719 
720  wxArrayInt legacyRows;
721  wxString legacyType = SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY );
722  wxString kicadType = SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_KICAD );
723  wxString msg;
724 
725  for( int row : selectedRows )
726  {
727  if( m_cur_grid->GetCellValue( row, COL_TYPE ) == legacyType )
728  legacyRows.push_back( row );
729  }
730 
731  if( legacyRows.size() <= 0 )
732  {
733  wxMessageBox( _( "Select one or more rows containing libraries in Legacy format (*.lib) "
734  "to save as current KiCad format (*.kicad_sym)." ) );
735  return;
736  }
737  else
738  {
739  if( legacyRows.size() == 1 )
740  {
741  msg.Printf( _( "Save '%s' as current KiCad format (*.kicad_sym) "
742  "and replace legacy entry in table?" ),
743  m_cur_grid->GetCellValue( legacyRows[0], COL_NICKNAME ) );
744  }
745  else
746  {
747  msg.Printf( _( "Save %d Legacy format libraries as current KiCad format (*.kicad_sym) "
748  "and replace legacy entries in table?" ),
749  (int) legacyRows.size() );
750  }
751 
752  if( !IsOK( m_parent, msg ) )
753  return;
754  }
755 
756  for( int row : legacyRows )
757  {
758  wxString libName = m_cur_grid->GetCellValue( row, COL_NICKNAME );
759  wxString relPath = m_cur_grid->GetCellValue( row, COL_URI );
760  wxString resolvedPath = ExpandEnvVarSubstitutions( relPath, m_project );
761  wxFileName legacyLib( resolvedPath );
762 
763  if( !legacyLib.Exists() )
764  {
765  msg.Printf( _( "Library '%s' not found." ), relPath );
766  DisplayErrorMessage( this, msg );
767  continue;
768  }
769 
770  wxFileName newLib( resolvedPath );
771  newLib.SetExt( "kicad_sym" );
772 
773  if( newLib.Exists() )
774  {
775  msg.Printf( _( "File '%s' already exists. Do you want overwrite this file?" ),
776  newLib.GetFullPath() );
777 
778  switch( wxMessageBox( msg, _( "Migrate Library" ),
779  wxYES_NO | wxCANCEL | wxICON_QUESTION, m_parent ) )
780  {
781  case wxYES: break;
782  case wxNO: continue;
783  case wxCANCEL: return;
784  }
785  }
786 
787  if( convertLibrary( libName, legacyLib.GetFullPath(), newLib.GetFullPath() ) )
788  {
789  relPath = NormalizePath( newLib.GetFullPath(), &Pgm().GetLocalEnvVariables(),
790  m_project );
791 
792  // Do not use the project path in the global library table. This will almost
793  // assuredly be wrong for a different project.
794  if( m_cur_grid == m_global_grid && relPath.Contains( "${KIPRJMOD}" ) )
795  relPath = newLib.GetFullPath();
796 
797  m_cur_grid->SetCellValue( row, COL_URI, relPath );
798  m_cur_grid->SetCellValue( row, COL_TYPE, kicadType );
799  }
800  else
801  {
802  msg.Printf( _( "Failed to save symbol library file '%s'." ), newLib.GetFullPath() );
803  DisplayErrorMessage( this, msg );
804  }
805  }
806 }
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:292
static const wxString ShowType(SCH_FILE_T aFileType)
Return a brief name for a plugin, given aFileType enum.
Definition: sch_io_mgr.cpp:79
WX_GRID * m_cur_grid
changed based on tab choice
const wxString ExpandEnvVarSubstitutions(const wxString &aString, PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition: common.cpp:267
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
bool convertLibrary(const wxString &aLibrary, const wxString &legacyFilepath, const wxString &newFilepath)
#define _(s)
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:190
DIALOG_EDIT_LIBRARY_TABLES * m_parent
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:323
wxString NormalizePath(const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
Normalize a file path to an environmental variable, if possible.
Definition: env_paths.cpp:69

References _, COL_NICKNAME, COL_TYPE, COL_URI, WX_GRID::CommitPendingChanges(), convertLibrary(), DisplayErrorMessage(), ExpandEnvVarSubstitutions(), IsOK(), m_cur_grid, PANEL_SYM_LIB_TABLE_BASE::m_global_grid, m_parent, m_project, NormalizePath(), Pgm(), and SCH_IO_MGR::ShowType().

◆ onSizeGrid()

void PANEL_SYM_LIB_TABLE::onSizeGrid ( wxSizeEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 982 of file panel_sym_lib_table.cpp.

983 {
984  adjustPathSubsGridColumns( event.GetSize().GetX() );
985 
986  event.Skip();
987 }
void adjustPathSubsGridColumns(int aWidth)

References adjustPathSubsGridColumns().

◆ OnUpdateUI()

void PANEL_SYM_LIB_TABLE::OnUpdateUI ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 474 of file panel_sym_lib_table.cpp.

475 {
476  m_pageNdx = (unsigned) std::max( 0, m_notebook->GetSelection() );
478 }
WX_GRID * m_cur_grid
changed based on tab choice
static size_t m_pageNdx
Remember the last notebook page selected.

References m_cur_grid, PANEL_SYM_LIB_TABLE_BASE::m_global_grid, PANEL_SYM_LIB_TABLE_BASE::m_notebook, m_pageNdx, and PANEL_SYM_LIB_TABLE_BASE::m_project_grid.

◆ populateEnvironReadOnlyTable()

void PANEL_SYM_LIB_TABLE::populateEnvironReadOnlyTable ( )
private

Populate the readonly environment variable table with names and values by examining all the full_uri columns.

Definition at line 902 of file panel_sym_lib_table.cpp.

903 {
904  wxRegEx re( ".*?(\\$\\{(.+?)\\})|(\\$\\((.+?)\\)).*?", wxRE_ADVANCED );
905  wxASSERT( re.IsValid() ); // wxRE_ADVANCED is required.
906 
907  std::set< wxString > unique;
908 
909  // clear the table
911 
912  for( SYMBOL_LIB_TABLE_GRID* tbl : { global_model(), project_model() } )
913  {
914  if( !tbl )
915  continue;
916 
917  for( int row = 0; row < tbl->GetNumberRows(); ++row )
918  {
919  wxString uri = tbl->GetValue( row, COL_URI );
920 
921  while( re.Matches( uri ) )
922  {
923  wxString envvar = re.GetMatch( uri, 2 );
924 
925  // if not ${...} form then must be $(...)
926  if( envvar.IsEmpty() )
927  envvar = re.GetMatch( uri, 4 );
928 
929  // ignore duplicates
930  unique.insert( envvar );
931 
932  // delete the last match and search again
933  uri.Replace( re.GetMatch( uri, 0 ), wxEmptyString );
934  }
935  }
936  }
937 
938  // Make sure this special environment variable shows up even if it was
939  // not used yet. It is automatically set by KiCad to the directory holding
940  // the current project.
941  unique.insert( PROJECT_VAR_NAME );
943 
944  for( const wxString& evName : unique )
945  {
946  int row = m_path_subs_grid->GetNumberRows();
947  m_path_subs_grid->AppendRows( 1 );
948 
949  m_path_subs_grid->SetCellValue( row, 0, wxT( "${" ) + evName + wxT( "}" ) );
950  m_path_subs_grid->SetCellEditor( row, 0, new GRID_CELL_READONLY_TEXT_EDITOR() );
951 
952  wxString evValue;
953  wxGetEnv( evName, &evValue );
954  m_path_subs_grid->SetCellValue( row, 1, evValue );
955  m_path_subs_grid->SetCellEditor( row, 1, new GRID_CELL_READONLY_TEXT_EDITOR() );
956  }
957 
958  // No combobox editors here, but it looks better if its consistent with the other
959  // grids in the dialog.
960  m_path_subs_grid->SetDefaultRowSize( m_path_subs_grid->GetDefaultRowSize() + 2 );
961 
962  adjustPathSubsGridColumns( m_path_subs_grid->GetRect().GetWidth() );
963 }
#define PROJECT_VAR_NAME
A variable name whose value holds the current project directory.
Definition: project.h:38
SYMBOL_LIB_TABLE_GRID * global_model() const
static const wxString GlobalPathEnvVariableName()
Return the name of the environment variable used to hold the directory of locally installed "KiCad sp...
void adjustPathSubsGridColumns(int aWidth)
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.
SYMBOL_LIB_TABLE_GRID * project_model() const
void ClearRows()
wxWidgets recently added an ASSERT which fires if the position is greater than or equal to the number...
Definition: wx_grid.h:106

References adjustPathSubsGridColumns(), WX_GRID::ClearRows(), COL_URI, global_model(), SYMBOL_LIB_TABLE::GlobalPathEnvVariableName(), PANEL_SYM_LIB_TABLE_BASE::m_path_subs_grid, project_model(), and PROJECT_VAR_NAME.

Referenced by PANEL_SYM_LIB_TABLE().

◆ project_model()

SYMBOL_LIB_TABLE_GRID * PANEL_SYM_LIB_TABLE::project_model ( ) const
private

Definition at line 996 of file panel_sym_lib_table.cpp.

997 {
998  return m_project_grid ? (SYMBOL_LIB_TABLE_GRID*) m_project_grid->GetTable() : nullptr;
999 }
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.

References PANEL_SYM_LIB_TABLE_BASE::m_project_grid.

Referenced by populateEnvironReadOnlyTable(), TransferDataFromWindow(), and verifyTables().

◆ TransferDataFromWindow()

bool PANEL_SYM_LIB_TABLE::TransferDataFromWindow ( )
overrideprivate

Definition at line 870 of file panel_sym_lib_table.cpp.

871 {
873  return false;
874 
875  if( !verifyTables() )
876  return false;
877 
878  if( *global_model() != *m_globalTable )
879  {
881 
882  m_globalTable->Clear();
883  m_globalTable->rows.transfer( m_globalTable->rows.end(), global_model()->rows.begin(),
884  global_model()->rows.end(), global_model()->rows );
886  }
887 
888  if( project_model() && *project_model() != *m_projectTable )
889  {
891 
893  m_projectTable->rows.transfer( m_projectTable->rows.end(), project_model()->rows.begin(),
894  project_model()->rows.end(), project_model()->rows );
896  }
897 
898  return true;
899 }
void Clear()
Delete all rows.
void reindex()
WX_GRID * m_cur_grid
changed based on tab choice
SYMBOL_LIB_TABLE_GRID * global_model() const
LIB_TABLE_ROWS rows
SYMBOL_LIB_TABLE * m_projectTable
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:190
DIALOG_EDIT_LIBRARY_TABLES * m_parent
SYMBOL_LIB_TABLE_GRID * project_model() const
bool verifyTables()
Trim important fields, removes blank row entries, and checks for duplicates.
SYMBOL_LIB_TABLE * m_globalTable

References LIB_TABLE::Clear(), WX_GRID::CommitPendingChanges(), global_model(), m_cur_grid, m_globalTable, DIALOG_EDIT_LIBRARY_TABLES::m_GlobalTableChanged, m_parent, m_projectTable, DIALOG_EDIT_LIBRARY_TABLES::m_ProjectTableChanged, project_model(), LIB_TABLE::reindex(), LIB_TABLE::rows, and verifyTables().

◆ verifyTables()

bool PANEL_SYM_LIB_TABLE::verifyTables ( )
private

Trim important fields, removes blank row entries, and checks for duplicates.

Returns
bool - true if tables are OK, else false.

Definition at line 332 of file panel_sym_lib_table.cpp.

333 {
334  wxString msg;
335 
336  for( SYMBOL_LIB_TABLE_GRID* model : { global_model(), project_model() } )
337  {
338  if( !model )
339  continue;
340 
341  for( int r = 0; r < model->GetNumberRows(); )
342  {
343  wxString nick = model->GetValue( r, COL_NICKNAME ).Trim( false ).Trim();
344  wxString uri = model->GetValue( r, COL_URI ).Trim( false ).Trim();
345  unsigned illegalCh = 0;
346 
347  if( !nick || !uri )
348  {
349  if( !nick && !uri )
350  msg = _( "A library table row nickname and path cells are empty." );
351  else if( !nick )
352  msg = _( "A library table row nickname cell is empty." );
353  else
354  msg = _( "A library table row path cell is empty." );
355 
356  wxMessageDialog badCellDlg( this, msg, _( "Invalid Row Definition" ),
357  wxYES_NO | wxCENTER | wxICON_QUESTION | wxYES_DEFAULT );
358  badCellDlg.SetExtendedMessage( _( "Empty cells will result in all rows that are "
359  "invalid to be removed from the table." ) );
360  badCellDlg.SetYesNoLabels( wxMessageDialog::ButtonLabel( "Remove Invalid Cells" ),
361  wxMessageDialog::ButtonLabel( "Cancel Table Update" ) );
362 
363  if( badCellDlg.ShowModal() == wxID_NO )
364  return false;
365 
366  // Delete the "empty" row, where empty means missing nick or uri.
367  // This also updates the UI which could be slow, but there should only be a few
368  // rows to delete, unless the user fell asleep on the Add Row
369  // button.
370  model->DeleteRows( r, 1 );
371  }
372  else if( ( illegalCh = LIB_ID::FindIllegalLibraryNameChar( nick ) ) )
373  {
374  msg = wxString::Format( _( "Illegal character '%c' in nickname '%s'" ),
375  illegalCh,
376  nick );
377 
378  // show the tabbed panel holding the grid we have flunked:
379  if( model != cur_model() )
380  m_notebook->SetSelection( model == global_model() ? 0 : 1 );
381 
382  m_cur_grid->MakeCellVisible( r, 0 );
383  m_cur_grid->SetGridCursor( r, 1 );
384 
385  wxMessageDialog errdlg( this, msg, _( "Library Nickname Error" ) );
386  errdlg.ShowModal();
387  return false;
388  }
389  else
390  {
391  // set the trimmed values back into the table so they get saved to disk.
392  model->SetValue( r, COL_NICKNAME, nick );
393  model->SetValue( r, COL_URI, uri );
394  ++r; // this row was OK.
395  }
396  }
397  }
398 
399  // check for duplicate nickNames, separately in each table.
400  for( SYMBOL_LIB_TABLE_GRID* model : { global_model(), project_model() } )
401  {
402  if( !model )
403  continue;
404 
405  for( int r1 = 0; r1 < model->GetNumberRows() - 1; ++r1 )
406  {
407  wxString nick1 = model->GetValue( r1, COL_NICKNAME );
408 
409  for( int r2=r1+1; r2 < model->GetNumberRows(); ++r2 )
410  {
411  wxString nick2 = model->GetValue( r2, COL_NICKNAME );
412 
413  if( nick1 == nick2 )
414  {
415  msg = wxString::Format( _( "Multiple libraries cannot share the same "
416  "nickname ('%s')." ), nick1 );
417 
418  // show the tabbed panel holding the grid we have flunked:
419  if( model != cur_model() )
420  m_notebook->SetSelection( model == global_model() ? 0 : 1 );
421 
422  // go to the lower of the two rows, it is technically the duplicate:
423  m_cur_grid->MakeCellVisible( r2, 0 );
424  m_cur_grid->SetGridCursor( r2, 1 );
425 
426  wxMessageDialog errdlg( this, msg, _( "Library Nickname Error" ) );
427  errdlg.ShowModal();
428 
429  return false;
430  }
431  }
432  }
433  }
434 
435  for( SYMBOL_LIB_TABLE* table : { global_model(), project_model() } )
436  {
437  if( !table )
438  continue;
439 
440  for( unsigned int r = 0; r < table->GetCount(); ++r )
441  {
442  SYMBOL_LIB_TABLE_ROW& row = dynamic_cast<SYMBOL_LIB_TABLE_ROW&>( table->At( r ) );
443 
444  if( !row.GetIsEnabled() )
445  continue;
446 
447  try
448  {
449  if( row.Refresh() )
450  {
451  if( table == global_model() )
453  else
455  }
456  }
457  catch( const IO_ERROR& ioe )
458  {
459  msg.Printf( _( "Symbol library '%s' failed to load." ), row.GetNickName() );
460 
461  wxMessageDialog errdlg( this, msg + wxS( "\n" ) + ioe.What(),
462  _( "Error Loading Library" ) );
463  errdlg.ShowModal();
464 
465  return false;
466  }
467  }
468  }
469 
470  return true;
471 }
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
WX_GRID * m_cur_grid
changed based on tab choice
SYMBOL_LIB_TABLE_GRID * global_model() const
const wxString & GetNickName() const
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.
bool GetIsEnabled() const
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
SYMBOL_LIB_TABLE_GRID * cur_model() const
bool Refresh()
Attempt to reload the library.
#define _(s)
E_SERIE r
Definition: eserie.cpp:41
DIALOG_EDIT_LIBRARY_TABLES * m_parent
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
SYMBOL_LIB_TABLE_GRID * project_model() const
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
static unsigned FindIllegalLibraryNameChar(const UTF8 &aLibraryName)
Looks for characters that are illegal in library nicknames.
Definition: lib_id.cpp:240

References _, COL_NICKNAME, COL_URI, cur_model(), LIB_ID::FindIllegalLibraryNameChar(), Format(), LIB_TABLE_ROW::GetIsEnabled(), LIB_TABLE_ROW::GetNickName(), global_model(), m_cur_grid, DIALOG_EDIT_LIBRARY_TABLES::m_GlobalTableChanged, PANEL_SYM_LIB_TABLE_BASE::m_notebook, m_parent, DIALOG_EDIT_LIBRARY_TABLES::m_ProjectTableChanged, project_model(), r, SYMBOL_LIB_TABLE_ROW::Refresh(), and IO_ERROR::What().

Referenced by TransferDataFromWindow().

Member Data Documentation

◆ m_append_button

wxBitmapButton* PANEL_SYM_LIB_TABLE_BASE::m_append_button
protectedinherited

◆ m_browse_button

wxBitmapButton* PANEL_SYM_LIB_TABLE_BASE::m_browse_button
protectedinherited

◆ m_convertLegacy

wxButton* PANEL_SYM_LIB_TABLE_BASE::m_convertLegacy
protectedinherited

◆ m_cur_grid

◆ m_delete_button

wxBitmapButton* PANEL_SYM_LIB_TABLE_BASE::m_delete_button
protectedinherited

◆ m_global_grid

◆ m_global_panel

wxPanel* PANEL_SYM_LIB_TABLE_BASE::m_global_panel
protectedinherited

◆ m_globalTable

SYMBOL_LIB_TABLE* PANEL_SYM_LIB_TABLE::m_globalTable
private

Definition at line 79 of file panel_sym_lib_table.h.

Referenced by PANEL_SYM_LIB_TABLE(), and TransferDataFromWindow().

◆ m_lastProjectLibDir

wxString PANEL_SYM_LIB_TABLE::m_lastProjectLibDir
private

Definition at line 87 of file panel_sym_lib_table.h.

Referenced by browseLibrariesHandler(), and PANEL_SYM_LIB_TABLE().

◆ m_move_down_button

wxBitmapButton* PANEL_SYM_LIB_TABLE_BASE::m_move_down_button
protectedinherited

◆ m_move_up_button

wxBitmapButton* PANEL_SYM_LIB_TABLE_BASE::m_move_up_button
protectedinherited

◆ m_notebook

wxNotebook* PANEL_SYM_LIB_TABLE_BASE::m_notebook
protectedinherited

◆ m_pageNdx

size_t PANEL_SYM_LIB_TABLE::m_pageNdx = 0
staticprivate

Remember the last notebook page selected.

Definition at line 86 of file panel_sym_lib_table.h.

Referenced by browseLibrariesHandler(), OnUpdateUI(), PANEL_SYM_LIB_TABLE(), and ~PANEL_SYM_LIB_TABLE().

◆ m_parent

DIALOG_EDIT_LIBRARY_TABLES* PANEL_SYM_LIB_TABLE::m_parent
private

◆ m_path_subs_grid

◆ m_project

PROJECT* PANEL_SYM_LIB_TABLE::m_project
private

◆ m_project_grid

WX_GRID* PANEL_SYM_LIB_TABLE_BASE::m_project_grid
protectedinherited

◆ m_project_panel

wxPanel* PANEL_SYM_LIB_TABLE_BASE::m_project_panel
protectedinherited

◆ m_projectTable

SYMBOL_LIB_TABLE* PANEL_SYM_LIB_TABLE::m_projectTable
private

Definition at line 80 of file panel_sym_lib_table.h.

Referenced by PANEL_SYM_LIB_TABLE(), and TransferDataFromWindow().


The documentation for this class was generated from the following files: