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

Public Member Functions

 SYMBOL_GRID_TRICKS (DIALOG_EDIT_LIBRARY_TABLES *aParent, WX_GRID *aGrid)
 

Protected Member Functions

virtual void paste_text (const wxString &cb_text) override
 handle specialized clipboard text, with leading "(sym_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)
 
virtual bool handleDoubleClick (wxGridEvent &aEvent)
 
virtual void showPopupMenu (wxMenu &menu)
 
virtual void doPopupSelection (wxCommandEvent &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 147 of file panel_sym_lib_table.cpp.

Constructor & Destructor Documentation

◆ SYMBOL_GRID_TRICKS()

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

Definition at line 150 of file panel_sym_lib_table.cpp.

150  :
151  GRID_TRICKS( aGrid ),
152  m_dialog( aParent )
153  {
154  }
GRID_TRICKS(WX_GRID *aGrid)
Definition: grid_tricks.cpp:39
DIALOG_EDIT_LIBRARY_TABLES * m_dialog

Member Function Documentation

◆ cutcopy()

void GRID_TRICKS::cutcopy ( bool  doCut)
protectedvirtualinherited

Definition at line 588 of file grid_tricks.cpp.

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

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 GRID_TRICKS::doPopupSelection ( wxCommandEvent &  event)
protectedvirtualinherited

Reimplemented in FP_GRID_TRICKS, FIELDS_EDITOR_GRID_TRICKS, and FIELDS_GRID_TRICKS.

Definition at line 276 of file grid_tricks.cpp.

277 {
278  int menu_id = event.GetId();
279 
280  // assume getSelectedArea() was called by rightClickPopupMenu() and there's
281  // no way to have gotten here without that having been called.
282 
283  switch( menu_id )
284  {
285  case GRIDTRICKS_ID_CUT:
286  case GRIDTRICKS_ID_COPY:
287  cutcopy( menu_id == GRIDTRICKS_ID_CUT );
288  break;
289 
290  case GRIDTRICKS_ID_PASTE:
291  paste_clipboard();
292  break;
293 
295  m_grid->SelectAll();
296  break;
297 
298  default:
299  if( menu_id >= GRIDTRICKS_FIRST_SHOWHIDE )
300  {
301  int col = menu_id - GRIDTRICKS_FIRST_SHOWHIDE;
302 
303  if( m_grid->IsColShown( col ) )
304  m_grid->HideCol( col );
305  else
306  m_grid->ShowCol( col );
307  }
308  }
309 }
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:58
virtual void paste_clipboard()
virtual void cutcopy(bool doCut)

References GRID_TRICKS::cutcopy(), GRIDTRICKS_FIRST_SHOWHIDE, GRIDTRICKS_ID_COPY, GRIDTRICKS_ID_CUT, GRIDTRICKS_ID_PASTE, GRIDTRICKS_ID_SELECT, GRID_TRICKS::m_grid, and GRID_TRICKS::paste_clipboard().

Referenced by FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FP_GRID_TRICKS::doPopupSelection(), and GRID_TRICKS::onPopupSelection().

◆ 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 169 of file grid_tricks.cpp.

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

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 GRID_TRICKS::handleDoubleClick ( wxGridEvent &  aEvent)
protectedvirtualinherited

Reimplemented in FP_GRID_TRICKS.

Definition at line 162 of file grid_tricks.cpp.

163 {
164  // Double-click processing must be handled by specific sub-classes
165  return false;
166 }

Referenced by GRID_TRICKS::onGridCellLeftDClick().

◆ onGridCellLeftClick()

void GRID_TRICKS::onGridCellLeftClick ( wxGridEvent &  event)
protectedinherited

Definition at line 136 of file grid_tricks.cpp.

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

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 155 of file grid_tricks.cpp.

156 {
157  if( !handleDoubleClick( aEvent ) )
158  onGridCellLeftClick( aEvent );
159 }
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 209 of file grid_tricks.cpp.

210 {
211  wxMenu menu;
212 
213  showPopupMenu( menu );
214 }
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 217 of file grid_tricks.cpp.

218 {
220 
221  aEvent.Skip();
222 }
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:58
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 225 of file grid_tricks.cpp.

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

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 312 of file grid_tricks.cpp.

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

271 {
272  doPopupSelection( event );
273 }
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 623 of file grid_tricks.cpp.

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

References GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::GRID_TRICKS().

◆ paste_clipboard()

void GRID_TRICKS::paste_clipboard ( )
protectedvirtualinherited

Definition at line 473 of file grid_tricks.cpp.

474 {
475  if( wxTheClipboard->Open() )
476  {
477  if( wxTheClipboard->IsSupported( wxDF_TEXT ) )
478  {
479  wxTextDataObject data;
480 
481  wxTheClipboard->GetData( data );
482 
483  paste_text( data.GetText() );
484  }
485 
486  wxTheClipboard->Close();
487  m_grid->ForceRefresh();
488  }
489 }
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:58
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()

virtual void SYMBOL_GRID_TRICKS::paste_text ( const wxString &  cb_text)
inlineoverrideprotectedvirtual

handle specialized clipboard text, with leading "(sym_lib_table" or spreadsheet formatted text.

Reimplemented from GRID_TRICKS.

Definition at line 161 of file panel_sym_lib_table.cpp.

162  {
163  SYMBOL_LIB_TABLE_GRID* tbl = (SYMBOL_LIB_TABLE_GRID*) m_grid->GetTable();
164  size_t ndx = cb_text.find( "(sym_lib_table" );
165 
166  if( ndx != std::string::npos )
167  {
168  // paste the SYMBOL_LIB_TABLE_ROWs of s-expression (sym_lib_table), starting
169  // at column 0 regardless of current cursor column.
170 
171  STRING_LINE_READER slr( TO_UTF8( cb_text ), "Clipboard" );
172  LIB_TABLE_LEXER lexer( &slr );
173  SYMBOL_LIB_TABLE tmp_tbl;
174  bool parsed = true;
175 
176  try
177  {
178  tmp_tbl.Parse( &lexer );
179  }
180  catch( PARSE_ERROR& pe )
181  {
182  DisplayError( m_dialog, pe.What() );
183  parsed = false;
184  }
185 
186  if( parsed )
187  {
188  // make sure the table is big enough...
189  if( tmp_tbl.GetCount() > (unsigned) tbl->GetNumberRows() )
190  tbl->AppendRows( tmp_tbl.GetCount() - tbl->GetNumberRows() );
191 
192  for( unsigned i = 0; i < tmp_tbl.GetCount(); ++i )
193  tbl->rows.replace( i, tmp_tbl.At( i ).clone() );
194  }
195 
196  m_grid->AutoSizeColumns( false );
197  }
198  else
199  {
200  // paste spreadsheet formatted text.
201  GRID_TRICKS::paste_text( cb_text );
202 
203  m_grid->AutoSizeColumns( false );
204  }
205  }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
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:58
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:100
LIB_TABLE_ROW * clone() const
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.
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.
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...
STRING_LINE_READER is a LINE_READER that reads from a multiline 8 bit wide std::string.
Definition: richio.h:254

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, SYMBOL_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 101 of file grid_tricks.cpp.

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

Reimplemented in FP_GRID_TRICKS, FIELDS_EDITOR_GRID_TRICKS, and FIELDS_GRID_TRICKS.

Definition at line 240 of file grid_tricks.cpp.

241 {
242  menu.Append( GRIDTRICKS_ID_CUT, _( "Cut\tCTRL+X" ), _( "Clear selected cells placing original contents on clipboard" ) );
243  menu.Append( GRIDTRICKS_ID_COPY, _( "Copy\tCTRL+C" ), _( "Copy selected cells to clipboard" ) );
244  menu.Append( GRIDTRICKS_ID_PASTE, _( "Paste\tCTRL+V" ), _( "Paste clipboard cells to matrix at current cell" ) );
245  menu.Append( GRIDTRICKS_ID_SELECT, _( "Select All\tCTRL+A" ), _( "Select all cells" ) );
246 
247  getSelectedArea();
248 
249  // if nothing is selected, disable cut and copy.
251  {
252  menu.Enable( GRIDTRICKS_ID_CUT, false );
253  menu.Enable( GRIDTRICKS_ID_COPY, false );
254  }
255 
256  menu.Enable( GRIDTRICKS_ID_PASTE, false );
257 
258  if( wxTheClipboard->Open() )
259  {
260  if( wxTheClipboard->IsSupported( wxDF_TEXT ) )
261  menu.Enable( GRIDTRICKS_ID_PASTE, true );
262 
263  wxTheClipboard->Close();
264  }
265 
266  m_grid->PopupMenu( &menu );
267 }
void getSelectedArea()
Puts the selected area into a sensible rectangle of m_sel_{row,col}_{start,count} above.
int m_sel_row_count
Definition: grid_tricks.h:64
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:58
int m_sel_col_count
Definition: grid_tricks.h:65
#define _(s)
Definition: 3d_actions.cpp:33

References _, GRID_TRICKS::getSelectedArea(), GRIDTRICKS_ID_COPY, GRIDTRICKS_ID_CUT, GRIDTRICKS_ID_PASTE, GRIDTRICKS_ID_SELECT, GRID_TRICKS::m_grid, GRID_TRICKS::m_sel_col_count, and GRID_TRICKS::m_sel_row_count.

Referenced by GRID_TRICKS::onGridCellRightClick(), FIELDS_GRID_TRICKS::showPopupMenu(), FIELDS_EDITOR_GRID_TRICKS::showPopupMenu(), and FP_GRID_TRICKS::showPopupMenu().

◆ toggleCell()

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

Definition at line 58 of file grid_tricks.cpp.

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

References GRID_TRICKS::m_grid.

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

Member Data Documentation

◆ m_dialog

DIALOG_EDIT_LIBRARY_TABLES* SYMBOL_GRID_TRICKS::m_dialog
protected

Definition at line 157 of file panel_sym_lib_table.cpp.

Referenced by 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: