FP_GRID_TRICKS Class Reference

Inheritance diagram for FP_GRID_TRICKS:

Public Member Functions
	FP_GRID_TRICKS (DIALOG_EDIT_LIBRARY_TABLES *aParent, 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	optionsEditor (int aRow)
bool	handleDoubleClick (wxGridEvent &aEvent) override
void	showPopupMenu (wxMenu &menu) override
void	doPopupSelection (wxCommandEvent &event) override
void	paste_text (const wxString &cb_text) override
	handle specialized clipboard text, with leading "(fp_lib_table", OR spreadsheet formatted text. More...
void	init ()
	Shared initialization for various ctors. 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 &event)
void	onCharHook (wxKeyEvent &event)
void	onUpdateUI (wxUpdateUIEvent &event)
void	onGridMotion (wxMouseEvent &event)
bool	toggleCell (int aRow, int aCol, bool aPreserveSelection=false)
bool	showEditor (int aRow, int aCol)
virtual void	paste_clipboard ()
virtual void	cutcopy (bool doCopy, bool doDelete)

Protected Attributes
DIALOG_EDIT_LIBRARY_TABLES *	m_dialog
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::function< void(wxCommandEvent &)>	m_addHandler
std::bitset< GRIDTRICKS_MAX_COL >	m_tooltipEnabled

Private Types
enum	{ LIB_TABLE_GRID_TRICKS_ACTIVATE_SELECTED = GRIDTRICKS_FIRST_CLIENT_ID , LIB_TABLE_GRID_TRICKS_DEACTIVATE_SELECTED }

Detailed Description

Definition at line 250 of file panel_fp_lib_table.cpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

privateinherited

Enumerator
LIB_TABLE_GRID_TRICKS_ACTIVATE_SELECTED
LIB_TABLE_GRID_TRICKS_DEACTIVATE_SELECTED

Definition at line 24 of file lib_table_grid_tricks.h.

 {
 LIB_TABLE_GRID_TRICKS_ACTIVATE_SELECTED = GRIDTRICKS_FIRST_CLIENT_ID,
 LIB_TABLE_GRID_TRICKS_DEACTIVATE_SELECTED
 };

Constructor & Destructor Documentation

FP_GRID_TRICKS()

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

inline

Definition at line 253 of file panel_fp_lib_table.cpp.

 :
 LIB_TABLE_GRID_TRICKS( aGrid ), m_dialog( aParent )
 { }

Member Function Documentation

cutcopy()

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

protectedvirtualinherited

Definition at line 745 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 )
 {
 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();
}

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

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

doPopupSelection()

void FP_GRID_TRICKS::doPopupSelection ( wxCommandEvent &  event )

inlineoverrideprotectedvirtual

Reimplemented from LIB_TABLE_GRID_TRICKS.

Definition at line 303 of file panel_fp_lib_table.cpp.

 {
 if( event.GetId() == MYID_OPTIONS_EDITOR )
 optionsEditor( m_grid->GetGridCursorRow() );
 else
 LIB_TABLE_GRID_TRICKS::doPopupSelection( event );
 }

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

getSelectedArea()

void GRID_TRICKS::getSelectedArea ( )

protectedinherited

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

Definition at line 252 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 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::onGridCellLeftClick(), GRID_TRICKS::onKeyDown(), and GRID_TRICKS::showPopupMenu().

GetTooltipEnabled()

bool GRID_TRICKS::GetTooltipEnabled ( int  aCol )

inlineinherited

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 86 of file grid_tricks.h.

 {
 return m_tooltipEnabled[aCol];
 }

References GRID_TRICKS::m_tooltipEnabled.

handleDoubleClick()

bool FP_GRID_TRICKS::handleDoubleClick ( wxGridEvent &  aEvent )

inlineoverrideprotectedvirtual

Reimplemented from GRID_TRICKS.

Definition at line 281 of file panel_fp_lib_table.cpp.

 {
 if( aEvent.GetCol() == COL_OPTIONS )
 {
 optionsEditor( aEvent.GetRow() );
 return true;
 }
 
 return false;
 }

