KiCad PCB EDA Suite
FP_GRID_TRICKS Class Reference
Inheritance diagram for FP_GRID_TRICKS:
GRID_TRICKS

Public Member Functions

 FP_GRID_TRICKS (DIALOG_EDIT_LIBRARY_TABLES *aParent, WX_GRID *aGrid)
 

Protected Member Functions

void optionsEditor (int aRow)
 
bool handleDoubleClick (wxGridEvent &aEvent) override
 
void showPopupMenu (wxMenu &menu) override
 
void doPopupSelection (wxCommandEvent &event) override
 
void paste_text (const wxString &cb_text) override
 handle specialized clipboard text, with leading "(fp_lib_table", OR spreadsheet formatted text. More...
 
void getSelectedArea ()
 Puts the selected area into a sensible rectangle of m_sel_{row,col}_{start,count} above. More...
 
void onGridCellLeftClick (wxGridEvent &event)
 
void onGridCellLeftDClick (wxGridEvent &event)
 
void onGridCellRightClick (wxGridEvent &event)
 
void onGridLabelLeftClick (wxGridEvent &event)
 
void onGridLabelRightClick (wxGridEvent &event)
 
void onPopupSelection (wxCommandEvent &event)
 
void onKeyDown (wxKeyEvent &ev)
 
void onUpdateUI (wxUpdateUIEvent &event)
 
bool toggleCell (int aRow, int aCol, bool aPreserveSelection=false)
 
bool showEditor (int aRow, int aCol)
 
virtual void paste_clipboard ()
 
virtual void cutcopy (bool doCut)
 

Protected Attributes

DIALOG_EDIT_LIBRARY_TABLESm_dialog
 
WX_GRIDm_grid
 I don't own the grid, but he owns me. More...
 
int m_sel_row_start
 
int m_sel_col_start
 
int m_sel_row_count
 
int m_sel_col_count
 

Detailed Description

Definition at line 247 of file panel_fp_lib_table.cpp.

Constructor & Destructor Documentation

◆ FP_GRID_TRICKS()

FP_GRID_TRICKS::FP_GRID_TRICKS ( DIALOG_EDIT_LIBRARY_TABLES aParent,
WX_GRID aGrid 
)
inline

Definition at line 250 of file panel_fp_lib_table.cpp.

250  :
251  GRID_TRICKS( aGrid ),
252  m_dialog( aParent )
253  { }
GRID_TRICKS(WX_GRID *aGrid)
Definition: grid_tricks.cpp:37
DIALOG_EDIT_LIBRARY_TABLES * m_dialog

Member Function Documentation

◆ cutcopy()

void GRID_TRICKS::cutcopy ( bool  doCut)
protectedvirtualinherited

Definition at line 586 of file grid_tricks.cpp.

587 {
588  if( wxTheClipboard->Open() )
589  {
590  wxGridTableBase* tbl = m_grid->GetTable();
591  wxString txt;
592 
593  // fill txt with a format that is compatible with most spreadsheets
594  for( int row = m_sel_row_start; row < m_sel_row_start + m_sel_row_count; ++row )
595  {
596  for( int col = m_sel_col_start; col < m_sel_col_start + m_sel_col_count; ++col )
597  {
598  txt += tbl->GetValue( row, col );
599 
600  if( col < m_sel_col_start + m_sel_col_count - 1 ) // that was not last column
601  txt += COL_SEP;
602 
603  if( doCut )
604  {
605  if( tbl->CanSetValueAs( row, col, wxGRID_VALUE_STRING ) )
606  tbl->SetValue( row, col, wxEmptyString );
607  }
608  }
609  txt += ROW_SEP;
610  }
611 
612  wxTheClipboard->SetData( new wxTextDataObject( txt ) );
613  wxTheClipboard->Close();
614 
615  if( doCut )
616  m_grid->ForceRefresh();
617  }
618 }
int m_sel_row_count
Definition: grid_tricks.h:65
int m_sel_col_start
Definition: grid_tricks.h:64
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:59
int m_sel_col_count
Definition: grid_tricks.h:66
int m_sel_row_start
Definition: grid_tricks.h:63
#define ROW_SEP
Definition: grid_tricks.cpp:34
#define COL_SEP
Definition: grid_tricks.cpp:33

References COL_SEP, GRID_TRICKS::m_grid, GRID_TRICKS::m_sel_col_count, GRID_TRICKS::m_sel_col_start, GRID_TRICKS::m_sel_row_count, GRID_TRICKS::m_sel_row_start, and ROW_SEP.

Referenced by GRID_TRICKS::doPopupSelection(), and GRID_TRICKS::onKeyDown().

◆ doPopupSelection()

void FP_GRID_TRICKS::doPopupSelection ( wxCommandEvent &  event)
inlineoverrideprotectedvirtual

Reimplemented from GRID_TRICKS.

Definition at line 301 of file panel_fp_lib_table.cpp.

302  {
303  if( event.GetId() == MYID_OPTIONS_EDITOR )
304  optionsEditor( m_grid->GetGridCursorRow() );
305  else
307  }
#define MYID_OPTIONS_EDITOR
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:59
void optionsEditor(int aRow)
virtual void doPopupSelection(wxCommandEvent &event)

References GRID_TRICKS::doPopupSelection(), GRID_TRICKS::m_grid, MYID_OPTIONS_EDITOR, and optionsEditor().

◆ getSelectedArea()

void GRID_TRICKS::getSelectedArea ( )
protectedinherited

Puts the selected area into a sensible rectangle of m_sel_{row,col}_{start,count} above.

Definition at line 167 of file grid_tricks.cpp.

168 {
169  wxGridCellCoordsArray topLeft = m_grid->GetSelectionBlockTopLeft();
170  wxGridCellCoordsArray botRight = m_grid->GetSelectionBlockBottomRight();
171 
172  wxArrayInt cols = m_grid->GetSelectedCols();
173  wxArrayInt rows = m_grid->GetSelectedRows();
174 
175  if( topLeft.Count() && botRight.Count() )
176  {
177  m_sel_row_start = topLeft[0].GetRow();
178  m_sel_col_start = topLeft[0].GetCol();
179 
180  m_sel_row_count = botRight[0].GetRow() - m_sel_row_start + 1;
181  m_sel_col_count = botRight[0].GetCol() - m_sel_col_start + 1;
182  }
183  else if( cols.Count() )
184  {
185  m_sel_col_start = cols[0];
186  m_sel_col_count = cols.Count();
187  m_sel_row_start = 0;
188  m_sel_row_count = m_grid->GetNumberRows();
189  }
190  else if( rows.Count() )
191  {
192  m_sel_col_start = 0;
193  m_sel_col_count = m_grid->GetNumberCols();
194  m_sel_row_start = rows[0];
195  m_sel_row_count = rows.Count();
196  }
197  else
198  {
199  m_sel_row_start = m_grid->GetGridCursorRow();
200  m_sel_col_start = m_grid->GetGridCursorCol();
201  m_sel_row_count = m_sel_row_start >= 0 ? 1 : 0;
202  m_sel_col_count = m_sel_col_start >= 0 ? 1 : 0;
203  }
204 }
int m_sel_row_count
Definition: grid_tricks.h:65
int m_sel_col_start
Definition: grid_tricks.h:64
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:59
int m_sel_col_count
Definition: grid_tricks.h:66
int m_sel_row_start
Definition: grid_tricks.h:63

References GRID_TRICKS::m_grid, GRID_TRICKS::m_sel_col_count, GRID_TRICKS::m_sel_col_start, GRID_TRICKS::m_sel_row_count, and GRID_TRICKS::m_sel_row_start.

Referenced by GRID_TRICKS::onKeyDown(), and GRID_TRICKS::showPopupMenu().

◆ handleDoubleClick()

bool FP_GRID_TRICKS::handleDoubleClick ( wxGridEvent &  aEvent)
inlineoverrideprotectedvirtual

Reimplemented from GRID_TRICKS.

Definition at line 279 of file panel_fp_lib_table.cpp.

280  {
281  if( aEvent.GetCol() == COL_OPTIONS )
282  {
283  optionsEditor( aEvent.GetRow() );
284  return true;
285  }
286 
287  return false;
288  }
void optionsEditor(int aRow)

References COL_OPTIONS, and optionsEditor().

◆ onGridCellLeftClick()

void GRID_TRICKS::onGridCellLeftClick ( wxGridEvent &  event)
protectedinherited

Definition at line 134 of file grid_tricks.cpp.

