KiCad PCB EDA Suite
grid_tricks.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
5  * Copyright (C) 2012-18 KiCad Developers, see change_log.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 
26 #include <fctsys.h>
27 #include <grid_tricks.h>
28 #include <wx/tokenzr.h>
29 #include <wx/clipbrd.h>
31 
32 
33 // It works for table data on clipboard for an Excell spreadsheet,
34 // why not us too for now.
35 #define COL_SEP wxT( '\t' )
36 #define ROW_SEP wxT( '\n' )
37 
38 
40  m_grid( aGrid )
41 {
42  m_sel_row_start = 0;
43  m_sel_col_start = 0;
44  m_sel_row_count = 0;
45  m_sel_col_count = 0;
46 
47  aGrid->Connect( wxEVT_GRID_CELL_LEFT_CLICK, wxGridEventHandler( GRID_TRICKS::onGridCellLeftClick ), NULL, this );
48  aGrid->Connect( wxEVT_GRID_CELL_LEFT_DCLICK, wxGridEventHandler( GRID_TRICKS::onGridCellLeftDClick ), NULL, this );
49  aGrid->Connect( wxEVT_GRID_CELL_RIGHT_CLICK, wxGridEventHandler( GRID_TRICKS::onGridCellRightClick ), NULL, this );
50  aGrid->Connect( wxEVT_GRID_LABEL_RIGHT_CLICK, wxGridEventHandler( GRID_TRICKS::onGridLabelRightClick ), NULL, this );
51  aGrid->Connect( wxEVT_GRID_LABEL_LEFT_CLICK, wxGridEventHandler( GRID_TRICKS::onGridLabelLeftClick ), NULL, this );
52  aGrid->Connect( GRIDTRICKS_FIRST_ID, GRIDTRICKS_LAST_ID, wxEVT_COMMAND_MENU_SELECTED, wxCommandEventHandler( GRID_TRICKS::onPopupSelection ), NULL, this );
53  aGrid->Connect( wxEVT_KEY_DOWN, wxKeyEventHandler( GRID_TRICKS::onKeyDown ), NULL, this );
54  aGrid->Connect( wxEVT_UPDATE_UI, wxUpdateUIEventHandler( GRID_TRICKS::onUpdateUI ), NULL, this );
55 }
56 
57 
58 bool GRID_TRICKS::toggleCell( int aRow, int aCol, bool aPreserveSelection )
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 }
99 
100 
101 bool GRID_TRICKS::showEditor( int aRow, int aCol )
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 }
134 
135 
136 void GRID_TRICKS::onGridCellLeftClick( wxGridEvent& aEvent )
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 }
153 
154 
155 void GRID_TRICKS::onGridCellLeftDClick( wxGridEvent& aEvent )
156 {
157  if( !handleDoubleClick( aEvent ) )
158  onGridCellLeftClick( aEvent );
159 }
160 
161 
162 bool GRID_TRICKS::handleDoubleClick( wxGridEvent& aEvent )
163 {
164  // Double-click processing must be handled by specific sub-classes
165  return false;
166 }
167 
168 
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 }
207 
208 
210 {
211  wxMenu menu;
212 
213  showPopupMenu( menu );
214 }
215 
216 
217 void GRID_TRICKS::onGridLabelLeftClick( wxGridEvent& aEvent )
218 {
220 
221  aEvent.Skip();
222 }
223 
224 
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 }
238 
239 
240 void GRID_TRICKS::showPopupMenu( wxMenu& menu )
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 }
268 
269 
270 void GRID_TRICKS::onPopupSelection( wxCommandEvent& event )
271 {
272  doPopupSelection( event );
273 }
274 
275 
276 void GRID_TRICKS::doPopupSelection( wxCommandEvent& event )
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 }
310 
311 
312 void GRID_TRICKS::onKeyDown( wxKeyEvent& ev )
313 {
314  if( isCtl( 'A', ev ) )
315  {
316  m_grid->SelectAll();
317  return;
318  }
319  else if( isCtl( 'C', ev ) )
320  {
321  getSelectedArea();
322  cutcopy( false );
323  return;
324  }
325  else if( isCtl( 'V', ev ) )
326  {
327  getSelectedArea();
328  paste_clipboard();
329  return;
330  }
331  else if( isCtl( 'X', ev ) )
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 }
471 
472 
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 }
490 
491 
492 void GRID_TRICKS::paste_text( const wxString& cb_text )
493 {
494  wxGridTableBase* tbl = m_grid->GetTable();
495 
496  const int cur_row = m_grid->GetGridCursorRow();
497  const int cur_col = m_grid->GetGridCursorCol();
498  int start_row;
499  int end_row;
500  int start_col;
501  int end_col;
502  bool is_selection = false;
503 
504  if( cur_row < 0 || cur_col < 0 )
505  {
506  wxBell();
507  return;
508  }
509 
510  if( m_grid->GetSelectionMode() == wxGrid::wxGridSelectRows )
511  {
512  if( m_sel_row_count > 1 )
513  is_selection = true;
514  }
515  else
516  {
517  if( m_grid->IsSelection() )
518  is_selection = true;
519  }
520 
521  wxStringTokenizer rows( cb_text, ROW_SEP, wxTOKEN_RET_EMPTY );
522 
523  // If selection of cells is present
524  // then a clipboard pastes to selected cells only.
525  if( is_selection )
526  {
527  start_row = m_sel_row_start;
528  end_row = m_sel_row_start + m_sel_row_count;
529  start_col = m_sel_col_start;
530  end_col = m_sel_col_start + m_sel_col_count;
531  }
532  // Otherwise, paste whole clipboard
533  // starting from cell with cursor.
534  else
535  {
536  start_row = cur_row;
537  end_row = cur_row + rows.CountTokens();
538 
539  if( end_row > tbl->GetNumberRows() )
540  end_row = tbl->GetNumberRows();
541 
542  start_col = cur_col;
543  end_col = start_col; // end_col actual value calculates later
544  }
545 
546  for( int row = start_row; row < end_row; ++row )
547  {
548  // If number of selected rows bigger than count of rows in
549  // the clipboard, paste from the clipboard again and again
550  // while end of the selection is reached.
551  if( !rows.HasMoreTokens() )
552  rows.SetString( cb_text, ROW_SEP, wxTOKEN_RET_EMPTY );
553 
554  wxString rowTxt = rows.GetNextToken();
555 
556  wxStringTokenizer cols( rowTxt, COL_SEP, wxTOKEN_RET_EMPTY );
557 
558  if( !is_selection )
559  {
560  end_col = cur_col + cols.CountTokens();
561 
562  if( end_col > tbl->GetNumberCols() )
563  end_col = tbl->GetNumberCols();
564  }
565 
566  for( int col = start_col; col < end_col; ++col )
567  {
568  // If number of selected columns bigger than count of columns in
569  // the clipboard, paste from the clipboard again and again while
570  // end of the selection is reached.
571  if( !cols.HasMoreTokens() )
572  cols.SetString( rowTxt, COL_SEP, wxTOKEN_RET_EMPTY );
573 
574  wxString cellTxt = cols.GetNextToken();
575  tbl->SetValue( row, col, cellTxt );
576  }
577  }
578 }
579 
580 
581 void GRID_TRICKS::cutcopy( bool doCut )
582 {
583  if( wxTheClipboard->Open() )
584  {
585  wxGridTableBase* tbl = m_grid->GetTable();
586  wxString txt;
587 
588  // fill txt with a format that is compatible with most spreadsheets
589  for( int row = m_sel_row_start; row < m_sel_row_start + m_sel_row_count; ++row )
590  {
591  for( int col = m_sel_col_start; col < m_sel_col_start + m_sel_col_count; ++col )
592  {
593  txt += tbl->GetValue( row, col );
594 
595  if( col < m_sel_col_start + m_sel_col_count - 1 ) // that was not last column
596  txt += COL_SEP;
597 
598  if( doCut )
599  tbl->SetValue( row, col, wxEmptyString );
600  }
601  txt += ROW_SEP;
602  }
603 
604  wxTheClipboard->SetData( new wxTextDataObject( txt ) );
605  wxTheClipboard->Close();
606 
607  if( doCut )
608  m_grid->ForceRefresh();
609  }
610 }
611 
612 
613 void GRID_TRICKS::onUpdateUI( wxUpdateUIEvent& event )
614 {
615  // Respect ROW selectionMode when moving cursor
616 
617  if( m_grid->GetSelectionMode() == wxGrid::wxGridSelectRows )
618  {
619  int cursorRow = m_grid->GetGridCursorRow();
620  bool cursorInSelectedRow = false;
621 
622  for( int row : m_grid->GetSelectedRows() )
623  {
624  if( row == cursorRow )
625  {
626  cursorInSelectedRow = true;
627  break;
628  }
629  }
630 
631  if( !cursorInSelectedRow && cursorRow >= 0 )
632  m_grid->SelectRow( cursorRow );
633  }
634 }
void onGridLabelLeftClick(wxGridEvent &event)
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
void onGridCellLeftClick(wxGridEvent &event)
void onGridCellRightClick(wxGridEvent &event)
virtual bool handleDoubleClick(wxGridEvent &aEvent)
int m_sel_col_start
Definition: grid_tricks.h:63
static bool isCtl(int aChar, const wxKeyEvent &e)
Definition: grid_tricks.h:70
GRID_TRICKS(WX_GRID *aGrid)
Definition: grid_tricks.cpp:39
void onGridCellLeftDClick(wxGridEvent &event)
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)
void onPopupSelection(wxCommandEvent &event)
int m_sel_col_count
Definition: grid_tricks.h:65
bool toggleCell(int aRow, int aCol, bool aPreserveSelection=false)
Definition: grid_tricks.cpp:58
bool showEditor(int aRow, int aCol)
#define NULL
int m_sel_row_start
Definition: grid_tricks.h:62
virtual void paste_clipboard()
void onUpdateUI(wxUpdateUIEvent &event)
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
void onGridLabelRightClick(wxGridEvent &event)
#define ROW_SEP
Definition: grid_tricks.cpp:36
virtual void doPopupSelection(wxCommandEvent &event)
virtual void showPopupMenu(wxMenu &menu)
#define _(s)
Definition: 3d_actions.cpp:33
#define COL_SEP
Definition: grid_tricks.cpp:35
virtual void cutcopy(bool doCut)
void onKeyDown(wxKeyEvent &ev)
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