References COL_OPTIONS, and optionsEditor().

init()

void GRID_TRICKS::init ( )

protectedinherited

Shared initialization for various ctors.

Definition at line 56 of file grid_tricks.cpp.

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

References GRIDTRICKS_FIRST_ID, GRIDTRICKS_LAST_ID, 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, GRID_TRICKS::onCharHook(), GRID_TRICKS::onGridCellLeftClick(), GRID_TRICKS::onGridCellLeftDClick(), GRID_TRICKS::onGridCellRightClick(), GRID_TRICKS::onGridLabelLeftClick(), GRID_TRICKS::onGridLabelRightClick(), GRID_TRICKS::onGridMotion(), GRID_TRICKS::onKeyDown(), GRID_TRICKS::onPopupSelection(), and GRID_TRICKS::onUpdateUI().

Referenced by GRID_TRICKS::GRID_TRICKS().

onCharHook()

void GRID_TRICKS::onCharHook ( wxKeyEvent &  event )

protectedinherited

Definition at line 417 of file grid_tricks.cpp.

{
 bool handled = false;
 
 if( ev.GetKeyCode() == WXK_RETURN && m_grid->GetGridCursorRow() == m_grid->GetNumberRows() - 1 )
 {
 if( m_grid->CommitPendingChanges() )
 {
 wxCommandEvent dummy;
 m_addHandler( dummy );
 }
 }
 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 );
}

References COL_SEP, WX_GRID::CommitPendingChanges(), dummy, GRID_TRICKS::m_addHandler, GRID_TRICKS::m_grid, GRID_TRICKS::paste_text(), and ROW_SEP.

Referenced by GRID_TRICKS::init().

onGridCellLeftClick()

void GRID_TRICKS::onGridCellLeftClick ( wxGridEvent &  event )

protectedinherited

Definition at line 168 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() )
 {
 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();
}

References GRID_TRICKS::getSelectedArea(), GRID_TRICKS::m_grid, GRID_TRICKS::m_sel_row_count, GRID_TRICKS::m_sel_row_start, GRID_TRICKS::showEditor(), and GRID_TRICKS::toggleCell().

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

onGridCellLeftDClick()

void GRID_TRICKS::onGridCellLeftDClick ( wxGridEvent &  event )

protectedinherited

Definition at line 215 of file grid_tricks.cpp.

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

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

Referenced by GRID_TRICKS::init().

onGridCellRightClick()

void GRID_TRICKS::onGridCellRightClick ( wxGridEvent &  event )

protectedinherited

Definition at line 292 of file grid_tricks.cpp.

{
 wxMenu menu;
 
 showPopupMenu( menu );
}

References GRID_TRICKS::showPopupMenu().

Referenced by GRID_TRICKS::init().

onGridLabelLeftClick()

void GRID_TRICKS::onGridLabelLeftClick ( wxGridEvent &  event )

protectedinherited

Definition at line 300 of file grid_tricks.cpp.

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

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

Referenced by GRID_TRICKS::init().

onGridLabelRightClick()

void GRID_TRICKS::onGridLabelRightClick ( wxGridEvent &  event )

protectedinherited

Definition at line 308 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 GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::init().

onGridMotion()

void GRID_TRICKS::onGridMotion ( wxMouseEvent &  event )

protectedinherited

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

References GRID_TRICKS::m_grid, and GRID_TRICKS::m_tooltipEnabled.

Referenced by GRID_TRICKS::init().

onKeyDown()

void GRID_TRICKS::onKeyDown ( wxKeyEvent &  event )

protectedinherited

Definition at line 457 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( 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 );
}

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

Referenced by GRID_TRICKS::init().

onPopupSelection()

void GRID_TRICKS::onPopupSelection ( wxCommandEvent &  event )

protectedinherited

Definition at line 368 of file grid_tricks.cpp.

{
 doPopupSelection( event );
}

