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 ( 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.

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(), DIALOG_SHIM::SetInitialFocus(), WX_GRID::SetTable(), and SCH_IO_MGR::ShowType().

Referenced by InvokeSchEditSymbolLibTable().

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_PATH_EDITOR( m_parent, &m_lastBrowseDir ) );
196  g->SetColAttr( COL_URI, attr );
197 
198  attr = new wxGridCellAttr;
199  attr->SetEditor( new wxGridCellChoiceEditor( pluginChoices ) );
200  g->SetColAttr( COL_TYPE, attr );
201 
202  attr = new wxGridCellAttr;
203  attr->SetRenderer( new wxGridCellBoolRenderer() );
204  attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
205  g->SetColAttr( COL_ENABLED, attr );
206 
207  // all but COL_OPTIONS, which is edited with Option Editor anyways.
208  g->AutoSizeColumn( COL_NICKNAME, false );
209  g->AutoSizeColumn( COL_TYPE, false );
210  g->AutoSizeColumn( COL_URI, false );
211  g->AutoSizeColumn( COL_DESCR, false );
212  g->AutoSizeColumn( COL_ENABLED, false );
213 
214  // would set this to width of title, if it was easily known.
215  g->SetColSize( COL_OPTIONS, 80 );
216  }
217 
218  // select the last selected page
219  m_auinotebook->SetSelection( m_pageNdx );
221 
222  // for ALT+A handling, we want the initial focus to be on the first selected grid.
224 
225  // Configure button logos
226  m_append_button->SetBitmap( KiBitmap( small_plus_xpm ) );
227  m_delete_button->SetBitmap( KiBitmap( trash_xpm ) );
228  m_move_up_button->SetBitmap( KiBitmap( small_up_xpm ) );
229  m_move_down_button->SetBitmap( KiBitmap( small_down_xpm ) );
230  m_browse_button->SetBitmap( KiBitmap( folder_xpm ) );
231 
232  // Gives a selection to each grid, mainly for delete button. wxGrid's wake up with
233  // a currentCell which is sometimes not highlighted.
234  if( m_global_grid->GetNumberRows() > 0 )
235  m_global_grid->SelectRow( 0 );
236 
237  if( m_project_grid->GetNumberRows() > 0 )
238  m_project_grid->SelectRow( 0 );
239 }
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 cut, copy, and paste to an otherwise unmodied wxGrid instance...
Definition: grid_tricks.h:51
static size_t m_pageNdx
Remember the last notebook page selected during a session.
void SetTable(wxGridTableBase *table, bool aTakeOwnership=false)
Hide wxGrid&#39;s SetTable() method with one which doesn&#39;t mess up the grid column widths when setting th...
Definition: wx_grid.cpp:46
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: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
PANEL_SYM_LIB_TABLE::~PANEL_SYM_LIB_TABLE ( )
virtual

Definition at line 242 of file panel_sym_lib_table.cpp.

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.

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

Member Function Documentation

void PANEL_SYM_LIB_TABLE::adjustPathSubsGridColumns ( int  aWidth)
private

Definition at line 658 of file panel_sym_lib_table.cpp.

References PANEL_SYM_LIB_TABLE_BASE::m_path_subs_grid.

Referenced by onSizeGrid(), and populateEnvironReadOnlyTable().

659 {
660  // Account for scroll bars
661  aWidth -= ( m_path_subs_grid->GetSize().x - m_path_subs_grid->GetClientSize().x );
662 
663  m_path_subs_grid->AutoSizeColumn( 0 );
664  m_path_subs_grid->SetColSize( 1, aWidth - m_path_subs_grid->GetColSize( 0 ) );
665 }
void PANEL_SYM_LIB_TABLE::appendRowHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 425 of file panel_sym_lib_table.cpp.

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

426 {
428  return;
429 
430  if( m_cur_grid->AppendRows( 1 ) )
431  {
432  int row = m_cur_grid->GetNumberRows() - 1;
433  // Gives a default type (currently, only one type exists):
434  m_cur_grid->SetCellValue( row, COL_TYPE, SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY ) );
435 
436  // wx documentation is wrong, SetGridCursor does not make visible.
437  m_cur_grid->MakeCellVisible( row, 0 );
438  m_cur_grid->SetGridCursor( row, 1 );
439 
440  m_cur_grid->EnableCellEditControl( true );
441  m_cur_grid->ShowCellEditControl();
442  }
443 }
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:156
void PANEL_SYM_LIB_TABLE::browseLibrariesHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 345 of file panel_sym_lib_table.cpp.

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().

