#include <lib_table_grid_tricks.h>

Inheritance diagram for LIB_TABLE_GRID_TRICKS:

Public Member Functions
	LIB_TABLE_GRID_TRICKS (WX_GRID *aGrid)

virtual	~LIB_TABLE_GRID_TRICKS ()

void	showPopupMenu (wxMenu &menu, wxGridEvent &aEvent) override

void	doPopupSelection (wxCommandEvent &event) override

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
virtual void	optionsEditor (int aRow)=0

bool	handleDoubleClick (wxGridEvent &aEvent) override

virtual bool	supportsVisibilityColumn ()

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)

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_GRID *	m_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_COL >	m_tooltipEnabled

Private Types
enum	{ LIB_TABLE_GRID_TRICKS_ACTIVATE_SELECTED = GRIDTRICKS_FIRST_CLIENT_ID , LIB_TABLE_GRID_TRICKS_DEACTIVATE_SELECTED , LIB_TABLE_GRID_TRICKS_SET_VISIBLE , LIB_TABLE_GRID_TRICKS_UNSET_VISIBLE , LIB_TABLE_GRID_TRICKS_LIBRARY_SETTINGS , LIB_TABLE_GRID_TRICKS_OPTIONS_EDITOR }

Detailed Description

Definition at line 22 of file lib_table_grid_tricks.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
LIB_TABLE_GRID_TRICKS_ACTIVATE_SELECTED
LIB_TABLE_GRID_TRICKS_DEACTIVATE_SELECTED
LIB_TABLE_GRID_TRICKS_SET_VISIBLE
LIB_TABLE_GRID_TRICKS_UNSET_VISIBLE
LIB_TABLE_GRID_TRICKS_LIBRARY_SETTINGS
LIB_TABLE_GRID_TRICKS_OPTIONS_EDITOR

Definition at line 24 of file lib_table_grid_tricks.h.

Constructor & Destructor Documentation

◆ LIB_TABLE_GRID_TRICKS()

LIB_TABLE_GRID_TRICKS::LIB_TABLE_GRID_TRICKS ( WX_GRID * aGrid )

explicit

Definition at line 24 of file lib_table_grid_tricks.cpp.

◆ ~LIB_TABLE_GRID_TRICKS()

virtual LIB_TABLE_GRID_TRICKS::~LIB_TABLE_GRID_TRICKS ( )

inlinevirtual

Definition at line 37 of file lib_table_grid_tricks.h.

Member Function Documentation

◆ cutcopy()

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

protectedvirtualinherited

Definition at line 829 of file grid_tricks.cpp.

References COL_SEP, GRID_TRICKS::isReadOnly(), GRID_TRICKS::isTextEntry(), 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 LIB_TABLE_GRID_TRICKS::doPopupSelection ( wxCommandEvent & event )

overridevirtual

Reimplemented from GRID_TRICKS.

Definition at line 95 of file lib_table_grid_tricks.cpp.

References LIB_TABLE_GRID::At(), GRID_TRICKS::doPopupSelection(), LIB_TABLE_GRID_TRICKS_ACTIVATE_SELECTED, LIB_TABLE_GRID_TRICKS_DEACTIVATE_SELECTED, LIB_TABLE_GRID_TRICKS_LIBRARY_SETTINGS, LIB_TABLE_GRID_TRICKS_OPTIONS_EDITOR, LIB_TABLE_GRID_TRICKS_SET_VISIBLE, LIB_TABLE_GRID_TRICKS_UNSET_VISIBLE, GRID_TRICKS::m_grid, GRID_TRICKS::m_sel_row_count, GRID_TRICKS::m_sel_row_start, optionsEditor(), LIB_TABLE_ROW::Refresh(), LIB_TABLE_GRID::SetValueAsBool(), and LIB_TABLE_ROW::ShowSettingsDialog().

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

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(), GRID_TRICKS::showPopupMenu(), and 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.

References GRID_TRICKS::m_tooltipEnabled.

◆ handleDoubleClick()

bool LIB_TABLE_GRID_TRICKS::handleDoubleClick ( wxGridEvent & aEvent )

overrideprotectedvirtual

Reimplemented from GRID_TRICKS.

Definition at line 139 of file lib_table_grid_tricks.cpp.

References COL_OPTIONS, and optionsEditor().

◆ init()

void GRID_TRICKS::init ( )

protectedinherited

Shared initialization for various ctors.

Definition at line 58 of file grid_tricks.cpp.

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().

◆ isCheckbox()

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

protectedinherited

Definition at line 102 of file grid_tricks.cpp.

References GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::toggleCell().

◆ isReadOnly()

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

protectedinherited

Definition at line 112 of file grid_tricks.cpp.

References GRID_TRICKS::m_grid.

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

◆ isTextEntry()

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

protectedinherited

Definition at line 91 of file grid_tricks.cpp.

References editor, and GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::cutcopy(), and GRID_TRICKS::showPopupMenu().

◆ onCharHook()

void GRID_TRICKS::onCharHook ( wxKeyEvent & event )

protectedinherited

Definition at line 461 of file grid_tricks.cpp.

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

Referenced by GRID_TRICKS::init().

◆ onGridCellLeftClick()

void GRID_TRICKS::onGridCellLeftClick ( wxGridEvent & event )

protectedinherited