135 {
136  int row = aEvent.GetRow();
137  int col = aEvent.GetCol();
138 
139  // Don't make users click twice to toggle a checkbox or edit a text cell
140  if( !aEvent.GetModifiers() )
141  {
142  if( toggleCell( row, col ) )
143  return;
144 
145  if( showEditor( row, col ) )
146  return;
147  }
148 
149  aEvent.Skip();
150 }
bool toggleCell(int aRow, int aCol, bool aPreserveSelection=false)
Definition: grid_tricks.cpp:56
bool showEditor(int aRow, int aCol)
Definition: grid_tricks.cpp:99

References GRID_TRICKS::showEditor(), and GRID_TRICKS::toggleCell().

Referenced by GRID_TRICKS::GRID_TRICKS(), and GRID_TRICKS::onGridCellLeftDClick().

◆ onGridCellLeftDClick()

void GRID_TRICKS::onGridCellLeftDClick ( wxGridEvent &  event)
protectedinherited

Definition at line 153 of file grid_tricks.cpp.

154 {
155  if( !handleDoubleClick( aEvent ) )
156  onGridCellLeftClick( aEvent );
157 }
void onGridCellLeftClick(wxGridEvent &event)
virtual bool handleDoubleClick(wxGridEvent &aEvent)

References GRID_TRICKS::handleDoubleClick(), and GRID_TRICKS::onGridCellLeftClick().

Referenced by GRID_TRICKS::GRID_TRICKS().

◆ onGridCellRightClick()

void GRID_TRICKS::onGridCellRightClick ( wxGridEvent &  event)
protectedinherited

Definition at line 207 of file grid_tricks.cpp.

208 {
209  wxMenu menu;
210 
211  showPopupMenu( menu );
212 }
virtual void showPopupMenu(wxMenu &menu)

References GRID_TRICKS::showPopupMenu().

Referenced by GRID_TRICKS::GRID_TRICKS().

◆ onGridLabelLeftClick()

void GRID_TRICKS::onGridLabelLeftClick ( wxGridEvent &  event)
protectedinherited

Definition at line 215 of file grid_tricks.cpp.

216 {
218 
219  aEvent.Skip();
220 }
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:59
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:180

References WX_GRID::CommitPendingChanges(), and GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::GRID_TRICKS().

◆ onGridLabelRightClick()

void GRID_TRICKS::onGridLabelRightClick ( wxGridEvent &  event)
protectedinherited

Definition at line 223 of file grid_tricks.cpp.

224 {
225  wxMenu menu;
226 
227  for( int i = 0; i < m_grid->GetNumberCols(); ++i )
228  {
229  int id = GRIDTRICKS_FIRST_SHOWHIDE + i;
230  menu.AppendCheckItem( id, m_grid->GetColLabelValue( i ) );
231  menu.Check( id, m_grid->IsColShown( i ) );
232  }
233 
234  m_grid->PopupMenu( &menu );
235 }
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:59

References GRIDTRICKS_FIRST_SHOWHIDE, and GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::GRID_TRICKS().

◆ onKeyDown()

void GRID_TRICKS::onKeyDown ( wxKeyEvent &  ev)
protectedinherited

Definition at line 310 of file grid_tricks.cpp.

