Add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance. More...

#include <grid_tricks.h>

Inheritance diagram for GRID_TRICKS:

Public Member Functions
	GRID_TRICKS (WX_GRID *aGrid)

void	SetTooltipEnable (int aCol, bool aEnable=true)
	Enable the tooltip for a column. More...

bool	GetTooltipEnabled (int aCol)
	Query if the tooltip for a column is enabled. More...

Protected Member Functions
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)

void	onGridMotion (wxMouseEvent &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	paste_text (const wxString &cb_text)

virtual void	cutcopy (bool doCopy, bool doDelete)

Protected Attributes
WX_GRID *	m_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

std::bitset< GRIDTRICKS_MAX_COL >	m_tooltipEnabled

Detailed Description

Add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.

Definition at line 55 of file grid_tricks.h.

Constructor & Destructor Documentation

◆ GRID_TRICKS()

GRID_TRICKS::GRID_TRICKS ( WX_GRID * aGrid )

explicit

Definition at line 40 of file grid_tricks.cpp.

                                         :
     m_grid( aGrid )
 {
     m_sel_row_start = 0;
     m_sel_col_start = 0;
     m_sel_row_count = 0;
     m_sel_col_count = 0;
 
     aGrid->Connect( wxEVT_GRID_CELL_LEFT_CLICK,
                     wxGridEventHandler( GRID_TRICKS::onGridCellLeftClick ), nullptr, this );
     aGrid->Connect( wxEVT_GRID_CELL_LEFT_DCLICK,
                     wxGridEventHandler( GRID_TRICKS::onGridCellLeftDClick ), nullptr, this );
     aGrid->Connect( wxEVT_GRID_CELL_RIGHT_CLICK,
                     wxGridEventHandler( GRID_TRICKS::onGridCellRightClick ), nullptr, this );
     aGrid->Connect( wxEVT_GRID_LABEL_RIGHT_CLICK,
                     wxGridEventHandler( GRID_TRICKS::onGridLabelRightClick ), nullptr, this );
     aGrid->Connect( wxEVT_GRID_LABEL_LEFT_CLICK,
                     wxGridEventHandler( GRID_TRICKS::onGridLabelLeftClick ), nullptr, this );
     aGrid->Connect( GRIDTRICKS_FIRST_ID, GRIDTRICKS_LAST_ID, wxEVT_COMMAND_MENU_SELECTED,
                     wxCommandEventHandler( GRID_TRICKS::onPopupSelection ), nullptr, this );
     aGrid->Connect( wxEVT_KEY_DOWN, wxKeyEventHandler( GRID_TRICKS::onKeyDown ), nullptr, this );
     aGrid->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
     aGrid->GetGridWindow()->Connect( wxEVT_MOTION,
                             wxMouseEventHandler( GRID_TRICKS::onGridMotion ), nullptr, this );
 }

References GRIDTRICKS_FIRST_ID, GRIDTRICKS_LAST_ID, m_sel_col_count, m_sel_col_start, m_sel_row_count, m_sel_row_start, onGridCellLeftClick(), onGridCellLeftDClick(), onGridCellRightClick(), onGridLabelLeftClick(), onGridLabelRightClick(), onGridMotion(), onKeyDown(), onPopupSelection(), and onUpdateUI().

Member Function Documentation

◆ cutcopy()

void GRID_TRICKS::cutcopy	(	bool	doCopy,
		bool	doDelete
	)

protectedvirtual

Definition at line 649 of file grid_tricks.cpp.

 {
     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 )
         {
             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 )
             {
                 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();
 }

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

Referenced by doPopupSelection(), and onKeyDown().

◆ doPopupSelection()

void GRID_TRICKS::doPopupSelection ( wxCommandEvent & event )

protectedvirtual

Reimplemented in FP_GRID_TRICKS, FIELDS_EDITOR_GRID_TRICKS, and FIELDS_GRID_TRICKS.

Definition at line 318 of file grid_tricks.cpp.

 {
     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 );
         }
     }
 }

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

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

◆ getSelectedArea()

void GRID_TRICKS::getSelectedArea ( )

protected

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

Definition at line 204 of file grid_tricks.cpp.

 {
     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;
     }
 }

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

Referenced by onKeyDown(), and showPopupMenu().

◆ GetTooltipEnabled()

bool GRID_TRICKS::GetTooltipEnabled ( int aCol )

inline

Query if the tooltip for a column is enabled.

Parameters

aCol	is the column to query

Returns: if the tooltip is enabled for the column

Definition at line 79 of file grid_tricks.h.

     {
         return m_tooltipEnabled[aCol];
     }