Definition at line 198 of file grid_tricks.cpp.

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

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

Referenced by GRID_TRICKS::init().

◆ onGridCellRightClick()

void GRID_TRICKS::onGridCellRightClick ( wxGridEvent & event )

protectedinherited

Definition at line 322 of file grid_tricks.cpp.

References GRID_TRICKS::showPopupMenu().

Referenced by GRID_TRICKS::init().

◆ onGridLabelLeftClick()

void GRID_TRICKS::onGridLabelLeftClick ( wxGridEvent & event )

protectedinherited

Definition at line 330 of file grid_tricks.cpp.

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

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

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

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

References GRID_TRICKS::doPopupSelection().

Referenced by GRID_TRICKS::init().

◆ onUpdateUI()

void GRID_TRICKS::onUpdateUI ( wxUpdateUIEvent & event )

protectedinherited

Definition at line 876 of file grid_tricks.cpp.

References GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::init().

◆ optionsEditor()

virtual void LIB_TABLE_GRID_TRICKS::optionsEditor ( int aRow )

protectedpure virtual

Implemented in DESIGN_BLOCK_GRID_TRICKS, SYMBOL_GRID_TRICKS, and FP_GRID_TRICKS.

Referenced by doPopupSelection(), and handleDoubleClick().

◆ paste_clipboard()

void GRID_TRICKS::paste_clipboard ( )

protectedvirtualinherited

Definition at line 684 of file grid_tricks.cpp.

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

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

◆ paste_text()

void GRID_TRICKS::paste_text ( const wxString & cb_text )

protectedvirtualinherited

Reimplemented in DESIGN_BLOCK_GRID_TRICKS, SYMBOL_GRID_TRICKS, and FP_GRID_TRICKS.

Definition at line 713 of file grid_tricks.cpp.

References COL_SEP, dummy, GRID_TRICKS::isReadOnly(), GRID_TRICKS::m_addHandler, 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::onCharHook(), GRID_TRICKS::paste_clipboard(), DESIGN_BLOCK_GRID_TRICKS::paste_text(), SYMBOL_GRID_TRICKS::paste_text(), and FP_GRID_TRICKS::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

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

Definition at line 75 of file grid_tricks.h.

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

References GRID_TRICKS::isReadOnly(), 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 WX_GRID::ShowEditorOnMouseUp().

Referenced by GRID_TRICKS::onGridCellLeftClick().

◆ showPopupMenu()

void LIB_TABLE_GRID_TRICKS::showPopupMenu	(	wxMenu &	menu,
		wxGridEvent &	aEvent
	)

overridevirtual

◆ supportsVisibilityColumn()

virtual bool LIB_TABLE_GRID_TRICKS::supportsVisibilityColumn ( )

inlineprotectedvirtual

Reimplemented in SYMBOL_GRID_TRICKS.

Definition at line 46 of file lib_table_grid_tricks.h.

Referenced by showPopupMenu().

◆ toggleCell()

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

protectedvirtualinherited

Reimplemented in FP_GRID_TRICKS.

Definition at line 118 of file grid_tricks.cpp.

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

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

Member Data Documentation

◆ m_addHandler

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

protectedinherited

Definition at line 134 of file grid_tricks.h.

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

◆ m_grid

WX_GRID* GRID_TRICKS::m_grid

protectedinherited

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

Definition at line 125 of file grid_tricks.h.

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

◆ m_sel_col_count

int GRID_TRICKS::m_sel_col_count

protectedinherited

Definition at line 132 of file grid_tricks.h.

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

◆ m_sel_col_start

int GRID_TRICKS::m_sel_col_start

protectedinherited

Definition at line 130 of file grid_tricks.h.

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

◆ m_sel_row_count

int GRID_TRICKS::m_sel_row_count

protectedinherited

Definition at line 131 of file grid_tricks.h.

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

◆ m_sel_row_start

int GRID_TRICKS::m_sel_row_start

protectedinherited

Definition at line 129 of file grid_tricks.h.

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

◆ m_tooltipEnabled

std::bitset<GRIDTRICKS_MAX_COL> GRID_TRICKS::m_tooltipEnabled

protectedinherited

Definition at line 136 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 files:

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ LIB_TABLE_GRID_TRICKS()

◆ ~LIB_TABLE_GRID_TRICKS()

Member Function Documentation

◆ cutcopy()

◆ doPopupSelection()

◆ getSelectedArea()

◆ GetTooltipEnabled()

◆ handleDoubleClick()

◆ init()

◆ isCheckbox()

◆ isReadOnly()

◆ isTextEntry()

◆ onCharHook()

◆ onGridCellLeftClick()

◆ onGridCellLeftDClick()

◆ onGridCellRightClick()

◆ onGridLabelLeftClick()

◆ onGridLabelRightClick()

◆ onGridMotion()

◆ onKeyDown()

◆ onPopupSelection()

◆ onUpdateUI()

◆ optionsEditor()

◆ paste_clipboard()

◆ paste_text()

◆ SetTooltipEnable()

◆ showEditor()

◆ showPopupMenu()

◆ supportsVisibilityColumn()

◆ toggleCell()

Member Data Documentation

◆ m_addHandler

◆ m_grid

◆ m_sel_col_count

◆ m_sel_col_start

◆ m_sel_row_count

◆ m_sel_row_start

◆ m_tooltipEnabled