311 {
312  if( ev.GetModifiers() == wxMOD_CONTROL && ev.GetKeyCode() == 'A' )
313  {
314  m_grid->SelectAll();
315  return;
316  }
317  else if( ev.GetModifiers() == wxMOD_CONTROL && ev.GetKeyCode() == 'C' )
318  {
319  getSelectedArea();
320  cutcopy( false );
321  return;
322  }
323  else if( ev.GetModifiers() == wxMOD_CONTROL && ev.GetKeyCode() == 'V' )
324  {
325  getSelectedArea();
326  paste_clipboard();
327  return;
328  }
329  else if( ev.GetModifiers() == wxMOD_CONTROL && ev.GetKeyCode() == 'X' )
330  {
331  getSelectedArea();
332  cutcopy( true );
333  return;
334  }
335 
336  // space-bar toggling of checkboxes
337  if( ev.GetKeyCode() == ' ' )
338  {
339  bool retVal = false;
340 
341  // If only rows can be selected, only toggle the first cell in a row
342  if( m_grid->GetSelectionMode() == wxGrid::wxGridSelectRows )
343  {
344  wxArrayInt rowSel = m_grid->GetSelectedRows();
345 
346  for( unsigned int rowInd = 0; rowInd < rowSel.GetCount(); rowInd++ )
347  {
348  retVal |= toggleCell( rowSel[rowInd], 0, true );
349  }
350  }
351 
352  // If only columns can be selected, only toggle the first cell in a column
353  else if( m_grid->GetSelectionMode() == wxGrid::wxGridSelectColumns )
354  {
355  wxArrayInt colSel = m_grid->GetSelectedCols();
356 
357  for( unsigned int colInd = 0; colInd < colSel.GetCount(); colInd++ )
358  {
359  retVal |= toggleCell( 0, colSel[colInd], true );
360  }
361  }
362 
363  // If the user can select the individual cells, toggle each cell selected
364  else if( m_grid->GetSelectionMode() == wxGrid::wxGridSelectCells )
365  {
366  wxArrayInt rowSel = m_grid->GetSelectedRows();
367  wxArrayInt colSel = m_grid->GetSelectedCols();
368  wxGridCellCoordsArray cellSel = m_grid->GetSelectedCells();
369  wxGridCellCoordsArray topLeft = m_grid->GetSelectionBlockTopLeft();
370  wxGridCellCoordsArray botRight = m_grid->GetSelectionBlockBottomRight();
371 
372  // Iterate over every individually selected cell and try to toggle it
373  for( unsigned int cellInd = 0; cellInd < cellSel.GetCount(); cellInd++ )
374  {
375  retVal |= toggleCell( cellSel[cellInd].GetRow(), cellSel[cellInd].GetCol(), true );
376  }
377 
378  // Iterate over every column and try to toggle each cell in it
379  for( unsigned int colInd = 0; colInd < colSel.GetCount(); colInd++ )
380  {
381  for( int row = 0; row < m_grid->GetNumberRows(); row++ )
382  {
383  retVal |= toggleCell( row, colSel[colInd], true );
384  }
385  }
386 
387  // Iterate over every row and try to toggle each cell in it
388  for( unsigned int rowInd = 0; rowInd < rowSel.GetCount(); rowInd++ )
389  {
390  for( int col = 0; col < m_grid->GetNumberCols(); col++ )
391  {
392  retVal |= toggleCell( rowSel[rowInd], col, true );
393  }
394  }
395 
396  // Iterate over the selection blocks
397  for( unsigned int blockInd = 0; blockInd < topLeft.GetCount(); blockInd++ )
398  {
399  wxGridCellCoords start = topLeft[blockInd];
400  wxGridCellCoords end = botRight[blockInd];
401 
402  for( int row = start.GetRow(); row <= end.GetRow(); row++ )
403  {
404  for( int col = start.GetCol(); col <= end.GetCol(); col++ )
405  {
406  retVal |= toggleCell( row, col, true );
407  }
408  }
409  }
410  }
411  else
412  {
413  }
414 
415  // Return if there were any cells toggled
416  if( retVal )
417  return;
418  }
419 
420  // ctrl-tab for exit grid
421 #ifdef __APPLE__
422  bool ctrl = ev.RawControlDown();
423 #else
424  bool ctrl = ev.ControlDown();
425 #endif
426 
427  if( ctrl && ev.GetKeyCode() == WXK_TAB )
428  {
429  wxWindow* test = m_grid->GetNextSibling();
430 
431  if( !test )
432  test = m_grid->GetParent()->GetNextSibling();
433 
434  while( test && !test->IsTopLevel() )
435  {
436  test->SetFocus();
437 
438  if( test->HasFocus() )
439  break;
440 
441  if( !test->GetChildren().empty() )
442  test = test->GetChildren().front();
443  else if( test->GetNextSibling() )
444  test = test->GetNextSibling();
445  else
446  {
447  while( test )
448  {
449  test = test->GetParent();
450 
451  if( test && test->IsTopLevel() )
452  {
453  break;
454  }
455  else if( test && test->GetNextSibling() )
456  {
457  test = test->GetNextSibling();
458  break;
459  }
460  }
461  }
462  }
463 
464  return;
465  }
466 
467  ev.Skip( true );
468 }
void getSelectedArea()
Puts the selected area into a sensible rectangle of m_sel_{row,col}_{start,count} above.
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:59
bool toggleCell(int aRow, int aCol, bool aPreserveSelection=false)
Definition: grid_tricks.cpp:56
virtual void paste_clipboard()
virtual void cutcopy(bool doCut)

References GRID_TRICKS::cutcopy(), GRID_TRICKS::getSelectedArea(), GRID_TRICKS::m_grid, GRID_TRICKS::paste_clipboard(), and GRID_TRICKS::toggleCell().

