kicad/common/grid_tricks.cpp

813 lines
24 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 2012-2022 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#include <grid_tricks.h>
#include <wx/defs.h>
#include <wx/event.h>
#include <wx/tokenzr.h>
#include <wx/clipbrd.h>
#include <wx/log.h>
#include <widgets/grid_readonly_text_helpers.h>
// It works for table data on clipboard for an Excel spreadsheet,
// why not us too for now.
#define COL_SEP wxT( '\t' )
#define ROW_SEP wxT( '\n' )
GRID_TRICKS::GRID_TRICKS( WX_GRID* aGrid ) :
m_grid( aGrid ),
m_addHandler( []( wxCommandEvent& ) {} )
{
init();
}
GRID_TRICKS::GRID_TRICKS( WX_GRID* aGrid, std::function<void( wxCommandEvent& )> aAddHandler ) :
m_grid( aGrid ),
m_addHandler( aAddHandler )
{
init();
}
void GRID_TRICKS::init()
{
m_sel_row_start = 0;
m_sel_col_start = 0;
m_sel_row_count = 0;
m_sel_col_count = 0;
m_grid->Connect( wxEVT_GRID_CELL_LEFT_CLICK,
wxGridEventHandler( GRID_TRICKS::onGridCellLeftClick ), nullptr, this );
m_grid->Connect( wxEVT_GRID_CELL_LEFT_DCLICK,
wxGridEventHandler( GRID_TRICKS::onGridCellLeftDClick ), nullptr, this );
m_grid->Connect( wxEVT_GRID_CELL_RIGHT_CLICK,
wxGridEventHandler( GRID_TRICKS::onGridCellRightClick ), nullptr, this );
m_grid->Connect( wxEVT_GRID_LABEL_RIGHT_CLICK,
wxGridEventHandler( GRID_TRICKS::onGridLabelRightClick ), nullptr, this );
m_grid->Connect( wxEVT_GRID_LABEL_LEFT_CLICK,
wxGridEventHandler( GRID_TRICKS::onGridLabelLeftClick ), nullptr, this );
m_grid->Connect( GRIDTRICKS_FIRST_ID, GRIDTRICKS_LAST_ID, wxEVT_COMMAND_MENU_SELECTED,
wxCommandEventHandler( GRID_TRICKS::onPopupSelection ), nullptr, this );
m_grid->Connect( wxEVT_CHAR_HOOK,
wxCharEventHandler( GRID_TRICKS::onCharHook ), nullptr, this );
m_grid->Connect( wxEVT_KEY_DOWN,
wxKeyEventHandler( GRID_TRICKS::onKeyDown ), nullptr, this );
m_grid->Connect( wxEVT_UPDATE_UI,
wxUpdateUIEventHandler( GRID_TRICKS::onUpdateUI ), nullptr, this );
// The handlers that control the tooltips must be on the actual grid window, not the grid
m_grid->GetGridWindow()->Connect( wxEVT_MOTION,
wxMouseEventHandler( GRID_TRICKS::onGridMotion ), nullptr,
this );
}
bool GRID_TRICKS::toggleCell( int aRow, int aCol, bool aPreserveSelection )
{
wxGridCellRenderer* renderer = m_grid->GetCellRenderer( aRow, aCol );
bool isCheckbox = ( dynamic_cast<wxGridCellBoolRenderer*>( renderer ) );
renderer->DecRef();
if( isCheckbox )
{
if( !aPreserveSelection )
{
m_grid->ClearSelection();
m_grid->SetGridCursor( aRow, aCol );
}
wxGridTableBase* model = m_grid->GetTable();
if( model->CanGetValueAs( aRow, aCol, wxGRID_VALUE_BOOL )
&& model->CanSetValueAs( aRow, aCol, wxGRID_VALUE_BOOL ) )
{
model->SetValueAsBool( aRow, aCol, !model->GetValueAsBool( aRow, aCol ) );
}
else // fall back to string processing
{
if( model->GetValue( aRow, aCol ) == wxT( "1" ) )
model->SetValue( aRow, aCol, wxT( "0" ) );
else
model->SetValue( aRow, aCol, wxT( "1" ) );
}
// Mac needs this for the keyboard events; Linux appears to always need it.
m_grid->ForceRefresh();
// Let any clients know
wxGridEvent event( m_grid->GetId(), wxEVT_GRID_CELL_CHANGED, m_grid, aRow, aCol );
event.SetString( model->GetValue( aRow, aCol ) );
m_grid->GetEventHandler()->ProcessEvent( event );
return true;
}
return false;
}
bool GRID_TRICKS::showEditor( int aRow, int aCol )
{
if( m_grid->GetGridCursorRow() != aRow || m_grid->GetGridCursorCol() != aCol )
m_grid->SetGridCursor( aRow, aCol );
if( m_grid->IsEditable() && !m_grid->IsReadOnly( aRow, aCol ) )
{
m_grid->ClearSelection();
if( m_grid->GetSelectionMode() == wxGrid::wxGridSelectRows )
{
wxArrayInt rows = m_grid->GetSelectedRows();
if( rows.size() != 1 || rows.Item( 0 ) != aRow )
m_grid->SelectRow( aRow );
}
// For several reasons we can't enable the control here. There's the whole
// SetInSetFocus() issue/hack in wxWidgets, and there's also wxGrid's MouseUp
// handler which doesn't notice it's processing a MouseUp until after it has
// disabled the editor yet again. So we re-use wxWidgets' slow-click hack,
// which is processed later in the MouseUp handler.
//
// It should be pointed out that the fact that it's wxWidgets' hack doesn't
// make it any less of a hack. Be extra careful with any modifications here.
// See, in particular, https://bugs.launchpad.net/kicad/+bug/1817965.
m_grid->ShowEditorOnMouseUp();
return true;
}
return false;
}
void GRID_TRICKS::onGridCellLeftClick( wxGridEvent& aEvent )
{
int row = aEvent.GetRow();
int col = aEvent.GetCol();
// Don't make users click twice to toggle a checkbox or edit a text cell
if( !aEvent.GetModifiers() )
{
bool toggled = false;
if( toggleCell( row, col, true ) )
toggled = true;
else if( showEditor( row, col ) )
return;
// Apply checkbox changes to multi-selection.
// Non-checkbox changes handled elsewhere
if( toggled )
{
getSelectedArea();
// We only want to apply this to whole rows. If the grid allows selecting individual
// cells, and the selection contains dijoint cells, skip this logic.
if( !m_grid->GetSelectedCells().IsEmpty() || m_sel_row_count < 2 )
{
// We preserved the selection in toggleCell above; so clear it now that we know
// we aren't doing a multi-select edit
m_grid->ClearSelection();
return;
}
wxString newVal = m_grid->GetCellValue( row, col );
for( int affectedRow = m_sel_row_start; affectedRow < m_sel_row_count; ++affectedRow )
{
if( affectedRow == row )
continue;
m_grid->SetCellValue( affectedRow, col, newVal );
}
}
}
aEvent.Skip();
}
void GRID_TRICKS::onGridCellLeftDClick( wxGridEvent& aEvent )
{
if( !handleDoubleClick( aEvent ) )
onGridCellLeftClick( aEvent );
}
void GRID_TRICKS::onGridMotion( wxMouseEvent& aEvent )
{
// Always skip the event
aEvent.Skip();
wxPoint pt = aEvent.GetPosition();
wxPoint pos = m_grid->CalcScrolledPosition( wxPoint( pt.x, pt.y ) );
int col = m_grid->XToCol( pos.x );
int row = m_grid->YToRow( pos.y );
// Empty tooltip if the cell doesn't exist or the column doesn't have tooltips
if( ( col == wxNOT_FOUND ) || ( row == wxNOT_FOUND ) || !m_tooltipEnabled[col] )
{
m_grid->GetGridWindow()->SetToolTip( wxS( "" ) );
return;
}
// Set the tooltip to the string contained in the cell
m_grid->GetGridWindow()->SetToolTip( m_grid->GetCellValue( row, col ) );
}
bool GRID_TRICKS::handleDoubleClick( wxGridEvent& aEvent )
{
// Double-click processing must be handled by specific sub-classes
return false;
}
void GRID_TRICKS::getSelectedArea()
{
wxGridCellCoordsArray topLeft = m_grid->GetSelectionBlockTopLeft();
wxGridCellCoordsArray botRight = m_grid->GetSelectionBlockBottomRight();
wxArrayInt cols = m_grid->GetSelectedCols();
wxArrayInt rows = m_grid->GetSelectedRows();
if( topLeft.Count() && botRight.Count() )
{
m_sel_row_start = topLeft[0].GetRow();
m_sel_col_start = topLeft[0].GetCol();
m_sel_row_count = botRight[0].GetRow() - m_sel_row_start + 1;
m_sel_col_count = botRight[0].GetCol() - m_sel_col_start + 1;
}
else if( cols.Count() )
{
m_sel_col_start = cols[0];
m_sel_col_count = cols.Count();
m_sel_row_start = 0;
m_sel_row_count = m_grid->GetNumberRows();
}
else if( rows.Count() )
{
m_sel_col_start = 0;
m_sel_col_count = m_grid->GetNumberCols();
m_sel_row_start = rows[0];
m_sel_row_count = rows.Count();
}
else
{
m_sel_row_start = m_grid->GetGridCursorRow();
m_sel_col_start = m_grid->GetGridCursorCol();
m_sel_row_count = m_sel_row_start >= 0 ? 1 : 0;
m_sel_col_count = m_sel_col_start >= 0 ? 1 : 0;
}
}
void GRID_TRICKS::onGridCellRightClick( wxGridEvent& )
{
wxMenu menu;
showPopupMenu( menu );
}
void GRID_TRICKS::onGridLabelLeftClick( wxGridEvent& aEvent )
{
m_grid->CommitPendingChanges();
aEvent.Skip();
}
void GRID_TRICKS::onGridLabelRightClick( wxGridEvent& )
{
wxMenu menu;
for( int i = 0; i < m_grid->GetNumberCols(); ++i )
{
int id = GRIDTRICKS_FIRST_SHOWHIDE + i;
menu.AppendCheckItem( id, m_grid->GetColLabelValue( i ) );
menu.Check( id, m_grid->IsColShown( i ) );
}
m_grid->PopupMenu( &menu );
}
void GRID_TRICKS::showPopupMenu( wxMenu& menu )
{
menu.Append( GRIDTRICKS_ID_CUT, _( "Cut" ) + "\tCtrl+X",
_( "Clear selected cells placing original contents on clipboard" ) );
menu.Append( GRIDTRICKS_ID_COPY, _( "Copy" ) + "\tCtrl+C",
_( "Copy selected cells to clipboard" ) );
menu.Append( GRIDTRICKS_ID_PASTE, _( "Paste" ) + "\tCtrl+V",
_( "Paste clipboard cells to matrix at current cell" ) );
menu.Append( GRIDTRICKS_ID_DELETE, _( "Delete" ) + "\tDel", _( "Delete selected cells" ) );
menu.Append( GRIDTRICKS_ID_SELECT, _( "Select All" ) + "\tCtrl+A", _( "Select all cells" ) );
getSelectedArea();
// if nothing is selected, disable cut, copy and delete.
if( !m_sel_row_count && !m_sel_col_count )
{
menu.Enable( GRIDTRICKS_ID_CUT, false );
menu.Enable( GRIDTRICKS_ID_COPY, false );
menu.Enable( GRIDTRICKS_ID_DELETE, false );
}
else if( !m_grid->IsEditable() )
{
menu.Enable( GRIDTRICKS_ID_CUT, false );
menu.Enable( GRIDTRICKS_ID_DELETE, false );
}
menu.Enable( GRIDTRICKS_ID_PASTE, false );
wxLogNull doNotLog; // disable logging of failed clipboard actions
if( m_grid->IsEditable() && wxTheClipboard->Open() )
{
if( wxTheClipboard->IsSupported( wxDF_TEXT )
|| wxTheClipboard->IsSupported( wxDF_UNICODETEXT ) )
{
menu.Enable( GRIDTRICKS_ID_PASTE, true );
}
wxTheClipboard->Close();
}
m_grid->PopupMenu( &menu );
}
void GRID_TRICKS::onPopupSelection( wxCommandEvent& event )
{
doPopupSelection( event );
}
void GRID_TRICKS::doPopupSelection( wxCommandEvent& event )
{
int menu_id = event.GetId();
// assume getSelectedArea() was called by rightClickPopupMenu() and there's
// no way to have gotten here without that having been called.
switch( menu_id )
{
case GRIDTRICKS_ID_CUT:
cutcopy( true, true );
break;
case GRIDTRICKS_ID_COPY:
cutcopy( true, false );
break;
case GRIDTRICKS_ID_DELETE:
cutcopy( false, true );
break;
case GRIDTRICKS_ID_PASTE:
paste_clipboard();
break;
case GRIDTRICKS_ID_SELECT:
m_grid->SelectAll();
break;
default:
if( menu_id >= GRIDTRICKS_FIRST_SHOWHIDE )
{
int col = menu_id - GRIDTRICKS_FIRST_SHOWHIDE;
if( m_grid->IsColShown( col ) )
m_grid->HideCol( col );
else
m_grid->ShowCol( col );
}
}
}
void GRID_TRICKS::onCharHook( wxKeyEvent& ev )
{
bool handled = false;
if( ev.GetKeyCode() == WXK_RETURN && m_grid->GetGridCursorRow() == m_grid->GetNumberRows() - 1 )
{
if( m_grid->CommitPendingChanges() )
{
wxCommandEvent dummy;
m_addHandler( dummy );
handled = true;
}
}
else if( ev.GetModifiers() == wxMOD_CONTROL && ev.GetKeyCode() == 'V' )
{
if( m_grid->IsCellEditControlShown() && wxTheClipboard->Open() )
{
if( wxTheClipboard->IsSupported( wxDF_TEXT )
|| wxTheClipboard->IsSupported( wxDF_UNICODETEXT ) )
{
wxTextDataObject data;
wxTheClipboard->GetData( data );
if( data.GetText().Contains( COL_SEP ) || data.GetText().Contains( ROW_SEP ) )
{
m_grid->CommitPendingChanges( true /* quiet mode */ );
paste_text( data.GetText() );
handled = true;
}
}
wxTheClipboard->Close();
m_grid->ForceRefresh();
}
}
if( !handled )
ev.Skip( true );
}
void GRID_TRICKS::onKeyDown( wxKeyEvent& ev )
{
if( ev.GetModifiers() == wxMOD_CONTROL && ev.GetKeyCode() == 'A' )
{
m_grid->SelectAll();
return;
}
else if( ev.GetModifiers() == wxMOD_CONTROL && ev.GetKeyCode() == 'C' )
{
getSelectedArea();
cutcopy( true, false );
return;
}
else if( ev.GetModifiers() == wxMOD_CONTROL && ev.GetKeyCode() == 'V' )
{
getSelectedArea();
paste_clipboard();
return;
}
else if( ev.GetModifiers() == wxMOD_CONTROL && ev.GetKeyCode() == 'X' )
{
getSelectedArea();
cutcopy( true, true );
return;
}
else if( !ev.GetModifiers() && ev.GetKeyCode() == WXK_DELETE )
{
getSelectedArea();
cutcopy( false, true );
return;
}
// space-bar toggling of checkboxes
if( m_grid->IsEditable() && ev.GetKeyCode() == ' ' )
{
bool retVal = false;
// If only rows can be selected, only toggle the first cell in a row
if( m_grid->GetSelectionMode() == wxGrid::wxGridSelectRows )
{
wxArrayInt rowSel = m_grid->GetSelectedRows();
for( unsigned int rowInd = 0; rowInd < rowSel.GetCount(); rowInd++ )
{
retVal |= toggleCell( rowSel[rowInd], 0, true );
}
}
// If only columns can be selected, only toggle the first cell in a column
else if( m_grid->GetSelectionMode() == wxGrid::wxGridSelectColumns )
{
wxArrayInt colSel = m_grid->GetSelectedCols();
for( unsigned int colInd = 0; colInd < colSel.GetCount(); colInd++ )
{
retVal |= toggleCell( 0, colSel[colInd], true );
}
}
// If the user can select the individual cells, toggle each cell selected
else if( m_grid->GetSelectionMode() == wxGrid::wxGridSelectCells )
{
wxArrayInt rowSel = m_grid->GetSelectedRows();
wxArrayInt colSel = m_grid->GetSelectedCols();
wxGridCellCoordsArray cellSel = m_grid->GetSelectedCells();
wxGridCellCoordsArray topLeft = m_grid->GetSelectionBlockTopLeft();
wxGridCellCoordsArray botRight = m_grid->GetSelectionBlockBottomRight();
// Iterate over every individually selected cell and try to toggle it
for( unsigned int cellInd = 0; cellInd < cellSel.GetCount(); cellInd++ )
{
retVal |= toggleCell( cellSel[cellInd].GetRow(), cellSel[cellInd].GetCol(), true );
}
// Iterate over every column and try to toggle each cell in it
for( unsigned int colInd = 0; colInd < colSel.GetCount(); colInd++ )
{
for( int row = 0; row < m_grid->GetNumberRows(); row++ )
{
retVal |= toggleCell( row, colSel[colInd], true );
}
}
// Iterate over every row and try to toggle each cell in it
for( unsigned int rowInd = 0; rowInd < rowSel.GetCount(); rowInd++ )
{
for( int col = 0; col < m_grid->GetNumberCols(); col++ )
{
retVal |= toggleCell( rowSel[rowInd], col, true );
}
}
// Iterate over the selection blocks
for( unsigned int blockInd = 0; blockInd < topLeft.GetCount(); blockInd++ )
{
wxGridCellCoords start = topLeft[blockInd];
wxGridCellCoords end = botRight[blockInd];
for( int row = start.GetRow(); row <= end.GetRow(); row++ )
{
for( int col = start.GetCol(); col <= end.GetCol(); col++ )
{
retVal |= toggleCell( row, col, true );
}
}
}
}
// Return if there were any cells toggled
if( retVal )
return;
}
// ctrl-tab for exit grid
#ifdef __APPLE__
bool ctrl = ev.RawControlDown();
#else
bool ctrl = ev.ControlDown();
#endif
if( ctrl && ev.GetKeyCode() == WXK_TAB )
{
wxWindow* test = m_grid->GetNextSibling();
if( !test )
test = m_grid->GetParent()->GetNextSibling();
while( test && !test->IsTopLevel() )
{
test->SetFocus();
if( test->HasFocus() )
break;
if( !test->GetChildren().empty() )
{
test = test->GetChildren().front();
}
else if( test->GetNextSibling() )
{
test = test->GetNextSibling();
}
else
{
while( test )
{
test = test->GetParent();
if( test && test->IsTopLevel() )
{
break;
}
else if( test && test->GetNextSibling() )
{
test = test->GetNextSibling();
break;
}
}
}
}
return;
}
ev.Skip( true );
}
void GRID_TRICKS::paste_clipboard()
{
wxLogNull doNotLog; // disable logging of failed clipboard actions
if( m_grid->IsEditable() && wxTheClipboard->Open() )
{
if( wxTheClipboard->IsSupported( wxDF_TEXT )
|| wxTheClipboard->IsSupported( wxDF_UNICODETEXT ) )
{
wxTextDataObject data;
wxTheClipboard->GetData( data );
paste_text( data.GetText() );
}
wxTheClipboard->Close();
m_grid->ForceRefresh();
}
}
void GRID_TRICKS::paste_text( const wxString& cb_text )
{
wxGridTableBase* tbl = m_grid->GetTable();
const int cur_row = m_grid->GetGridCursorRow();
const int cur_col = m_grid->GetGridCursorCol();
int start_row;
int end_row;
int start_col;
int end_col;
bool is_selection = false;
if( cur_row < 0 || cur_col < 0 )
{
wxBell();
return;
}
if( m_grid->GetSelectionMode() == wxGrid::wxGridSelectRows )
{
if( m_sel_row_count > 1 )
is_selection = true;
}
else
{
if( m_grid->IsSelection() )
is_selection = true;
}
wxStringTokenizer rows( cb_text, ROW_SEP, wxTOKEN_RET_EMPTY );
// If selection of cells is present
// then a clipboard pastes to selected cells only.
if( is_selection )
{
start_row = m_sel_row_start;
end_row = m_sel_row_start + m_sel_row_count;
start_col = m_sel_col_start;
end_col = m_sel_col_start + m_sel_col_count;
}
// Otherwise, paste whole clipboard
// starting from cell with cursor.
else
{
start_row = cur_row;
end_row = cur_row + rows.CountTokens();
if( end_row > tbl->GetNumberRows() )
end_row = tbl->GetNumberRows();
start_col = cur_col;
end_col = start_col; // end_col actual value calculates later
}
for( int row = start_row; row < end_row; ++row )
{
// If number of selected rows is larger than the count of rows on the clipboard, paste
// again and again until the end of the selection is reached.
if( !rows.HasMoreTokens() )
rows.SetString( cb_text, ROW_SEP, wxTOKEN_RET_EMPTY );
wxString rowTxt = rows.GetNextToken();
wxStringTokenizer cols( rowTxt, COL_SEP, wxTOKEN_RET_EMPTY );
if( !is_selection )
{
end_col = cur_col + cols.CountTokens();
if( end_col > tbl->GetNumberCols() )
end_col = tbl->GetNumberCols();
}
for( int col = start_col; col < end_col; ++col )
{
// Skip hidden columns
if( !m_grid->IsColShown( col ) )
continue;
// If number of selected cols is larger than the count of cols on the clipboard,
// paste again and again until the end of the selection is reached.
if( !cols.HasMoreTokens() )
cols.SetString( rowTxt, COL_SEP, wxTOKEN_RET_EMPTY );
wxString cellTxt = cols.GetNextToken();
if( tbl->CanSetValueAs( row, col, wxGRID_VALUE_STRING ) )
{
tbl->SetValue( row, col, cellTxt );
wxGridEvent evt( m_grid->GetId(), wxEVT_GRID_CELL_CHANGED, m_grid, row, col );
m_grid->GetEventHandler()->ProcessEvent( evt );
}
}
}
}
void GRID_TRICKS::cutcopy( bool doCopy, bool doDelete )
{
wxLogNull doNotLog; // disable logging of failed clipboard actions
if( doCopy && !wxTheClipboard->Open() )
return;
wxGridTableBase* tbl = m_grid->GetTable();
wxString txt;
// fill txt with a format that is compatible with most spreadsheets
for( int row = m_sel_row_start; row < m_sel_row_start + m_sel_row_count; ++row )
{
for( int col = m_sel_col_start; col < m_sel_col_start + m_sel_col_count; ++col )
{
if( !m_grid->IsColShown( col ) )
continue;
txt += tbl->GetValue( row, col );
if( col < m_sel_col_start + m_sel_col_count - 1 ) // that was not last column
txt += COL_SEP;
if( doDelete && m_grid->IsEditable() )
{
if( tbl->CanSetValueAs( row, col, wxGRID_VALUE_STRING ) )
tbl->SetValue( row, col, wxEmptyString );
}
}
txt += ROW_SEP;
}
if( doCopy )
{
wxTheClipboard->SetData( new wxTextDataObject( txt ) );
wxTheClipboard->Flush(); // Allow data to be available after closing KiCad
wxTheClipboard->Close();
}
if( doDelete )
m_grid->ForceRefresh();
}
void GRID_TRICKS::onUpdateUI( wxUpdateUIEvent& event )
{
// Respect ROW selectionMode when moving cursor
if( m_grid->GetSelectionMode() == wxGrid::wxGridSelectRows )
{
int cursorRow = m_grid->GetGridCursorRow();
bool cursorInSelectedRow = false;
for( int row : m_grid->GetSelectedRows() )
{
if( row == cursorRow )
{
cursorInSelectedRow = true;
break;
}
}
if( !cursorInSelectedRow && cursorRow >= 0 )
m_grid->SelectRow( cursorRow );
}
}