346 {
347  wxFileDialog dlg( this, _( "Select Library" ), m_lastBrowseDir,
348  wxEmptyString, SchematicLibraryFileWildcard(),
349  wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE );
350 
351  auto result = dlg.ShowModal();
352 
353  if( result == wxID_CANCEL )
354  return;
355 
356  m_lastBrowseDir = dlg.GetDirectory();
357 
358  const ENV_VAR_MAP& envVars = Pgm().GetLocalEnvVariables();
359  bool addDuplicates = false;
360  bool applyToAll = false;
361  wxString warning = _( "Warning: Duplicate Nickname" );
362  wxString msg = _( "A library nicknamed \"%s\" already exists." );
363  wxArrayString files;
364  dlg.GetFilenames( files );
365 
366  for( const auto& file : files )
367  {
368  wxString filePath = dlg.GetDirectory() + wxFileName::GetPathSeparator() + file;
369  wxFileName fn( filePath );
370  wxString nickname = LIB_ID::FixIllegalChars( fn.GetName(), LIB_ID::ID_SCH );
371  bool doAdd = true;
372 
373  if( cur_model()->ContainsNickname( nickname ) )
374  {
375  if( !applyToAll )
376  {
377  int ret = YesOrCancelDialog( this, warning, wxString::Format( msg, nickname ),
378  _( "Skip" ), _( "Add Anyway" ), &applyToAll );
379  addDuplicates = (ret == wxID_CANCEL );
380  }
381 
382  doAdd = addDuplicates;
383  }
384 
385  if( doAdd && m_cur_grid->AppendRows( 1 ) )
386  {
387  int last_row = m_cur_grid->GetNumberRows() - 1;
388 
389  m_cur_grid->SetCellValue( last_row, COL_NICKNAME, nickname );
390 
391  // TODO the following code can detect only schematic types, not libs
392  // SCH_IO_MGR needs to provide file extension information for libraries too
393 
394  // auto detect the plugin type
395  /*for( auto pluginType : SCH_IO_MGR::SCH_FILE_T_vector )
396  {
397  if( SCH_IO_MGR::GetFileExtension( pluginType ).Lower() == fn.GetExt().Lower() )
398  {
399  m_cur_grid->SetCellValue( last_row, COL_TYPE,
400  SCH_IO_MGR::ShowType( pluginType ) );
401  break;
402  }
403  }*/
404  m_cur_grid->SetCellValue( last_row, COL_TYPE,
405  SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY ) );
406 
407  // try to use path normalized to an environmental variable or project path
408  wxString path = NormalizePath( filePath, &envVars, m_projectBasePath );
409 
410  if( path.IsEmpty() )
411  path = fn.GetFullPath();
412 
413  m_cur_grid->SetCellValue( last_row, COL_URI, path );
414  }
415  }
416 
417  if( !files.IsEmpty() )
418  {
419  m_cur_grid->MakeCellVisible( m_cur_grid->GetNumberRows() - 1, 0 );
420  m_cur_grid->SetGridCursor( m_cur_grid->GetNumberRows() - 1, 1 );
421  }
422 }
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
SYMBOL_LIB_TABLE_GRID * cur_model() const
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:226
VTBL_ENTRY const ENV_VAR_MAP & GetLocalEnvVariables() const
Definition: pgm_base.h:314
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
Definition: pgm_base.h:131
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 &#39;_&#39;.
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
SYMBOL_LIB_TABLE_GRID * PANEL_SYM_LIB_TABLE::cur_model ( ) const
private

Definition at line 688 of file panel_sym_lib_table.cpp.

References m_cur_grid, and m_pageNdx.

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

689 {
690  return (SYMBOL_LIB_TABLE_GRID*) m_cur_grid->GetTable();
691 }
WX_GRID * m_cur_grid
changed based on tab choice
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.
void PANEL_SYM_LIB_TABLE::deleteRowHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 446 of file panel_sym_lib_table.cpp.

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

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

Definition at line 676 of file panel_sym_lib_table.cpp.

References PANEL_SYM_LIB_TABLE_BASE::m_global_grid.

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

677 {
678  return (SYMBOL_LIB_TABLE_GRID*) m_global_grid->GetTable();
679 }
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.
void PANEL_SYM_LIB_TABLE::moveDownHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 535 of file panel_sym_lib_table.cpp.

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

536 {
538  return;
539 
541  int curRow = m_cur_grid->GetGridCursorRow();
542 
543  // @todo: add multiple selection moves.
544  if( unsigned( curRow + 1 ) < tbl->rows.size() )
545  {
546  boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
547  tbl->rows.release( tbl->rows.begin() + curRow );
548 
549  ++curRow;
550  tbl->rows.insert( tbl->rows.begin() + curRow, move_me.release() );
551 
552  if( tbl->GetView() )
553  {
554  // Update the wxGrid
555  wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow - 1, 0 );
556  tbl->GetView()->ProcessTableMessage( msg );
557  }
558 
559  m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
560  m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
561  }
562 }
WX_GRID * m_cur_grid
changed based on tab choice
SYMBOL_LIB_TABLE_GRID * cur_model() const
LIB_TABLE_ROWS rows
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:156
void PANEL_SYM_LIB_TABLE::moveUpHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 505 of file panel_sym_lib_table.cpp.

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