Referenced by GRID_TRICKS::GRID_TRICKS().

◆ onPopupSelection()

void GRID_TRICKS::onPopupSelection ( wxCommandEvent &  event)
protectedinherited

Definition at line 268 of file grid_tricks.cpp.

269 {
270  doPopupSelection( event );
271 }
virtual void doPopupSelection(wxCommandEvent &event)

References GRID_TRICKS::doPopupSelection().

Referenced by GRID_TRICKS::GRID_TRICKS().

◆ onUpdateUI()

void GRID_TRICKS::onUpdateUI ( wxUpdateUIEvent &  event)
protectedinherited

Definition at line 621 of file grid_tricks.cpp.

622 {
623  // Respect ROW selectionMode when moving cursor
624 
625  if( m_grid->GetSelectionMode() == wxGrid::wxGridSelectRows )
626  {
627  int cursorRow = m_grid->GetGridCursorRow();
628  bool cursorInSelectedRow = false;
629 
630  for( int row : m_grid->GetSelectedRows() )
631  {
632  if( row == cursorRow )
633  {
634  cursorInSelectedRow = true;
635  break;
636  }
637  }
638 
639  if( !cursorInSelectedRow && cursorRow >= 0 )
640  m_grid->SelectRow( cursorRow );
641  }
642 }
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:59

References GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::GRID_TRICKS().

◆ optionsEditor()

void FP_GRID_TRICKS::optionsEditor ( int  aRow)
inlineprotected

Definition at line 258 of file panel_fp_lib_table.cpp.

259  {
260  FP_LIB_TABLE_GRID* tbl = (FP_LIB_TABLE_GRID*) m_grid->GetTable();
261 
262  if( tbl->GetNumberRows() > aRow )
263  {
264  LIB_TABLE_ROW* row = tbl->at( (size_t) aRow );
265  const wxString& options = row->GetOptions();
266  wxString result = options;
267 
268  InvokePluginOptionsEditor( m_dialog, row->GetNickName(), row->GetType(), options,
269  &result );
270 
271  if( options != result )
272  {
273  row->SetOptions( result );
274  m_grid->Refresh();
275  }
276  }
277  }
const wxString & GetOptions() const
Return the options string, which may hold a password or anything else needed to instantiate the under...
void InvokePluginOptionsEditor(wxWindow *aCaller, const wxString &aNickname, const wxString &aPluginType, const wxString &aOptions, wxString *aResult)
Function InvokePluginOptionsEditor calls DIALOG_FP_PLUGIN_OPTIONS dialog so that plugin options set c...
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
virtual const wxString GetType() const =0
Return the type of library represented by this row.
int GetNumberRows() override
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:59
const wxString & GetNickName() const
DIALOG_EDIT_LIBRARY_TABLES * m_dialog
This class builds a wxGridTableBase by wrapping an FP_LIB_TABLE object.
void SetOptions(const wxString &aOptions)
Change the library options strings.
LIB_TABLE_ROW * at(size_t aIndex) override

References FP_LIB_TABLE_GRID::at(), LIB_TABLE_ROW::GetNickName(), LIB_TABLE_GRID::GetNumberRows(), LIB_TABLE_ROW::GetOptions(), LIB_TABLE_ROW::GetType(), InvokePluginOptionsEditor(), m_dialog, GRID_TRICKS::m_grid, and LIB_TABLE_ROW::SetOptions().

Referenced by doPopupSelection(), and handleDoubleClick().

◆ paste_clipboard()

void GRID_TRICKS::paste_clipboard ( )
protectedvirtualinherited

Definition at line 471 of file grid_tricks.cpp.

472 {
473  if( wxTheClipboard->Open() )
474  {
475  if( wxTheClipboard->IsSupported( wxDF_TEXT ) )
476  {
477  wxTextDataObject data;
478 
479  wxTheClipboard->GetData( data );
480 
481  paste_text( data.GetText() );
482  }
483 
484  wxTheClipboard->Close();
485  m_grid->ForceRefresh();
486  }
487 }
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:59
virtual void paste_text(const wxString &cb_text)

References GRID_TRICKS::m_grid, and GRID_TRICKS::paste_text().

Referenced by GRID_TRICKS::doPopupSelection(), and GRID_TRICKS::onKeyDown().

◆ paste_text()