References m_tooltipEnabled.

◆ handleDoubleClick()

bool GRID_TRICKS::handleDoubleClick ( wxGridEvent & aEvent )

protectedvirtual

Reimplemented in FP_GRID_TRICKS.

Definition at line 197 of file grid_tricks.cpp.

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

Referenced by onGridCellLeftDClick().

◆ onGridCellLeftClick()

void GRID_TRICKS::onGridCellLeftClick ( wxGridEvent & event )

protected

Definition at line 148 of file grid_tricks.cpp.

 {
     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() )
     {
         if( toggleCell( row, col ) )
             return;
 
         if( showEditor( row, col ) )
             return;
     }
 
     aEvent.Skip();
 }

References showEditor(), and toggleCell().

Referenced by GRID_TRICKS(), and onGridCellLeftDClick().

◆ onGridCellLeftDClick()

void GRID_TRICKS::onGridCellLeftDClick ( wxGridEvent & event )

protected

Definition at line 167 of file grid_tricks.cpp.

 {
     if( !handleDoubleClick( aEvent ) )
         onGridCellLeftClick( aEvent );
 }

References handleDoubleClick(), and onGridCellLeftClick().

Referenced by GRID_TRICKS().

◆ onGridCellRightClick()

void GRID_TRICKS::onGridCellRightClick ( wxGridEvent & event )

protected

Definition at line 244 of file grid_tricks.cpp.

 {
     wxMenu menu;
 
     showPopupMenu( menu );
 }

References showPopupMenu().

Referenced by GRID_TRICKS().

◆ onGridLabelLeftClick()

void GRID_TRICKS::onGridLabelLeftClick ( wxGridEvent & event )

protected

Definition at line 252 of file grid_tricks.cpp.

 {
     m_grid->CommitPendingChanges();
 
     aEvent.Skip();
 }

References WX_GRID::CommitPendingChanges(), and m_grid.

Referenced by GRID_TRICKS().

◆ onGridLabelRightClick()

void GRID_TRICKS::onGridLabelRightClick ( wxGridEvent & event )

protected

Definition at line 260 of file grid_tricks.cpp.

 {
     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 );
 }

References GRIDTRICKS_FIRST_SHOWHIDE, and m_grid.

Referenced by GRID_TRICKS().

◆ onGridMotion()

void GRID_TRICKS::onGridMotion ( wxMouseEvent & event )

protected

Definition at line 174 of file grid_tricks.cpp.

 {
     // 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( "" );
         return;
     }
 
     // Set the tooltip to the string contained in the cell
     m_grid->GetGridWindow()->SetToolTip( m_grid->GetCellValue( row, col ) );
 }

References m_grid, and m_tooltipEnabled.

Referenced by GRID_TRICKS().

◆ onKeyDown()

void GRID_TRICKS::onKeyDown ( wxKeyEvent & ev )

protected

Definition at line 361 of file grid_tricks.cpp.

 {
     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( 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 );
                     }
                 }
             }
         }
         else
         {
         }
 
         // 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 );
 }

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

Referenced by GRID_TRICKS().

◆ onPopupSelection()

void GRID_TRICKS::onPopupSelection ( wxCommandEvent & event )

protected

Definition at line 312 of file grid_tricks.cpp.

 {
     doPopupSelection( event );
 }

References doPopupSelection().

Referenced by GRID_TRICKS().

◆ onUpdateUI()

void GRID_TRICKS::onUpdateUI ( wxUpdateUIEvent & event )

protected

Definition at line 691 of file grid_tricks.cpp.

 {
     // 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 );
     }
 }

References m_grid.

Referenced by GRID_TRICKS().

◆ paste_clipboard()

void GRID_TRICKS::paste_clipboard ( )

protectedvirtual

Definition at line 532 of file grid_tricks.cpp.

 {
     wxLogNull doNotLog; // disable logging of failed clipboard actions
 
     if( wxTheClipboard->Open() )
     {
         if( wxTheClipboard->IsSupported( wxDF_TEXT ) )
         {
             wxTextDataObject    data;
 
             wxTheClipboard->GetData( data );
 
             paste_text( data.GetText() );
         }
 
         wxTheClipboard->Close();
         m_grid->ForceRefresh();
     }
 }

References m_grid, and paste_text().

Referenced by doPopupSelection(), and onKeyDown().

◆ paste_text()

void GRID_TRICKS::paste_text ( const wxString & cb_text )

protectedvirtual

Reimplemented in FP_GRID_TRICKS, and SYMBOL_GRID_TRICKS.

