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, SYMBOL_LIB_TABLE *aGlobal, const wxString &aGlobalTablePath, SYMBOL_LIB_TABLE *aProject, const wxString &aProjectTablePath, const wxString &m_projectBasePath)
 
virtual ~PANEL_SYM_LIB_TABLE ()
 

Protected Attributes

wxAuiNotebook * m_auinotebook
 
wxPanel * m_global_panel
 
wxStaticText * m_staticText3
 
wxStaticText * m_GblTableFilename
 
WX_GRIDm_global_grid
 
wxPanel * m_project_panel
 
wxStaticText * m_staticText4
 
wxStaticText * m_PrjTableFilename
 
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
 
WX_GRIDm_path_subs_grid
 

Private Member Functions

bool verifyTables ()
 Trim important fields, removes blank row entries, and checks for duplicates. More...
 
void pageChangedHandler (wxAuiNotebookEvent &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)
 
bool TransferDataFromWindow () override
 
void populateEnvironReadOnlyTable ()
 Populate the readonly environment variable table with names and values by examining all the full_uri columns. More...
 
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
 
wxString m_projectBasePath
 
DIALOG_EDIT_LIBRARY_TABLESm_parent
 
WX_GRIDm_cur_grid
 changed based on tab choice More...
 
wxString m_lastBrowseDir
 last browsed directory More...
 

Static Private Attributes

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

Detailed Description

Dialog to show and edit symbol library tables.

Definition at line 34 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,
SYMBOL_LIB_TABLE aGlobal,
const wxString &  aGlobalTablePath,
SYMBOL_LIB_TABLE aProject,
const wxString &  aProjectTablePath,
const wxString &  m_projectBasePath 
)

Definition at line 145 of file panel_sym_lib_table.cpp.