void FP_GRID_TRICKS::paste_text ( const wxString &  cb_text)
inlineoverrideprotectedvirtual

handle specialized clipboard text, with leading "(fp_lib_table", OR spreadsheet formatted text.

Reimplemented from GRID_TRICKS.

Definition at line 311 of file panel_fp_lib_table.cpp.

312  {
313  FP_LIB_TABLE_GRID* tbl = (FP_LIB_TABLE_GRID*) m_grid->GetTable();
314  size_t ndx = cb_text.find( "(fp_lib_table" );
315 
316  if( ndx != std::string::npos )
317  {
318  // paste the FP_LIB_TABLE_ROWs of s-expression (fp_lib_table), starting
319  // at column 0 regardless of current cursor column.
320 
321  STRING_LINE_READER slr( TO_UTF8( cb_text ), "Clipboard" );
322  LIB_TABLE_LEXER lexer( &slr );
323  FP_LIB_TABLE tmp_tbl;
324  bool parsed = true;
325 
326  try
327  {
328  tmp_tbl.Parse( &lexer );
329  }
330  catch( PARSE_ERROR& pe )
331  {
332  DisplayError( m_dialog, pe.What() );
333  parsed = false;
334  }
335 
336  if( parsed )
337  {
338  // make sure the table is big enough...
339  if( tmp_tbl.GetCount() > (unsigned) tbl->GetNumberRows() )
340  tbl->AppendRows( tmp_tbl.GetCount() - tbl->GetNumberRows() );
341 
342  for( unsigned i = 0; i < tmp_tbl.GetCount(); ++i )
343  tbl->rows.replace( i, tmp_tbl.At( i ).clone() );
344  }
345 
346  m_grid->AutoSizeColumns( false );
347  }
348  else
349  {
350  // paste spreadsheet formatted text.
351  GRID_TRICKS::paste_text( cb_text );
352 
353  m_grid->AutoSizeColumns( false );
354  }
355  }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:240
unsigned GetCount() const
Get the number of rows contained in the table.
LIB_TABLE_ROWS rows
int GetNumberRows() override
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:59
virtual void paste_text(const wxString &cb_text)
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:95
LIB_TABLE_ROW * clone() const
virtual void Parse(LIB_TABLE_LEXER *aLexer) override
Parse the #LIB_TABLE_LEXER s-expression library table format into the appropriate LIB_TABLE_ROW objec...
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
DIALOG_EDIT_LIBRARY_TABLES * m_dialog
bool AppendRows(size_t aNumRows=1) override
Struct PARSE_ERROR contains a filename or source description, a problem input line,...
Definition: ki_exception.h:123
LIB_TABLE_ROW & At(unsigned aIndex)
Get the 'n'th LIB_TABLE_ROW object.
This class builds a wxGridTableBase by wrapping an FP_LIB_TABLE object.
STRING_LINE_READER is a LINE_READER that reads from a multiline 8 bit wide std::string.
Definition: richio.h:255

References LIB_TABLE_GRID::AppendRows(), LIB_TABLE::At(), LIB_TABLE_ROW::clone(), DisplayError(), LIB_TABLE::GetCount(), LIB_TABLE_GRID::GetNumberRows(), m_dialog, GRID_TRICKS::m_grid, FP_LIB_TABLE::Parse(), GRID_TRICKS::paste_text(), LIB_TABLE::rows, TO_UTF8, and IO_ERROR::What().

◆ showEditor()

bool GRID_TRICKS::showEditor ( int  aRow,
int  aCol 
)
protectedinherited

Definition at line 99 of file grid_tricks.cpp.

100 {
101  if( m_grid->GetGridCursorRow() != aRow || m_grid->GetGridCursorCol() != aCol )
102  m_grid->SetGridCursor( aRow, aCol );
103 
104  if( m_grid->IsEditable() && !m_grid->IsReadOnly( aRow, aCol ) )
105  {
106  m_grid->ClearSelection();
107 
108  if( m_grid->GetSelectionMode() == wxGrid::wxGridSelectRows )
109  {
110  wxArrayInt rows = m_grid->GetSelectedRows();
111 
112  if( rows.size() != 1 || rows.Item( 0 ) != aRow )
113  m_grid->SelectRow( aRow );
114  }
115 
116  // For several reasons we can't enable the control here. There's the whole
117  // SetInSetFocus() issue/hack in wxWidgets, and there's also wxGrid's MouseUp
118  // handler which doesn't notice it's processing a MouseUp until after it has
119  // disabled the editor yet again. So we re-use wxWidgets' slow-click hack,
120  // which is processed later in the MouseUp handler.
121  //
122  // It should be pointed out that the fact that it's wxWidgets' hack doesn't
123  // make it any less of a hack. Be extra careful with any modifications here.
124  // See, in particular, https://bugs.launchpad.net/kicad/+bug/1817965.
126 
127  return true;
128  }
129 
130  return false;
131 }
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:59
void ShowEditorOnMouseUp()
WxWidgets has a bunch of bugs in its handling of wxGrid mouse events which close cell editors right a...
Definition: wx_grid.h:99