506 {
508  return;
509 
511  int curRow = m_cur_grid->GetGridCursorRow();
512 
513  // @todo: add multiple selection moves.
514  if( curRow >= 1 )
515  {
516  boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
517  tbl->rows.release( tbl->rows.begin() + curRow );
518 
519  --curRow;
520  tbl->rows.insert( tbl->rows.begin() + curRow, move_me.release() );
521 
522  if( tbl->GetView() )
523  {
524  // Update the wxGrid
525  wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow, 0 );
526  tbl->GetView()->ProcessTableMessage( msg );
527  }
528 
529  m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
530  m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
531  }
532 }
WX_GRID * m_cur_grid
changed based on tab choice
SYMBOL_LIB_TABLE_GRID * cur_model() const
LIB_TABLE_ROWS rows
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:156
void PANEL_SYM_LIB_TABLE::onSizeGrid ( wxSizeEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 668 of file panel_sym_lib_table.cpp.

References adjustPathSubsGridColumns().

669 {
670  adjustPathSubsGridColumns( event.GetSize().GetX() );
671 
672  event.Skip();
673 }
void adjustPathSubsGridColumns(int aWidth)
void PANEL_SYM_LIB_TABLE::pageChangedHandler ( wxAuiNotebookEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 338 of file panel_sym_lib_table.cpp.

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.

339 {
340  m_pageNdx = (unsigned) std::max( 0, m_auinotebook->GetSelection() );
342 }
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
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 597 of file panel_sym_lib_table.cpp.

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().

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

Definition at line 682 of file panel_sym_lib_table.cpp.

References PANEL_SYM_LIB_TABLE_BASE::m_project_grid.

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

683 {
684  return (SYMBOL_LIB_TABLE_GRID*) m_project_grid->GetTable();
685 }
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.
bool PANEL_SYM_LIB_TABLE::TransferDataFromWindow ( )
overrideprivate

Definition at line 565 of file panel_sym_lib_table.cpp.

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().

566 {
568  return false;
569 
570  if( !verifyTables() )
571  return false;
572 
573  if( *global_model() != *m_globalTable )
574  {
576 
577  m_globalTable->Clear();
578  m_globalTable->rows.transfer( m_globalTable->rows.end(), global_model()->rows.begin(),
579  global_model()->rows.end(), global_model()->rows );
581  }
582 
583  if( *project_model() != *m_projectTable )
584  {
586 
588  m_projectTable->rows.transfer( m_projectTable->rows.end(), project_model()->rows.begin(),
589  project_model()->rows.end(), project_model()->rows );
591  }
592 
593  return true;
594 }
void Clear()
Delete all rows.
void reindex()
WX_GRID * m_cur_grid
changed based on tab choice
LIB_TABLE_ROWS rows
SYMBOL_LIB_TABLE_GRID * global_model() const
SYMBOL_LIB_TABLE * m_projectTable
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:156
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
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 257 of file panel_sym_lib_table.cpp.

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().

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

Member Data Documentation

wxBitmapButton* PANEL_SYM_LIB_TABLE_BASE::m_append_button
protectedinherited
wxAuiNotebook* PANEL_SYM_LIB_TABLE_BASE::m_auinotebook
protectedinherited
wxBitmapButton* PANEL_SYM_LIB_TABLE_BASE::m_browse_button
protectedinherited
wxBitmapButton* PANEL_SYM_LIB_TABLE_BASE::m_delete_button
protectedinherited
wxStaticText* PANEL_SYM_LIB_TABLE_BASE::m_GblTableFilename
protectedinherited
WX_GRID* PANEL_SYM_LIB_TABLE_BASE::m_global_grid
protectedinherited
wxPanel* PANEL_SYM_LIB_TABLE_BASE::m_global_panel
protectedinherited
SYMBOL_LIB_TABLE* PANEL_SYM_LIB_TABLE::m_globalTable
private

Definition at line 68 of file panel_sym_lib_table.h.

Referenced by TransferDataFromWindow().

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().

wxBitmapButton* PANEL_SYM_LIB_TABLE_BASE::m_move_down_button
protectedinherited
wxBitmapButton* PANEL_SYM_LIB_TABLE_BASE::m_move_up_button
protectedinherited
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 cur_model(), pageChangedHandler(), PANEL_SYM_LIB_TABLE(), and ~PANEL_SYM_LIB_TABLE().

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().

wxStaticText* PANEL_SYM_LIB_TABLE_BASE::m_PrjTableFilename
protectedinherited
WX_GRID* PANEL_SYM_LIB_TABLE_BASE::m_project_grid
protectedinherited
wxPanel* PANEL_SYM_LIB_TABLE_BASE::m_project_panel
protectedinherited
wxString PANEL_SYM_LIB_TABLE::m_projectBasePath
private

Definition at line 70 of file panel_sym_lib_table.h.

Referenced by browseLibrariesHandler().

SYMBOL_LIB_TABLE* PANEL_SYM_LIB_TABLE::m_projectTable
private

Definition at line 69 of file panel_sym_lib_table.h.

Referenced by TransferDataFromWindow().

wxStaticText* PANEL_SYM_LIB_TABLE_BASE::m_staticText3
protectedinherited
wxStaticText* PANEL_SYM_LIB_TABLE_BASE::m_staticText4
protectedinherited

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