150  :
151  PANEL_SYM_LIB_TABLE_BASE( aParent ),
152  m_globalTable( aGlobal ),
153  m_projectTable( aProject ),
154  m_projectBasePath( aProjectBasePath ),
155  m_parent( aParent ),
156  m_lastBrowseDir( aProjectBasePath )
157 {
158  // For user info, shows the table filenames:
159  m_GblTableFilename->SetLabel( aGlobalTablePath );
160  m_PrjTableFilename->SetLabel( aProjectTablePath );
161 
162  // wxGrid only supports user owned tables if they exist past end of ~wxGrid(),
163  // so make it a grid owned table.
164  m_global_grid->SetTable( new SYMBOL_LIB_TABLE_GRID( *aGlobal ), true );
165  m_project_grid->SetTable( new SYMBOL_LIB_TABLE_GRID( *aProject ), true );
166 
167  // Give a bit more room for combobox editors
168  m_global_grid->SetDefaultRowSize( m_global_grid->GetDefaultRowSize() + 4 );
169  m_project_grid->SetDefaultRowSize( m_project_grid->GetDefaultRowSize() + 4 );
170 
171  // add Cut, Copy, and Paste to wxGrids
172  m_global_grid->PushEventHandler( new SYMBOL_GRID_TRICKS( m_parent, m_global_grid ) );
173  m_project_grid->PushEventHandler( new SYMBOL_GRID_TRICKS( m_parent, m_project_grid ) );
174  m_path_subs_grid->PushEventHandler( new GRID_TRICKS( m_path_subs_grid ) );
175 
176  m_global_grid->SetSelectionMode( wxGrid::wxGridSelectRows );
177  m_project_grid->SetSelectionMode( wxGrid::wxGridSelectRows );
178 
179  m_global_grid->AutoSizeColumns( false );
180  m_project_grid->AutoSizeColumns( false );
181 
182  wxArrayString pluginChoices;
183 
184 // pluginChoices.Add( SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_KICAD ) );
185  pluginChoices.Add( SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY ) );
186 
188 
189  for( wxGrid* g : { m_global_grid, m_project_grid } )
190  {
191  // Set special attributes
192  wxGridCellAttr* attr;
193 
194  attr = new wxGridCellAttr;
195  attr->SetEditor( new GRID_CELL_SYMLIB_EDITOR( m_parent, &m_lastBrowseDir,
197  g->SetColAttr( COL_URI, attr );
198 
199  attr = new wxGridCellAttr;
200  attr->SetEditor( new wxGridCellChoiceEditor( pluginChoices ) );
201  g->SetColAttr( COL_TYPE, attr );
202 
203  attr = new wxGridCellAttr;
204  attr->SetRenderer( new wxGridCellBoolRenderer() );
205  attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
206  g->SetColAttr( COL_ENABLED, attr );
207 
208  // all but COL_OPTIONS, which is edited with Option Editor anyways.
209  g->AutoSizeColumn( COL_NICKNAME, false );
210  g->AutoSizeColumn( COL_TYPE, false );
211  g->AutoSizeColumn( COL_URI, false );
212  g->AutoSizeColumn( COL_DESCR, false );
213  g->AutoSizeColumn( COL_ENABLED, false );
214 
215  // would set this to width of title, if it was easily known.
216  g->SetColSize( COL_OPTIONS, 80 );
217  }
218 
219  // select the last selected page
220  m_auinotebook->SetSelection( m_pageNdx );
222 
223  // for ALT+A handling, we want the initial focus to be on the first selected grid.
225 
226  // Configure button logos
227  m_append_button->SetBitmap( KiBitmap( small_plus_xpm ) );
228  m_delete_button->SetBitmap( KiBitmap( trash_xpm ) );
229  m_move_up_button->SetBitmap( KiBitmap( small_up_xpm ) );
230  m_move_down_button->SetBitmap( KiBitmap( small_down_xpm ) );
231  m_browse_button->SetBitmap( KiBitmap( folder_xpm ) );
232 
233  // Gives a selection to each grid, mainly for delete button. wxGrid's wake up with
234  // a currentCell which is sometimes not highlighted.
235  if( m_global_grid->GetNumberRows() > 0 )
236  m_global_grid->SelectRow( 0 );
237 
238  if( m_project_grid->GetNumberRows() > 0 )
239  m_project_grid->SelectRow( 0 );
240 }
static const wxString ShowType(SCH_FILE_T aFileType)
Return a brief name for a plugin, given aFileType enum.
Definition: sch_io_mgr.cpp:76
PANEL_SYM_LIB_TABLE_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(500, 300), long style=wxTAB_TRAVERSAL)
WX_GRID * m_cur_grid
changed based on tab choice
Class GRID_TRICKS is used to add mouse and command handling (such as cut, copy, and paste) to a WX_GR...
Definition: grid_tricks.h:51
wxString SchematicLibraryFileWildcard()
static size_t m_pageNdx
Remember the last notebook page selected during a session.
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:57
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:116
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:79
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
DIALOG_EDIT_LIBRARY_TABLES * m_parent
wxString m_lastBrowseDir
last browsed directory
SYMBOL_LIB_TABLE * m_globalTable

References COL_DESCR, COL_ENABLED, COL_NICKNAME, COL_OPTIONS, COL_TYPE, COL_URI, KiBitmap(), PANEL_SYM_LIB_TABLE_BASE::m_append_button, PANEL_SYM_LIB_TABLE_BASE::m_auinotebook, 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_GblTableFilename, PANEL_SYM_LIB_TABLE_BASE::m_global_grid, m_lastBrowseDir, PANEL_SYM_LIB_TABLE_BASE::m_move_down_button, PANEL_SYM_LIB_TABLE_BASE::m_move_up_button, m_pageNdx, m_parent, PANEL_SYM_LIB_TABLE_BASE::m_path_subs_grid, PANEL_SYM_LIB_TABLE_BASE::m_PrjTableFilename, PANEL_SYM_LIB_TABLE_BASE::m_project_grid, populateEnvironReadOnlyTable(), SchematicLibraryFileWildcard(), DIALOG_SHIM::SetInitialFocus(), WX_GRID::SetTable(), and SCH_IO_MGR::ShowType().

◆ ~PANEL_SYM_LIB_TABLE()

PANEL_SYM_LIB_TABLE::~PANEL_SYM_LIB_TABLE ( )
virtual

Definition at line 243 of file panel_sym_lib_table.cpp.

244 {
245  // When the dialog is closed it will hide the current notebook page first, which will
246  // in turn select the other one. We then end up saving its index as the "current page".
247  // So flip them back again:
248  m_pageNdx = m_pageNdx == 1 ? 0 : 1;
249 
250  // Delete the GRID_TRICKS.
251  // Any additional event handlers should be popped before the window is deleted.
252  m_global_grid->PopEventHandler( true );
253  m_project_grid->PopEventHandler( true );
254  m_path_subs_grid->PopEventHandler( true );
255 }
static size_t m_pageNdx
Remember the last notebook page selected during a session.

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 659 of file panel_sym_lib_table.cpp.

660 {
661  // Account for scroll bars
662  aWidth -= ( m_path_subs_grid->GetSize().x - m_path_subs_grid->GetClientSize().x );
663 
664  m_path_subs_grid->AutoSizeColumn( 0 );
665  m_path_subs_grid->SetColSize( 1, aWidth - m_path_subs_grid->GetColSize( 0 ) );
666 }

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 426 of file panel_sym_lib_table.cpp.

427 {
429  return;
430 
431  if( m_cur_grid->AppendRows( 1 ) )
432  {
433  int row = m_cur_grid->GetNumberRows() - 1;
434  // Gives a default type (currently, only one type exists):
435  m_cur_grid->SetCellValue( row, COL_TYPE, SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY ) );
436 
437  // wx documentation is wrong, SetGridCursor does not make visible.
438  m_cur_grid->MakeCellVisible( row, 0 );
439  m_cur_grid->SetGridCursor( row, 1 );
440 
441  m_cur_grid->EnableCellEditControl( true );
442  m_cur_grid->ShowCellEditControl();
443  }
444 }
static const wxString ShowType(SCH_FILE_T aFileType)
Return a brief name for a plugin, given aFileType enum.
Definition: sch_io_mgr.cpp:76
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:167

References COL_TYPE, WX_GRID::CommitPendingChanges(), m_cur_grid, and SCH_IO_MGR::ShowType().

◆ browseLibrariesHandler()

void PANEL_SYM_LIB_TABLE::browseLibrariesHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 346 of file panel_sym_lib_table.cpp.

