KiCad PCB EDA Suite
Loading...
Searching...
No Matches
PLUGINS_GRID_TRICKS Class Reference
Inheritance diagram for PLUGINS_GRID_TRICKS:
GRID_TRICKS

Public Member Functions

 PLUGINS_GRID_TRICKS (WX_GRID *aGrid)
 
void SetTooltipEnable (int aCol, bool aEnable=true)
 Enable the tooltip for a column.
 
bool GetTooltipEnabled (int aCol)
 Query if the tooltip for a column is enabled.
 

Protected Member Functions

void showPopupMenu (wxMenu &menu, wxGridEvent &aEvent) override
 
void doPopupSelection (wxCommandEvent &event) override
 
void init ()
 Shared initialization for various ctors.
 
void getSelectedArea ()
 Puts the selected area into a sensible rectangle of m_sel_{row,col}_{start,count} above.
 
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)
 
virtual bool handleDoubleClick (wxGridEvent &aEvent)
 
bool isTextEntry (int aRow, int aCol)
 
bool isCheckbox (int aRow, int aCol)
 
bool isReadOnly (int aRow, int aCol)
 
virtual 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_GRIDm_grid
 I don't own the grid, but he owns me.
 
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_COLm_tooltipEnabled
 
bool m_enableSingleClickEdit
 
bool m_multiCellEditEnabled
 

Detailed Description

Definition at line 48 of file panel_pcbnew_action_plugins.cpp.

Constructor & Destructor Documentation

◆ PLUGINS_GRID_TRICKS()

PLUGINS_GRID_TRICKS::PLUGINS_GRID_TRICKS ( WX_GRID * aGrid)
inline

Definition at line 51 of file panel_pcbnew_action_plugins.cpp.

References GRID_TRICKS::GRID_TRICKS().

Member Function Documentation

◆ cutcopy()

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

◆ doPopupSelection()

void PLUGINS_GRID_TRICKS::doPopupSelection ( wxCommandEvent & event)
overrideprotectedvirtual

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

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

Referenced by LIB_TABLE_GRID_TRICKS::onCharHook(), onGridCellLeftClick(), onKeyDown(), FP_GRID_TRICKS::paste_text(), SYMBOL_GRID_TRICKS::paste_text(), showPopupMenu(), and LIB_TABLE_GRID_TRICKS::showPopupMenu().

◆ GetTooltipEnabled()

bool GRID_TRICKS::GetTooltipEnabled ( int aCol)
inlineinherited

Query if the tooltip for a column is enabled.

Parameters
aColis the column to query
Returns
if the tooltip is enabled for the column

Definition at line 86 of file grid_tricks.h.

References m_tooltipEnabled.

◆ handleDoubleClick()

bool GRID_TRICKS::handleDoubleClick ( wxGridEvent & aEvent)
protectedvirtualinherited

Reimplemented in JOBS_GRID_TRICKS, and LIB_TABLE_GRID_TRICKS.

Definition at line 281 of file grid_tricks.cpp.

Referenced by onGridCellLeftDClick().

◆ init()

◆ isCheckbox()

bool GRID_TRICKS::isCheckbox ( int aRow,
int aCol )
protectedinherited

Definition at line 106 of file grid_tricks.cpp.

References m_grid.

Referenced by toggleCell().

◆ isReadOnly()

bool GRID_TRICKS::isReadOnly ( int aRow,
int aCol )
protectedinherited

Definition at line 116 of file grid_tricks.cpp.

References m_grid.

Referenced by cutcopy(), paste_text(), showEditor(), and showPopupMenu().

◆ isTextEntry()

bool GRID_TRICKS::isTextEntry ( int aRow,
int aCol )
protectedinherited

Definition at line 95 of file grid_tricks.cpp.

References editor, and m_grid.

Referenced by cutcopy(), and showPopupMenu().

◆ onCharHook()

void GRID_TRICKS::onCharHook ( wxKeyEvent & event)
protectedinherited

Definition at line 473 of file grid_tricks.cpp.

References COL_SEP, dummy, m_addHandler, m_grid, paste_text(), ROW_SEP, and ROW_SEP_R.

Referenced by init(), and LIB_TABLE_GRID_TRICKS::onCharHook().

◆ onGridCellLeftClick()

void GRID_TRICKS::onGridCellLeftClick ( wxGridEvent & event)
protectedinherited

◆ onGridCellLeftDClick()

void GRID_TRICKS::onGridCellLeftDClick ( wxGridEvent & event)
protectedinherited

Definition at line 251 of file grid_tricks.cpp.

References handleDoubleClick(), and onGridCellLeftClick().

Referenced by init().

◆ onGridCellRightClick()

void GRID_TRICKS::onGridCellRightClick ( wxGridEvent & event)
protectedinherited

Definition at line 328 of file grid_tricks.cpp.

References showPopupMenu().

Referenced by init().

◆ onGridLabelLeftClick()

void GRID_TRICKS::onGridLabelLeftClick ( wxGridEvent & event)
protectedinherited

Definition at line 336 of file grid_tricks.cpp.

References m_grid.

Referenced by init().

◆ onGridLabelRightClick()

void GRID_TRICKS::onGridLabelRightClick ( wxGridEvent & event)
protectedinherited

Definition at line 344 of file grid_tricks.cpp.

References GRIDTRICKS_FIRST_SHOWHIDE, and m_grid.

Referenced by init().