References GRID_TRICKS::m_grid, and WX_GRID::ShowEditorOnMouseUp().

Referenced by GRID_TRICKS::onGridCellLeftClick().

◆ showPopupMenu()

void FP_GRID_TRICKS::showPopupMenu ( wxMenu &  menu)
inlineoverrideprotectedvirtual

Reimplemented from GRID_TRICKS.

Definition at line 290 of file panel_fp_lib_table.cpp.

291  {
292  if( m_grid->GetGridCursorCol() == COL_OPTIONS )
293  {
294  menu.Append( MYID_OPTIONS_EDITOR, _( "Options Editor..." ), _( "Edit options" ) );
295  menu.AppendSeparator();
296  }
297 
299  }
#define MYID_OPTIONS_EDITOR
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:59
virtual void showPopupMenu(wxMenu &menu)
#define _(s)
Definition: 3d_actions.cpp:33

References _, COL_OPTIONS, GRID_TRICKS::m_grid, MYID_OPTIONS_EDITOR, and GRID_TRICKS::showPopupMenu().

◆ toggleCell()

bool GRID_TRICKS::toggleCell ( int  aRow,
int  aCol,
bool  aPreserveSelection = false 
)
protectedinherited

Definition at line 56 of file grid_tricks.cpp.

57 {
58  auto renderer = m_grid->GetCellRenderer( aRow, aCol );
59  bool isCheckbox = ( dynamic_cast<wxGridCellBoolRenderer*>( renderer ) != nullptr );
60  renderer->DecRef();
61 
62  if( isCheckbox )
63  {
64  if( !aPreserveSelection )
65  m_grid->ClearSelection();
66 
67  m_grid->SetGridCursor( aRow, aCol );
68 
69  wxGridTableBase* model = m_grid->GetTable();
70 
71  if( model->CanGetValueAs( aRow, aCol, wxGRID_VALUE_BOOL )
72  && model->CanSetValueAs( aRow, aCol, wxGRID_VALUE_BOOL ) )
73  {
74  model->SetValueAsBool( aRow, aCol, !model->GetValueAsBool( aRow, aCol ) );
75  }
76  else // fall back to string processing
77  {
78  if( model->GetValue( aRow, aCol ) == wxT( "1" ) )
79  model->SetValue( aRow, aCol, wxT( "0" ) );
80  else
81  model->SetValue( aRow, aCol, wxT( "1" ) );
82  }
83 
84  // Mac needs this for the keyboard events; Linux appears to always need it.
85  m_grid->ForceRefresh();
86 
87  // Let any clients know
88  wxGridEvent event( m_grid->GetId(), wxEVT_GRID_CELL_CHANGED, m_grid, aRow, aCol );
89  event.SetString( model->GetValue( aRow, aCol ) );
90  m_grid->GetEventHandler()->ProcessEvent( event );
91 
92  return true;
93  }
94 
95  return false;
96 }
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:59

References GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::onGridCellLeftClick(), and GRID_TRICKS::onKeyDown().

Member Data Documentation

◆ m_dialog

DIALOG_EDIT_LIBRARY_TABLES* FP_GRID_TRICKS::m_dialog
protected

Definition at line 256 of file panel_fp_lib_table.cpp.

Referenced by optionsEditor(), and paste_text().

◆ m_grid

◆ m_sel_col_count

int GRID_TRICKS::m_sel_col_count
protectedinherited

◆ m_sel_col_start

int GRID_TRICKS::m_sel_col_start
protectedinherited

◆ m_sel_row_count

int GRID_TRICKS::m_sel_row_count
protectedinherited

◆ m_sel_row_start

int GRID_TRICKS::m_sel_row_start
protectedinherited

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