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

212  :
213  PANEL_SYM_LIB_TABLE_BASE( aParent ),
214  m_globalTable( aGlobal ),
215  m_projectTable( aProject ),
216  m_projectBasePath( aProjectBasePath ),
217  m_parent( aParent ),
218  m_lastBrowseDir( aProjectBasePath )
219 {
220  // For user info, shows the table filenames:
221  m_GblTableFilename->SetLabel( aGlobalTablePath );
222  m_PrjTableFilename->SetLabel( aProjectTablePath );
223 
224  // wxGrid only supports user owned tables if they exist past end of ~wxGrid(),
225  // so make it a grid owned table.
226  m_global_grid->SetTable( new SYMBOL_LIB_TABLE_GRID( *aGlobal ), true );
227  m_project_grid->SetTable( new SYMBOL_LIB_TABLE_GRID( *aProject ), true );
228 
229  // Give a bit more room for combobox editors
230  m_global_grid->SetDefaultRowSize( m_global_grid->GetDefaultRowSize() + 4 );
231  m_project_grid->SetDefaultRowSize( m_project_grid->GetDefaultRowSize() + 4 );
232 
233  // add Cut, Copy, and Paste to wxGrids
234  m_global_grid->PushEventHandler( new SYMBOL_GRID_TRICKS( m_parent, m_global_grid ) );
235  m_project_grid->PushEventHandler( new SYMBOL_GRID_TRICKS( m_parent, m_project_grid ) );
236  m_path_subs_grid->PushEventHandler( new GRID_TRICKS( m_path_subs_grid ) );
237 
238  m_global_grid->SetSelectionMode( wxGrid::wxGridSelectRows );
239  m_project_grid->SetSelectionMode( wxGrid::wxGridSelectRows );
240 
241  m_global_grid->AutoSizeColumns( false );
242  m_project_grid->AutoSizeColumns( false );
243 
244  wxArrayString pluginChoices;
245 
246  pluginChoices.Add( SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY ) );
247  pluginChoices.Add( SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_KICAD ) );
248 
250 
251  for( wxGrid* g : { m_global_grid, m_project_grid } )
252  {
253  // Set special attributes
254  wxGridCellAttr* attr;
255 
256  attr = new wxGridCellAttr;
257  attr->SetEditor( new GRID_CELL_SYMLIB_EDITOR( m_parent, &m_lastBrowseDir,
259  g->SetColAttr( COL_URI, attr );
260 
261  attr = new wxGridCellAttr;
262  attr->SetEditor( new wxGridCellChoiceEditor( pluginChoices ) );
263  g->SetColAttr( COL_TYPE, attr );
264 
265  attr = new wxGridCellAttr;
266  attr->SetRenderer( new wxGridCellBoolRenderer() );
267  attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
268  g->SetColAttr( COL_ENABLED, attr );
269 
270  // all but COL_OPTIONS, which is edited with Option Editor anyways.
271  g->AutoSizeColumn( COL_NICKNAME, false );
272  g->AutoSizeColumn( COL_TYPE, false );
273  g->AutoSizeColumn( COL_URI, false );
274  g->AutoSizeColumn( COL_DESCR, false );
275  g->AutoSizeColumn( COL_ENABLED, false );
276 
277  // would set this to width of title, if it was easily known.
278  g->SetColSize( COL_OPTIONS, 80 );
279  }
280 
281  // select the last selected page
282  m_auinotebook->SetSelection( m_pageNdx );
284 
285  m_path_subs_grid->SetColLabelValue( 0, _( "Name" ) );
286  m_path_subs_grid->SetColLabelValue( 1, _( "Value" ) );
287 
288  // for ALT+A handling, we want the initial focus to be on the first selected grid.
290 
291  // Configure button logos
292  m_append_button->SetBitmap( KiBitmap( small_plus_xpm ) );
293  m_delete_button->SetBitmap( KiBitmap( trash_xpm ) );
294  m_move_up_button->SetBitmap( KiBitmap( small_up_xpm ) );
295  m_move_down_button->SetBitmap( KiBitmap( small_down_xpm ) );
296  m_browse_button->SetBitmap( KiBitmap( folder_xpm ) );
297 
298  // Gives a selection to each grid, mainly for delete button. wxGrid's wake up with
299  // a currentCell which is sometimes not highlighted.
300  if( m_global_grid->GetNumberRows() > 0 )
301  m_global_grid->SelectRow( 0 );
302 
303  if( m_project_grid->GetNumberRows() > 0 )
304  m_project_grid->SelectRow( 0 );
305 }
const BITMAP_OPAQUE trash_xpm[1]
Definition: trash.cpp:46
const BITMAP_OPAQUE folder_xpm[1]
Definition: folder.cpp:20
static const wxString ShowType(SCH_FILE_T aFileType)
Return a brief name for a plugin, given aFileType enum.
Definition: sch_io_mgr.cpp:79
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
GRID_TRICKS is used to add mouse and command handling (such as cut, copy, and paste) to a WX_GRID ins...
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:115
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:80
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
const BITMAP_OPAQUE small_down_xpm[1]
Definition: small_down.cpp:25
const BITMAP_OPAQUE small_up_xpm[1]
Definition: small_up.cpp:26
DIALOG_EDIT_LIBRARY_TABLES * m_parent
wxString m_lastBrowseDir
last browsed directory
#define _(s)
Definition: 3d_actions.cpp:33
SYMBOL_LIB_TABLE * m_globalTable
const BITMAP_OPAQUE small_plus_xpm[1]
Definition: small_plus.cpp:20

References _, COL_DESCR, COL_ENABLED, COL_NICKNAME, COL_OPTIONS, COL_TYPE, COL_URI, folder_xpm, 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(), SCH_IO_MGR::ShowType(), small_down_xpm, small_plus_xpm, small_up_xpm, and trash_xpm.

◆ ~PANEL_SYM_LIB_TABLE()

PANEL_SYM_LIB_TABLE::~PANEL_SYM_LIB_TABLE ( )
virtual

Definition at line 308 of file panel_sym_lib_table.cpp.

309 {
310  // When the dialog is closed it will hide the current notebook page first, which will
311  // in turn select the other one. We then end up saving its index as the "current page".
312  // So flip them back again:
313  m_pageNdx = m_pageNdx == 1 ? 0 : 1;
314 
315  // Delete the GRID_TRICKS.
316  // Any additional event handlers should be popped before the window is deleted.
317  m_global_grid->PopEventHandler( true );
318  m_project_grid->PopEventHandler( true );
319  m_path_subs_grid->PopEventHandler( true );
320 }
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 727 of file panel_sym_lib_table.cpp.

728 {
729  // Account for scroll bars
730  aWidth -= ( m_path_subs_grid->GetSize().x - m_path_subs_grid->GetClientSize().x );
731 
732  m_path_subs_grid->AutoSizeColumn( 0 );
733  m_path_subs_grid->SetColSize( 1, aWidth - m_path_subs_grid->GetColSize( 0 ) );
734 }

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

498 {
500  return;
501 
502  if( m_cur_grid->AppendRows( 1 ) )
503  {
504  int row = m_cur_grid->GetNumberRows() - 1;
505 
506  // wx documentation is wrong, SetGridCursor does not make visible.
507  m_cur_grid->MakeCellVisible( row, 0 );
508  m_cur_grid->SetGridCursor( row, 1 );
509  m_cur_grid->EnableCellEditControl( true );
510  m_cur_grid->ShowCellEditControl();
511  }
512 }
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:172

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

412 {
413  wxString wildcards = SchematicLibraryFileWildcard();
414 
415  wildcards += "|" + KiCadSymbolLibFileWildcard();
416 
417  wxFileDialog dlg( this, _( "Select Library" ), m_lastBrowseDir,
418  wxEmptyString, wildcards,
419  wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE );
420 
421  auto result = dlg.ShowModal();
422 
423  if( result == wxID_CANCEL )
424  return;
425 
426  m_lastBrowseDir = dlg.GetDirectory();
427 
428  const ENV_VAR_MAP& envVars = Pgm().GetLocalEnvVariables();
429  bool addDuplicates = false;
430  bool applyToAll = false;
431  wxString warning = _( "Warning: Duplicate Nickname" );
432  wxString msg = _( "A library nicknamed \"%s\" already exists." );
433  wxString detailedMsg = _( "Please change the library nickname after adding this library." );
434 
435  wxArrayString files;
436  dlg.GetFilenames( files );
437 
438  for( const auto& file : files )
439  {
440  wxString filePath = dlg.GetDirectory() + wxFileName::GetPathSeparator() + file;
441  wxFileName fn( filePath );
442  wxString nickname = LIB_ID::FixIllegalChars( fn.GetName(), LIB_ID::ID_SCH );
443  bool doAdd = true;
444 
445  if( cur_model()->ContainsNickname( nickname ) )
446  {
447  if( !applyToAll )
448  {
449  // The cancel button adds the library to the table anyway
450  addDuplicates = ( OKOrCancelDialog( this, warning, wxString::Format( msg, nickname ),
451  detailedMsg, _( "Skip" ), _( "Add Anyway" ), &applyToAll ) == wxID_CANCEL );
452  }
453 
454  doAdd = addDuplicates;
455  }
456 
457  if( doAdd && m_cur_grid->AppendRows( 1 ) )
458  {
459  int last_row = m_cur_grid->GetNumberRows() - 1;
460 
461  m_cur_grid->SetCellValue( last_row, COL_NICKNAME, nickname );
462 
463  // TODO the following code can detect only schematic types, not libs
464  // SCH_IO_MGR needs to provide file extension information for libraries too
465 
466  // auto detect the plugin type
467  for( auto pluginType : SCH_IO_MGR::SCH_FILE_T_vector )
468  {
469  if( SCH_IO_MGR::GetLibraryFileExtension( pluginType ).Lower() == fn.GetExt().Lower() )
470  {
471  m_cur_grid->SetCellValue( last_row, COL_TYPE,
472  SCH_IO_MGR::ShowType( pluginType ) );
473  break;
474  }
475  }
476 
477  // try to use path normalized to an environmental variable or project path
478  wxString path = NormalizePath( filePath, &envVars, m_projectBasePath );
479 
480  // Do not use the project path in the global library table. This will almost
481  // assuredly be wrong for a different project.
482  if( path.IsEmpty() || (m_pageNdx == 0 && path.Contains( "${KIPRJMOD}" )) )
483  path = fn.GetFullPath();
484 
485  m_cur_grid->SetCellValue( last_row, COL_URI, path );
486  }
487  }
488 
489  if( !files.IsEmpty() )
490  {
491  m_cur_grid->MakeCellVisible( m_cur_grid->GetNumberRows() - 1, 0 );
492  m_cur_grid->SetGridCursor( m_cur_grid->GetNumberRows() - 1, 1 );
493  }
494 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:103
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
wxString SchematicLibraryFileWildcard()
static size_t m_pageNdx
Remember the last notebook page selected during a session.
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
Definition: pgm_base.h:117
SYMBOL_LIB_TABLE_GRID * cur_model() const
wxString KiCadSymbolLibFileWildcard()
int OKOrCancelDialog(wxWindow *aParent, const wxString &aWarning, const wxString &aMessage, const wxString &aDetailedMessage, const wxString &aOKLabel, const wxString &aCancelLabel, bool *aApplyToAll)
Displays a warning dialog with aMessage and returns the user response.
Definition: confirm.cpp:214
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
#define _(s)
Definition: 3d_actions.cpp:33
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:68

References _, COL_NICKNAME, COL_TYPE, COL_URI, LIB_TABLE_GRID::ContainsNickname(), cur_model(), LIB_ID::FixIllegalChars(), Format(), SCH_IO_MGR::GetLibraryFileExtension(), LIB_ID::ID_SCH, KiCadSymbolLibFileWildcard(), m_cur_grid, m_lastBrowseDir, m_pageNdx, m_projectBasePath, NormalizePath(), OKOrCancelDialog(), Pgm(), SchematicLibraryFileWildcard(), and SCH_IO_MGR::ShowType().

◆ cur_model()

SYMBOL_LIB_TABLE_GRID * PANEL_SYM_LIB_TABLE::cur_model ( ) const
private

Definition at line 757 of file panel_sym_lib_table.cpp.

758 {
759  return (SYMBOL_LIB_TABLE_GRID*) m_cur_grid->GetTable();
760 }
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 515 of file panel_sym_lib_table.cpp.

516 {
518  return;
519 
520  int curRow = m_cur_grid->GetGridCursorRow();
521  int curCol = m_cur_grid->GetGridCursorCol();
522 
523  // In a wxGrid, collect rows that have a selected cell, or are selected
524  // It is not so easy: it depends on the way the selection was made.
525  // Here, we collect rows selected by clicking on a row label, and rows that contain
526  // previously-selected cells.
527  // If no candidate, just delete the row with the grid cursor.
528  wxArrayInt selectedRows = m_cur_grid->GetSelectedRows();
529  wxGridCellCoordsArray cells = m_cur_grid->GetSelectedCells();
530  wxGridCellCoordsArray blockTopLeft = m_cur_grid->GetSelectionBlockTopLeft();
531  wxGridCellCoordsArray blockBotRight = m_cur_grid->GetSelectionBlockBottomRight();
532 
533  // Add all row having cell selected to list:
534  for( unsigned ii = 0; ii < cells.GetCount(); ii++ )
535  selectedRows.Add( cells[ii].GetRow() );
536 
537  // Handle block selection
538  if( !blockTopLeft.IsEmpty() && !blockBotRight.IsEmpty() )
539  {
540  for( int i = blockTopLeft[0].GetRow(); i <= blockBotRight[0].GetRow(); ++i )
541  selectedRows.Add( i );
542  }
543 
544  // Use the row having the grid cursor only if we have no candidate:
545  if( selectedRows.size() == 0 && m_cur_grid->GetGridCursorRow() >= 0 )
546  selectedRows.Add( m_cur_grid->GetGridCursorRow() );
547 
548  if( selectedRows.size() == 0 )
549  {
550  wxBell();
551  return;
552  }
553 
554  std::sort( selectedRows.begin(), selectedRows.end() );
555 
556  // Remove selected rows (note: a row can be stored more than once in list)
557  int last_row = -1;
558 
559  for( int ii = selectedRows.GetCount()-1; ii >= 0; ii-- )
560  {
561  int row = selectedRows[ii];
562 
563  if( row != last_row )
564  {
565  last_row = row;
566  m_cur_grid->DeleteRows( row, 1 );
567  }
568  }
569 
570  m_cur_grid->SetGridCursor( std::min( curRow, m_cur_grid->GetNumberRows() - 1 ), curCol );
571 }
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:172

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

746 {
747  return (SYMBOL_LIB_TABLE_GRID*) m_global_grid->GetTable();
748 }
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 604 of file panel_sym_lib_table.cpp.

605 {
607  return;
608 
610  int curRow = m_cur_grid->GetGridCursorRow();
611 
612  // @todo: add multiple selection moves.
613  if( unsigned( curRow + 1 ) < tbl->rows.size() )
614  {
615  boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
616  tbl->rows.release( tbl->rows.begin() + curRow );
617 
618  ++curRow;
619  tbl->rows.insert( tbl->rows.begin() + curRow, move_me.release() );
620 
621  if( tbl->GetView() )
622  {
623  // Update the wxGrid
624  wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow - 1, 0 );
625  tbl->GetView()->ProcessTableMessage( msg );
626  }
627 
628  m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
629  m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
630  }
631 }
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:172

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

575 {
577  return;
578 
580  int curRow = m_cur_grid->GetGridCursorRow();
581 
582  // @todo: add multiple selection moves.
583  if( curRow >= 1 )
584  {
585  boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
586  tbl->rows.release( tbl->rows.begin() + curRow );
587 
588  --curRow;
589  tbl->rows.insert( tbl->rows.begin() + curRow, move_me.release() );
590 
591  if( tbl->GetView() )
592  {
593  // Update the wxGrid
594  wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow, 0 );
595  tbl->GetView()->ProcessTableMessage( msg );
596  }
597 
598  m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
599  m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
600  }
601 }
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:172

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