347 {
348  wxFileDialog dlg( this, _( "Select Library" ), m_lastBrowseDir,
349  wxEmptyString, SchematicLibraryFileWildcard(),
350  wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE );
351 
352  auto result = dlg.ShowModal();
353 
354  if( result == wxID_CANCEL )
355  return;
356 
357  m_lastBrowseDir = dlg.GetDirectory();
358 
359  const ENV_VAR_MAP& envVars = Pgm().GetLocalEnvVariables();
360  bool addDuplicates = false;
361  bool applyToAll = false;
362  wxString warning = _( "Warning: Duplicate Nickname" );
363  wxString msg = _( "A library nicknamed \"%s\" already exists." );
364  wxArrayString files;
365  dlg.GetFilenames( files );
366 
367  for( const auto& file : files )
368  {
369  wxString filePath = dlg.GetDirectory() + wxFileName::GetPathSeparator() + file;
370  wxFileName fn( filePath );
371  wxString nickname = LIB_ID::FixIllegalChars( fn.GetName(), LIB_ID::ID_SCH );
372  bool doAdd = true;
373 
374  if( cur_model()->ContainsNickname( nickname ) )
375  {
376  if( !applyToAll )
377  {
378  int ret = YesOrCancelDialog( this, warning, wxString::Format( msg, nickname ),
379  _( "Skip" ), _( "Add Anyway" ), &applyToAll );
380  addDuplicates = (ret == wxID_CANCEL );
381  }
382 
383  doAdd = addDuplicates;
384  }
385 
386  if( doAdd && m_cur_grid->AppendRows( 1 ) )
387  {
388  int last_row = m_cur_grid->GetNumberRows() - 1;
389 
390  m_cur_grid->SetCellValue( last_row, COL_NICKNAME, nickname );
391 
392  // TODO the following code can detect only schematic types, not libs
393  // SCH_IO_MGR needs to provide file extension information for libraries too
394 
395  // auto detect the plugin type
396  /*for( auto pluginType : SCH_IO_MGR::SCH_FILE_T_vector )
397  {
398  if( SCH_IO_MGR::GetFileExtension( pluginType ).Lower() == fn.GetExt().Lower() )
399  {
400  m_cur_grid->SetCellValue( last_row, COL_TYPE,
401  SCH_IO_MGR::ShowType( pluginType ) );
402  break;
403  }
404  }*/
405  m_cur_grid->SetCellValue( last_row, COL_TYPE,
406  SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY ) );
407 
408  // try to use path normalized to an environmental variable or project path
409  wxString path = NormalizePath( filePath, &envVars, m_projectBasePath );
410 
411  if( path.IsEmpty() )
412  path = fn.GetFullPath();
413 
414  m_cur_grid->SetCellValue( last_row, COL_URI, path );
415  }
416  }
417 
418  if( !files.IsEmpty() )
419  {
420  m_cur_grid->MakeCellVisible( m_cur_grid->GetNumberRows() - 1, 0 );
421  m_cur_grid->SetGridCursor( m_cur_grid->GetNumberRows() - 1, 1 );
422  }
423 }
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:76
WX_GRID * m_cur_grid
changed based on tab choice
wxString SchematicLibraryFileWildcard()
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:66
int YesOrCancelDialog(wxWindow *aParent, const wxString &aWarning, const wxString &aMessage, const wxString &aOKLabel, const wxString &aCancelLabel, bool *aApplyToAll)
Function YesOrCancelDialog displays a warning dialog with aMessage and returns the user response.
Definition: confirm.cpp:224
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
Definition: pgm_base.h:131
SYMBOL_LIB_TABLE_GRID * cur_model() const
VTBL_ENTRY const ENV_VAR_MAP & GetLocalEnvVariables() const
Definition: pgm_base.h:314
wxString m_lastBrowseDir
last browsed directory
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
static UTF8 FixIllegalChars(const UTF8 &aLibItemName, LIB_ID_TYPE aType, bool aLib=false)
Replace illegal LIB_ID item name characters with underscores '_'.
Definition: lib_id.cpp:352
wxString NormalizePath(const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
Normalizes a file path to an environmental variable, if possible.
Definition: env_paths.cpp:67

References COL_NICKNAME, COL_TYPE, COL_URI, LIB_TABLE_GRID::ContainsNickname(), cur_model(), LIB_ID::FixIllegalChars(), Format(), PGM_BASE::GetLocalEnvVariables(), LIB_ID::ID_SCH, m_cur_grid, m_lastBrowseDir, m_projectBasePath, NormalizePath(), Pgm(), SchematicLibraryFileWildcard(), SCH_IO_MGR::ShowType(), and YesOrCancelDialog().

◆ cur_model()

SYMBOL_LIB_TABLE_GRID * PANEL_SYM_LIB_TABLE::cur_model ( ) const
private

Definition at line 689 of file panel_sym_lib_table.cpp.

690 {
691  return (SYMBOL_LIB_TABLE_GRID*) m_cur_grid->GetTable();
692 }
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 447 of file panel_sym_lib_table.cpp.

448 {
450  return;
451 
452  int curRow = m_cur_grid->GetGridCursorRow();
453  int curCol = m_cur_grid->GetGridCursorCol();
454 
455  // In a wxGrid, collect rows that have a selected cell, or are selected
456  // is not so easy: it depend on the way the selection was made.
457  // Here, we collect row selected by clicking on a row label, and
458  // row that contain a cell previously selected.
459  // If no candidate, just delete the row with the grid cursor.
460  wxArrayInt selectedRows = m_cur_grid->GetSelectedRows();
461  wxGridCellCoordsArray cells = m_cur_grid->GetSelectedCells();
462  wxGridCellCoordsArray blockTopLeft = m_cur_grid->GetSelectionBlockTopLeft();
463  wxGridCellCoordsArray blockBotRight = m_cur_grid->GetSelectionBlockBottomRight();
464 
465  // Add all row having cell selected to list:
466  for( unsigned ii = 0; ii < cells.GetCount(); ii++ )
467  selectedRows.Add( cells[ii].GetRow() );
468 
469  // Handle block selection
470  if( !blockTopLeft.IsEmpty() && !blockBotRight.IsEmpty() )
471  {
472  for( int i = blockTopLeft[0].GetRow(); i <= blockBotRight[0].GetRow(); ++i )
473  selectedRows.Add( i );
474  }
475 
476  // Use the row having the grid cursor only if we have no candidate:
477  if( selectedRows.size() == 0 && m_cur_grid->GetGridCursorRow() >= 0 )
478  selectedRows.Add( m_cur_grid->GetGridCursorRow() );
479 
480  if( selectedRows.size() == 0 )
481  {
482  wxBell();
483  return;
484  }
485 
486  std::sort( selectedRows.begin(), selectedRows.end() );
487 
488  // Remove selected rows (note: a row can be stored more than once in list)
489  int last_row = -1;
490 
491  for( int ii = selectedRows.GetCount()-1; ii >= 0; ii-- )
492  {
493  int row = selectedRows[ii];
494 
495  if( row != last_row )
496  {
497  last_row = row;
498  m_cur_grid->DeleteRows( row, 1 );
499  }
500  }
501 
502  m_cur_grid->SetGridCursor( std::min( curRow, m_cur_grid->GetNumberRows() - 1 ), curCol );
503 }
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:167
size_t i
Definition: json11.cpp:597
#define min(a, b)
Definition: auxiliary.h:85

References WX_GRID::CommitPendingChanges(), i, m_cur_grid, and min.

◆ global_model()

SYMBOL_LIB_TABLE_GRID * PANEL_SYM_LIB_TABLE::global_model ( ) const
private

Definition at line 677 of file panel_sym_lib_table.cpp.

678 {
679  return (SYMBOL_LIB_TABLE_GRID*) m_global_grid->GetTable();
680 }
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 536 of file panel_sym_lib_table.cpp.

537 {
539  return;
540 
542  int curRow = m_cur_grid->GetGridCursorRow();
543 
544  // @todo: add multiple selection moves.
545  if( unsigned( curRow + 1 ) < tbl->rows.size() )
546  {
547  boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
548  tbl->rows.release( tbl->rows.begin() + curRow );
549 
550  ++curRow;
551  tbl->rows.insert( tbl->rows.begin() + curRow, move_me.release() );
552 
553  if( tbl->GetView() )
554  {
555  // Update the wxGrid
556  wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow - 1, 0 );
557  tbl->GetView()->ProcessTableMessage( msg );
558  }
559 
560  m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
561  m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
562  }
563 }
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:167

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 506 of file panel_sym_lib_table.cpp.