References GRID_TRICKS::doPopupSelection().

Referenced by GRID_TRICKS::init().

onUpdateUI()

void GRID_TRICKS::onUpdateUI ( wxUpdateUIEvent &  event )

protectedinherited

Definition at line 790 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 GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::init().

optionsEditor()

void FP_GRID_TRICKS::optionsEditor ( int  aRow )

inlineprotected

Definition at line 260 of file panel_fp_lib_table.cpp.

 {
 FP_LIB_TABLE_GRID* tbl = (FP_LIB_TABLE_GRID*) m_grid->GetTable();
 
 if( tbl->GetNumberRows() > aRow )
 {
 LIB_TABLE_ROW* row = tbl->at( (size_t) aRow );
 const wxString& options = row->GetOptions();
 wxString result = options;
 
 InvokePluginOptionsEditor( m_dialog, row->GetNickName(), row->GetType(), options,
 &result );
 
 if( options != result )
 {
 row->SetOptions( result );
 m_grid->Refresh();
 }
 }
 }

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

Referenced by doPopupSelection(), and handleDoubleClick().

paste_clipboard()

void GRID_TRICKS::paste_clipboard ( )

protectedvirtualinherited

Definition at line 625 of file grid_tricks.cpp.

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

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

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

paste_text()

void FP_GRID_TRICKS::paste_text ( const wxString &  cb_text )

inlineoverrideprotectedvirtual

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

Reimplemented from GRID_TRICKS.

Definition at line 313 of file panel_fp_lib_table.cpp.

 {
 FP_LIB_TABLE_GRID* tbl = (FP_LIB_TABLE_GRID*) m_grid->GetTable();
 size_t ndx = cb_text.find( "(fp_lib_table" );
 
 if( ndx != std::string::npos )
 {
 // paste the FP_LIB_TABLE_ROWs of s-expression (fp_lib_table), starting
 // at column 0 regardless of current cursor column.
 
 STRING_LINE_READER slr( TO_UTF8( cb_text ), wxT( "Clipboard" ) );
 LIB_TABLE_LEXER lexer( &slr );
 FP_LIB_TABLE tmp_tbl;
 bool parsed = true;
 
 try
 {
 tmp_tbl.Parse( &lexer );
 }
 catch( PARSE_ERROR& pe )
 {
 DisplayError( m_dialog, pe.What() );
 parsed = false;
 }
 
 if( parsed )
 {
 // make sure the table is big enough...
 if( tmp_tbl.GetCount() > (unsigned) tbl->GetNumberRows() )
 tbl->AppendRows( tmp_tbl.GetCount() - tbl->GetNumberRows() );
 
 for( unsigned i = 0; i < tmp_tbl.GetCount(); ++i )
 tbl->m_rows.replace( i, tmp_tbl.At( i ).clone() );
 }
 
 m_grid->AutoSizeColumns( false );
 }
 else
 {
 // paste spreadsheet formatted text.
 GRID_TRICKS::paste_text( cb_text );
 
 m_grid->AutoSizeColumns( false );
 }
 }

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, LIB_TABLE::m_rows, FP_LIB_TABLE::Parse(), GRID_TRICKS::paste_text(), TO_UTF8, and IO_ERROR::What().

SetTooltipEnable()

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

inlineinherited

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 75 of file grid_tricks.h.

 {
 m_tooltipEnabled[aCol] = aEnable;
 }

References GRID_TRICKS::m_tooltipEnabled.

Referenced by PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL().

showEditor()

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

protectedinherited

Definition at line 133 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 GRID_TRICKS::m_grid, and WX_GRID::ShowEditorOnMouseUp().

Referenced by GRID_TRICKS::onGridCellLeftClick().

showPopupMenu()

void FP_GRID_TRICKS::showPopupMenu ( wxMenu &  menu )

inlineoverrideprotectedvirtual

Reimplemented from LIB_TABLE_GRID_TRICKS.