Definition at line 553 of file grid_tricks.cpp.

 {
     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 bigger than count of rows in
         // the clipboard, paste from the clipboard again and again
         // while 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 )
         {
             // If number of selected columns bigger than count of columns in
             // the clipboard, paste from the clipboard again and again while
             // 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 );
             }
         }
     }
 }

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

Referenced by paste_clipboard(), SYMBOL_GRID_TRICKS::paste_text(), and FP_GRID_TRICKS::paste_text().

◆ SetTooltipEnable()

void GRID_TRICKS::SetTooltipEnable	(	int	aCol,
		bool	aEnable = `true`
	)

inline

Enable the tooltip for a column.

The tooltip is read from the string contained in the cell data.

Parameters

aCol	is the column to use
aEnable	is true to enable the tooltip (default)

Definition at line 68 of file grid_tricks.h.

     {
         m_tooltipEnabled[aCol] = aEnable;
     }

References m_tooltipEnabled.

Referenced by PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL().

◆ showEditor()

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

protected

Definition at line 113 of file grid_tricks.cpp.

 {
     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;
 }

References m_grid, and WX_GRID::ShowEditorOnMouseUp().

Referenced by onGridCellLeftClick().

◆ showPopupMenu()

void GRID_TRICKS::showPopupMenu ( wxMenu & menu )

protectedvirtual

Reimplemented in FP_GRID_TRICKS, FIELDS_EDITOR_GRID_TRICKS, and FIELDS_GRID_TRICKS.

Definition at line 275 of file grid_tricks.cpp.

 {
     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 );
     }
 
     menu.Enable( GRIDTRICKS_ID_PASTE, false );
 
     wxLogNull doNotLog; // disable logging of failed clipboard actions
 
     if( wxTheClipboard->Open() )
     {
         if( wxTheClipboard->IsSupported( wxDF_TEXT ) )
             menu.Enable( GRIDTRICKS_ID_PASTE, true );
 
         wxTheClipboard->Close();
     }
 
     m_grid->PopupMenu( &menu );
 }

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

Referenced by 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`
	)

protected

Definition at line 70 of file grid_tricks.cpp.

 {
     auto renderer = m_grid->GetCellRenderer( aRow, aCol );
     bool isCheckbox = ( dynamic_cast<wxGridCellBoolRenderer*>( renderer ) != nullptr );
     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;
 }

References m_grid.

Referenced by onGridCellLeftClick(), and onKeyDown().

Member Data Documentation

◆ m_grid

WX_GRID* GRID_TRICKS::m_grid

protected

◆ m_sel_col_count

int GRID_TRICKS::m_sel_col_count

protected

Definition at line 116 of file grid_tricks.h.

Referenced by cutcopy(), getSelectedArea(), GRID_TRICKS(), paste_text(), and showPopupMenu().

◆ m_sel_col_start

int GRID_TRICKS::m_sel_col_start

protected

Definition at line 114 of file grid_tricks.h.

Referenced by cutcopy(), getSelectedArea(), GRID_TRICKS(), and paste_text().

◆ m_sel_row_count

int GRID_TRICKS::m_sel_row_count

protected

Definition at line 115 of file grid_tricks.h.

Referenced by cutcopy(), getSelectedArea(), GRID_TRICKS(), paste_text(), and showPopupMenu().

◆ m_sel_row_start

int GRID_TRICKS::m_sel_row_start

protected

Definition at line 113 of file grid_tricks.h.

Referenced by cutcopy(), getSelectedArea(), GRID_TRICKS(), and paste_text().

◆ m_tooltipEnabled

std::bitset<GRIDTRICKS_MAX_COL> GRID_TRICKS::m_tooltipEnabled

protected

Definition at line 118 of file grid_tricks.h.

Referenced by GetTooltipEnabled(), onGridMotion(), and SetTooltipEnable().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GRID_TRICKS()

Member Function Documentation

◆ cutcopy()

◆ doPopupSelection()

◆ getSelectedArea()

◆ GetTooltipEnabled()

◆ handleDoubleClick()

◆ onGridCellLeftClick()

◆ onGridCellLeftDClick()

◆ onGridCellRightClick()

◆ onGridLabelLeftClick()

◆ onGridLabelRightClick()

◆ onGridMotion()

◆ onKeyDown()

◆ onPopupSelection()

◆ onUpdateUI()

◆ paste_clipboard()

◆ paste_text()

◆ SetTooltipEnable()

◆ showEditor()

◆ showPopupMenu()

◆ toggleCell()

Member Data Documentation

◆ m_grid

◆ m_sel_col_count

◆ m_sel_col_start

◆ m_sel_row_count

◆ m_sel_row_start

◆ m_tooltipEnabled