◆ onGridMotion()

void GRID_TRICKS::onGridMotion ( wxMouseEvent & event)
protectedinherited

Definition at line 258 of file grid_tricks.cpp.

References m_grid, and m_tooltipEnabled.

Referenced by init().

◆ onKeyDown()

void GRID_TRICKS::onKeyDown ( wxKeyEvent & event)
protectedinherited

Definition at line 540 of file grid_tricks.cpp.

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

Referenced by init(), and SCINTILLA_TRICKS::onCharHook().

◆ onPopupSelection()

void GRID_TRICKS::onPopupSelection ( wxCommandEvent & event)
protectedinherited

Definition at line 424 of file grid_tricks.cpp.

References doPopupSelection().

Referenced by init().

◆ onUpdateUI()

void GRID_TRICKS::onUpdateUI ( wxUpdateUIEvent & event)
protectedinherited

Definition at line 894 of file grid_tricks.cpp.

References m_grid.

Referenced by init().

◆ paste_clipboard()

void GRID_TRICKS::paste_clipboard ( )
protectedvirtualinherited

Definition at line 698 of file grid_tricks.cpp.

References m_grid, paste_text(), and text.

Referenced by doPopupSelection(), and onKeyDown().

◆ paste_text()

◆ 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
aColis the column to use
aEnableis true to enable the tooltip (default)

Definition at line 75 of file grid_tricks.h.

References m_tooltipEnabled.

Referenced by PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL().

◆ showEditor()

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

◆ showPopupMenu()

void PLUGINS_GRID_TRICKS::showPopupMenu ( wxMenu & menu,
wxGridEvent & aEvent )
overrideprotectedvirtual

◆ toggleCell()

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

Reimplemented in FP_GRID_TRICKS.

Definition at line 122 of file grid_tricks.cpp.

References isCheckbox(), and m_grid.

Referenced by onGridCellLeftClick(), onKeyDown(), and FP_GRID_TRICKS::toggleCell().

Member Data Documentation

◆ m_addHandler

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

Definition at line 137 of file grid_tricks.h.

Referenced by GRID_TRICKS(), GRID_TRICKS(), onCharHook(), and paste_text().

◆ m_enableSingleClickEdit

bool GRID_TRICKS::m_enableSingleClickEdit
protectedinherited

◆ m_grid

WX_GRID* GRID_TRICKS::m_grid
protectedinherited

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

Definition at line 128 of file grid_tricks.h.

Referenced by cutcopy(), CURSORS_GRID_TRICKS::doPopupSelection(), EMBEDDED_FILES_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), doPopupSelection(), JOBS_GRID_TRICKS::doPopupSelection(), LIB_FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), LIB_TABLE_GRID_TRICKS::doPopupSelection(), MEASUREMENTS_GRID_TRICKS::doPopupSelection(), PLUGINS_GRID_TRICKS::doPopupSelection(), SIGNALS_GRID_TRICKS::doPopupSelection(), VIEW_CONTROLS_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::getFieldRow(), getSelectedArea(), GRID_TRICKS(), GRID_TRICKS(), JOBS_GRID_TRICKS::handleDoubleClick(), init(), isCheckbox(), isReadOnly(), isTextEntry(), LIB_TABLE_GRID_TRICKS::LIB_TABLE_GRID_TRICKS(), LIB_TABLE_GRID_TRICKS::LIB_TABLE_GRID_TRICKS(), onCharHook(), LIB_TABLE_GRID_TRICKS::onCharHook(), onGridCellLeftClick(), onGridLabelLeftClick(), onGridLabelRightClick(), onGridMotion(), onKeyDown(), onUpdateUI(), DESIGN_BLOCK_GRID_TRICKS::optionsEditor(), FP_GRID_TRICKS::optionsEditor(), SYMBOL_GRID_TRICKS::optionsEditor(), paste_clipboard(), DESIGN_BLOCK_GRID_TRICKS::paste_text(), FP_GRID_TRICKS::paste_text(), paste_text(), SYMBOL_GRID_TRICKS::paste_text(), showEditor(), CURSORS_GRID_TRICKS::showPopupMenu(), FIELDS_EDITOR_GRID_TRICKS::showPopupMenu(), FIELDS_GRID_TRICKS::showPopupMenu(), showPopupMenu(), JOBS_GRID_TRICKS::showPopupMenu(), LIB_FIELDS_EDITOR_GRID_TRICKS::showPopupMenu(), LIB_TABLE_GRID_TRICKS::showPopupMenu(), MEASUREMENTS_GRID_TRICKS::showPopupMenu(), PLUGINS_GRID_TRICKS::showPopupMenu(), SIGNALS_GRID_TRICKS::showPopupMenu(), and toggleCell().

◆ m_multiCellEditEnabled

bool GRID_TRICKS::m_multiCellEditEnabled
protectedinherited

◆ m_sel_col_count

int GRID_TRICKS::m_sel_col_count
protectedinherited

Definition at line 135 of file grid_tricks.h.

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

◆ m_sel_col_start

int GRID_TRICKS::m_sel_col_start
protectedinherited

Definition at line 133 of file grid_tricks.h.

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

◆ m_sel_row_count

◆ m_sel_row_start

◆ m_tooltipEnabled

std::bitset<GRIDTRICKS_MAX_COL> GRID_TRICKS::m_tooltipEnabled
protectedinherited

Definition at line 139 of file grid_tricks.h.

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


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