Definition at line 292 of file panel_fp_lib_table.cpp.

 {
 if( m_grid->GetGridCursorCol() == COL_OPTIONS )
 {
 menu.Append( MYID_OPTIONS_EDITOR, _( "Options Editor..." ), _( "Edit options" ) );
 menu.AppendSeparator();
 }
 
 LIB_TABLE_GRID_TRICKS::showPopupMenu( menu );
 }

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

toggleCell()

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

protectedinherited

Definition at line 89 of file grid_tricks.cpp.

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

References GRID_TRICKS::m_grid.

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

Member Data Documentation

m_addHandler

std::function<void( wxCommandEvent& )> GRID_TRICKS::m_addHandler

protectedinherited

Definition at line 130 of file grid_tricks.h.

Referenced by GRID_TRICKS::onCharHook().

m_dialog

DIALOG_EDIT_LIBRARY_TABLES* FP_GRID_TRICKS::m_dialog

protected

Definition at line 258 of file panel_fp_lib_table.cpp.

Referenced by optionsEditor(), and paste_text().

m_grid

WX_GRID* GRID_TRICKS::m_grid

protectedinherited

I don't own the grid, but he owns me.

Definition at line 121 of file grid_tricks.h.

Referenced by GRID_TRICKS::cutcopy(), GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), LIB_TABLE_GRID_TRICKS::doPopupSelection(), doPopupSelection(), GRID_TRICKS::getSelectedArea(), GRID_TRICKS::init(), GRID_TRICKS::onCharHook(), GRID_TRICKS::onGridCellLeftClick(), GRID_TRICKS::onGridLabelLeftClick(), GRID_TRICKS::onGridLabelRightClick(), GRID_TRICKS::onGridMotion(), GRID_TRICKS::onKeyDown(), GRID_TRICKS::onUpdateUI(), optionsEditor(), GRID_TRICKS::paste_clipboard(), GRID_TRICKS::paste_text(), SYMBOL_GRID_TRICKS::paste_text(), paste_text(), GRID_TRICKS::showEditor(), GRID_TRICKS::showPopupMenu(), FIELDS_EDITOR_GRID_TRICKS::showPopupMenu(), FIELDS_GRID_TRICKS::showPopupMenu(), LIB_TABLE_GRID_TRICKS::showPopupMenu(), showPopupMenu(), and GRID_TRICKS::toggleCell().

m_sel_col_count

int GRID_TRICKS::m_sel_col_count

protectedinherited

Definition at line 128 of file grid_tricks.h.

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

m_sel_col_start

int GRID_TRICKS::m_sel_col_start

protectedinherited

Definition at line 126 of file grid_tricks.h.

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

m_sel_row_count

int GRID_TRICKS::m_sel_row_count

protectedinherited

Definition at line 127 of file grid_tricks.h.

Referenced by GRID_TRICKS::cutcopy(), LIB_TABLE_GRID_TRICKS::doPopupSelection(), GRID_TRICKS::getSelectedArea(), GRID_TRICKS::init(), GRID_TRICKS::onGridCellLeftClick(), GRID_TRICKS::paste_text(), GRID_TRICKS::showPopupMenu(), and LIB_TABLE_GRID_TRICKS::showPopupMenu().

m_sel_row_start

int GRID_TRICKS::m_sel_row_start

protectedinherited

Definition at line 125 of file grid_tricks.h.

Referenced by GRID_TRICKS::cutcopy(), LIB_TABLE_GRID_TRICKS::doPopupSelection(), GRID_TRICKS::getSelectedArea(), GRID_TRICKS::init(), GRID_TRICKS::onGridCellLeftClick(), GRID_TRICKS::paste_text(), and LIB_TABLE_GRID_TRICKS::showPopupMenu().

m_tooltipEnabled

std::bitset<GRIDTRICKS_MAX_COL> GRID_TRICKS::m_tooltipEnabled

protectedinherited

Definition at line 132 of file grid_tricks.h.

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

---

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

• panel_fp_lib_table.cpp