507 {
509  return;
510 
512  int curRow = m_cur_grid->GetGridCursorRow();
513 
514  // @todo: add multiple selection moves.
515  if( curRow >= 1 )
516  {
517  boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
518  tbl->rows.release( tbl->rows.begin() + curRow );
519 
520  --curRow;
521  tbl->rows.insert( tbl->rows.begin() + curRow, move_me.release() );
522 
523  if( tbl->GetView() )
524  {
525  // Update the wxGrid
526  wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow, 0 );
527  tbl->GetView()->ProcessTableMessage( msg );
528  }
529 
530  m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
531  m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
532  }
533 }
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:167

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

◆ onSizeGrid()

void PANEL_SYM_LIB_TABLE::onSizeGrid ( wxSizeEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 669 of file panel_sym_lib_table.cpp.

670 {
671  adjustPathSubsGridColumns( event.GetSize().GetX() );
672 
673  event.Skip();
674 }
void adjustPathSubsGridColumns(int aWidth)

References adjustPathSubsGridColumns().

◆ pageChangedHandler()

void PANEL_SYM_LIB_TABLE::pageChangedHandler ( wxAuiNotebookEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 339 of file panel_sym_lib_table.cpp.

340 {
341  m_pageNdx = (unsigned) std::max( 0, m_auinotebook->GetSelection() );
343 }
WX_GRID * m_cur_grid
changed based on tab choice
static size_t m_pageNdx
Remember the last notebook page selected during a session.
#define max(a, b)
Definition: auxiliary.h:86

References PANEL_SYM_LIB_TABLE_BASE::m_auinotebook, m_cur_grid, PANEL_SYM_LIB_TABLE_BASE::m_global_grid, m_pageNdx, PANEL_SYM_LIB_TABLE_BASE::m_project_grid, and max.

◆ 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 598 of file panel_sym_lib_table.cpp.

599 {
600  wxRegEx re( ".*?(\\$\\{(.+?)\\})|(\\$\\((.+?)\\)).*?", wxRE_ADVANCED );
601  wxASSERT( re.IsValid() ); // wxRE_ADVANCED is required.
602 
603  std::set< wxString > unique;
604 
605  // clear the table
606  m_path_subs_grid->DeleteRows( 0, m_path_subs_grid->GetNumberRows() );
607 
608  for( SYMBOL_LIB_TABLE_GRID* tbl : { global_model(), project_model() } )
609  {
610  for( int row = 0; row < tbl->GetNumberRows(); ++row )
611  {
612  wxString uri = tbl->GetValue( row, COL_URI );
613 
614  while( re.Matches( uri ) )
615  {
616  wxString envvar = re.GetMatch( uri, 2 );
617 
618  // if not ${...} form then must be $(...)
619  if( envvar.IsEmpty() )
620  envvar = re.GetMatch( uri, 4 );
621 
622  // ignore duplicates
623  unique.insert( envvar );
624 
625  // delete the last match and search again
626  uri.Replace( re.GetMatch( uri, 0 ), wxEmptyString );
627  }
628  }
629  }
630 
631  // Make sure this special environment variable shows up even if it was
632  // not used yet. It is automatically set by KiCad to the directory holding
633  // the current project.
634  unique.insert( PROJECT_VAR_NAME );
636 
637  for( wxString evName : unique )
638  {
639  int row = m_path_subs_grid->GetNumberRows();
640  m_path_subs_grid->AppendRows( 1 );
641 
642  m_path_subs_grid->SetCellValue( row, 0, wxT( "${" ) + evName + wxT( "}" ) );
643  m_path_subs_grid->SetCellEditor( row, 0, new GRID_CELL_READONLY_TEXT_EDITOR() );
644 
645  wxString evValue;
646  wxGetEnv( evName, &evValue );
647  m_path_subs_grid->SetCellValue( row, 1, evValue );
648  m_path_subs_grid->SetCellEditor( row, 1, new GRID_CELL_READONLY_TEXT_EDITOR() );
649  }
650 
651  // No combobox editors here, but it looks better if its consistent with the other
652  // grids in the dialog.
653  m_path_subs_grid->SetDefaultRowSize( m_path_subs_grid->GetDefaultRowSize() + 2 );
654 
655  adjustPathSubsGridColumns( m_path_subs_grid->GetRect().GetWidth() );
656 }
#define PROJECT_VAR_NAME
A variable name whose value holds the current project directory.
Definition: project.h:37
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

References adjustPathSubsGridColumns(), 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 683 of file panel_sym_lib_table.cpp.

684 {
685  return (SYMBOL_LIB_TABLE_GRID*) m_project_grid->GetTable();
686 }
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 566 of file panel_sym_lib_table.cpp.

567 {
569  return false;
570 
571  if( !verifyTables() )
572  return false;
573 
574  if( *global_model() != *m_globalTable )
575  {
577 
578  m_globalTable->Clear();
579  m_globalTable->rows.transfer( m_globalTable->rows.end(), global_model()->rows.begin(),
580  global_model()->rows.end(), global_model()->rows );
582  }
583 
584  if( *project_model() != *m_projectTable )
585  {
587 
589  m_projectTable->rows.transfer( m_projectTable->rows.end(), project_model()->rows.begin(),
590  project_model()->rows.end(), project_model()->rows );
592  }
593 
594  return true;
595 }
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:167
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 258 of file panel_sym_lib_table.cpp.

259 {
260  for( SYMBOL_LIB_TABLE_GRID* model : { global_model(), project_model() } )
261  {
262  for( int r = 0; r < model->GetNumberRows(); )
263  {
264  wxString nick = model->GetValue( r, COL_NICKNAME ).Trim( false ).Trim();
265  wxString uri = model->GetValue( r, COL_URI ).Trim( false ).Trim();
266  unsigned illegalCh = 0;
267 
268  if( !nick || !uri )
269  {
270  // Delete the "empty" row, where empty means missing nick or uri.
271  // This also updates the UI which could be slow, but there should only be a few
272  // rows to delete, unless the user fell asleep on the Add Row
273  // button.
274  model->DeleteRows( r, 1 );
275  }
276  else if( ( illegalCh = LIB_ID::FindIllegalLibNicknameChar( nick, LIB_ID::ID_SCH ) ) )
277  {
278  wxString msg = wxString::Format( _( "Illegal character '%c' in Nickname: \"%s\"" ),
279  illegalCh,
280  nick );
281 
282  // show the tabbed panel holding the grid we have flunked:
283  if( model != cur_model() )
284  m_auinotebook->SetSelection( model == global_model() ? 0 : 1 );
285 
286  m_cur_grid->MakeCellVisible( r, 0 );
287  m_cur_grid->SetGridCursor( r, 1 );
288 
289  wxMessageDialog errdlg( this, msg, _( "No Colon in Nicknames" ) );
290  errdlg.ShowModal();
291  return false;
292  }
293  else
294  {
295  // set the trimmed values back into the table so they get saved to disk.
296  model->SetValue( r, COL_NICKNAME, nick );
297  model->SetValue( r, COL_URI, uri );
298  ++r; // this row was OK.
299  }
300  }
301  }
302 
303  // check for duplicate nickNames, separately in each table.
304  for( SYMBOL_LIB_TABLE_GRID* model : { global_model(), project_model() } )
305  {
306  for( int r1 = 0; r1 < model->GetNumberRows() - 1; ++r1 )
307  {
308  wxString nick1 = model->GetValue( r1, COL_NICKNAME );
309 
310  for( int r2=r1+1; r2 < model->GetNumberRows(); ++r2 )
311  {
312  wxString nick2 = model->GetValue( r2, COL_NICKNAME );
313 
314  if( nick1 == nick2 )
315  {
316  wxString msg = wxString::Format( _( "Duplicate Nickname: \"%s\"." ), nick1 );
317 
318  // show the tabbed panel holding the grid we have flunked:
319  if( model != cur_model() )
320  m_auinotebook->SetSelection( model == global_model() ? 0 : 1 );
321 
322  // go to the lower of the two rows, it is technically the duplicate:
323  m_cur_grid->MakeCellVisible( r2, 0 );
324  m_cur_grid->SetGridCursor( r2, 1 );
325 
326  wxMessageDialog errdlg( this, msg, _( "Please Delete or Modify One" ) );
327  errdlg.ShowModal();
328 
329  return false;
330  }
331  }
332  }
333  }
334 
335  return true;
336 }
WX_GRID * m_cur_grid
changed based on tab choice
static unsigned FindIllegalLibNicknameChar(const UTF8 &aNickname, LIB_ID_TYPE aType)
Looks for characters that are illegal in library nicknames.
Definition: lib_id.cpp:398
SYMBOL_LIB_TABLE_GRID * global_model() const
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.
SYMBOL_LIB_TABLE_GRID * cur_model() const
SYMBOL_LIB_TABLE_GRID * project_model() const
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

References COL_NICKNAME, COL_URI, cur_model(), LIB_ID::FindIllegalLibNicknameChar(), Format(), global_model(), LIB_ID::ID_SCH, PANEL_SYM_LIB_TABLE_BASE::m_auinotebook, m_cur_grid, and project_model().

Referenced by TransferDataFromWindow().

Member Data Documentation

◆ m_append_button

wxBitmapButton* PANEL_SYM_LIB_TABLE_BASE::m_append_button
protectedinherited

◆ m_auinotebook

wxAuiNotebook* PANEL_SYM_LIB_TABLE_BASE::m_auinotebook
protectedinherited

◆ m_browse_button

wxBitmapButton* PANEL_SYM_LIB_TABLE_BASE::m_browse_button
protectedinherited

◆ m_cur_grid

◆ m_delete_button

wxBitmapButton* PANEL_SYM_LIB_TABLE_BASE::m_delete_button
protectedinherited

◆ m_GblTableFilename

wxStaticText* PANEL_SYM_LIB_TABLE_BASE::m_GblTableFilename
protectedinherited

◆ m_global_grid

WX_GRID* PANEL_SYM_LIB_TABLE_BASE::m_global_grid
protectedinherited

◆ 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 68 of file panel_sym_lib_table.h.

Referenced by TransferDataFromWindow().

◆ m_lastBrowseDir

wxString PANEL_SYM_LIB_TABLE::m_lastBrowseDir
private

last browsed directory

Definition at line 82 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_pageNdx

size_t PANEL_SYM_LIB_TABLE::m_pageNdx = 0
staticprivate

Remember the last notebook page selected during a session.

Definition at line 81 of file panel_sym_lib_table.h.

Referenced by pageChangedHandler(), PANEL_SYM_LIB_TABLE(), and ~PANEL_SYM_LIB_TABLE().

◆ m_parent

DIALOG_EDIT_LIBRARY_TABLES* PANEL_SYM_LIB_TABLE::m_parent
private

Definition at line 78 of file panel_sym_lib_table.h.

Referenced by PANEL_SYM_LIB_TABLE(), and TransferDataFromWindow().

◆ m_path_subs_grid

◆ m_PrjTableFilename

wxStaticText* PANEL_SYM_LIB_TABLE_BASE::m_PrjTableFilename
protectedinherited

◆ 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_projectBasePath

wxString PANEL_SYM_LIB_TABLE::m_projectBasePath
private

Definition at line 70 of file panel_sym_lib_table.h.

Referenced by browseLibrariesHandler().

◆ m_projectTable

SYMBOL_LIB_TABLE* PANEL_SYM_LIB_TABLE::m_projectTable
private

Definition at line 69 of file panel_sym_lib_table.h.

Referenced by TransferDataFromWindow().

◆ m_staticText3

wxStaticText* PANEL_SYM_LIB_TABLE_BASE::m_staticText3
protectedinherited

◆ m_staticText4

wxStaticText* PANEL_SYM_LIB_TABLE_BASE::m_staticText4
protectedinherited

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