738 {
739  adjustPathSubsGridColumns( event.GetSize().GetX() );
740 
741  event.Skip();
742 }
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 404 of file panel_sym_lib_table.cpp.

405 {
406  m_pageNdx = (unsigned) std::max( 0, m_auinotebook->GetSelection() );
408 }
WX_GRID * m_cur_grid
changed based on tab choice
static size_t m_pageNdx
Remember the last notebook page selected during a session.

References PANEL_SYM_LIB_TABLE_BASE::m_auinotebook, m_cur_grid, PANEL_SYM_LIB_TABLE_BASE::m_global_grid, 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 666 of file panel_sym_lib_table.cpp.

667 {
668  wxRegEx re( ".*?(\\$\\{(.+?)\\})|(\\$\\((.+?)\\)).*?", wxRE_ADVANCED );
669  wxASSERT( re.IsValid() ); // wxRE_ADVANCED is required.
670 
671  std::set< wxString > unique;
672 
673  // clear the table
674  m_path_subs_grid->DeleteRows( 0, m_path_subs_grid->GetNumberRows() );
675 
676  for( SYMBOL_LIB_TABLE_GRID* tbl : { global_model(), project_model() } )
677  {
678  for( int row = 0; row < tbl->GetNumberRows(); ++row )
679  {
680  wxString uri = tbl->GetValue( row, COL_URI );
681 
682  while( re.Matches( uri ) )
683  {
684  wxString envvar = re.GetMatch( uri, 2 );
685 
686  // if not ${...} form then must be $(...)
687  if( envvar.IsEmpty() )
688  envvar = re.GetMatch( uri, 4 );
689 
690  // ignore duplicates
691  unique.insert( envvar );
692 
693  // delete the last match and search again
694  uri.Replace( re.GetMatch( uri, 0 ), wxEmptyString );
695  }
696  }
697  }
698 
699  // Make sure this special environment variable shows up even if it was
700  // not used yet. It is automatically set by KiCad to the directory holding
701  // the current project.
702  unique.insert( PROJECT_VAR_NAME );
704 
705  for( const wxString& evName : unique )
706  {
707  int row = m_path_subs_grid->GetNumberRows();
708  m_path_subs_grid->AppendRows( 1 );
709 
710  m_path_subs_grid->SetCellValue( row, 0, wxT( "${" ) + evName + wxT( "}" ) );
711  m_path_subs_grid->SetCellEditor( row, 0, new GRID_CELL_READONLY_TEXT_EDITOR() );
712 
713  wxString evValue;
714  wxGetEnv( evName, &evValue );
715  m_path_subs_grid->SetCellValue( row, 1, evValue );
716  m_path_subs_grid->SetCellEditor( row, 1, new GRID_CELL_READONLY_TEXT_EDITOR() );
717  }
718 
719  // No combobox editors here, but it looks better if its consistent with the other
720  // grids in the dialog.
721  m_path_subs_grid->SetDefaultRowSize( m_path_subs_grid->GetDefaultRowSize() + 2 );
722 
723  adjustPathSubsGridColumns( m_path_subs_grid->GetRect().GetWidth() );
724 }
#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

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

752 {
753  return (SYMBOL_LIB_TABLE_GRID*) m_project_grid->GetTable();
754 }
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 634 of file panel_sym_lib_table.cpp.

635 {
637  return false;
638 
639  if( !verifyTables() )
640  return false;
641 
642  if( *global_model() != *m_globalTable )
643  {
645 
646  m_globalTable->Clear();
647  m_globalTable->rows.transfer( m_globalTable->rows.end(), global_model()->rows.begin(),
648  global_model()->rows.end(), global_model()->rows );
650  }
651 
652  if( *project_model() != *m_projectTable )
653  {
655 
657  m_projectTable->rows.transfer( m_projectTable->rows.end(), project_model()->rows.begin(),
658  project_model()->rows.end(), project_model()->rows );
660  }
661 
662  return true;
663 }
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:172
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 323 of file panel_sym_lib_table.cpp.

324 {
325  for( SYMBOL_LIB_TABLE_GRID* model : { global_model(), project_model() } )
326  {
327  for( int r = 0; r < model->GetNumberRows(); )
328  {
329  wxString nick = model->GetValue( r, COL_NICKNAME ).Trim( false ).Trim();
330  wxString uri = model->GetValue( r, COL_URI ).Trim( false ).Trim();
331  unsigned illegalCh = 0;
332 
333  if( !nick || !uri )
334  {
335  // Delete the "empty" row, where empty means missing nick or uri.
336  // This also updates the UI which could be slow, but there should only be a few
337  // rows to delete, unless the user fell asleep on the Add Row
338  // button.
339  model->DeleteRows( r, 1 );
340  }
341  else if( ( illegalCh = LIB_ID::FindIllegalLibNicknameChar( nick, LIB_ID::ID_SCH ) ) )
342  {
343  wxString msg = wxString::Format( _( "Illegal character '%c' in Nickname: \"%s\"" ),
344  illegalCh,
345  nick );
346 
347  // show the tabbed panel holding the grid we have flunked:
348  if( model != cur_model() )
349  m_auinotebook->SetSelection( model == global_model() ? 0 : 1 );
350 
351  m_cur_grid->MakeCellVisible( r, 0 );
352  m_cur_grid->SetGridCursor( r, 1 );
353 
354  wxMessageDialog errdlg( this, msg, _( "No Colon in Nicknames" ) );
355  errdlg.ShowModal();
356  return false;
357  }
358  else
359  {
360  // set the trimmed values back into the table so they get saved to disk.
361  model->SetValue( r, COL_NICKNAME, nick );
362  model->SetValue( r, COL_URI, uri );
363  ++r; // this row was OK.
364  }
365  }
366  }
367 
368  // check for duplicate nickNames, separately in each table.
369  for( SYMBOL_LIB_TABLE_GRID* model : { global_model(), project_model() } )
370  {
371  for( int r1 = 0; r1 < model->GetNumberRows() - 1; ++r1 )
372  {
373  wxString nick1 = model->GetValue( r1, COL_NICKNAME );
374 
375  for( int r2=r1+1; r2 < model->GetNumberRows(); ++r2 )
376  {
377  wxString nick2 = model->GetValue( r2, COL_NICKNAME );
378 
379  if( nick1 == nick2 )
380  {
381  wxString msg = wxString::Format( _( "Duplicate Nickname: \"%s\"." ), nick1 );
382 
383  // show the tabbed panel holding the grid we have flunked:
384  if( model != cur_model() )
385  m_auinotebook->SetSelection( model == global_model() ? 0 : 1 );
386 
387  // go to the lower of the two rows, it is technically the duplicate:
388  m_cur_grid->MakeCellVisible( r2, 0 );
389  m_cur_grid->SetGridCursor( r2, 1 );
390 
391  wxMessageDialog errdlg( this, msg, _( "Please Delete or Modify One" ) );
392  errdlg.ShowModal();
393 
394  return false;
395  }
396  }
397  }
398  }
399 
400  return true;
401 }
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:404
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
#define _(s)
Definition: 3d_actions.cpp:33

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 browseLibrariesHandler(), 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: