SCH_TABLE_EDIT_TOOL and PCB_TABLE_EDIT_TOOL share most of their algorithms, which are implemented here. More...

#include <edit_table_tool_base.h>

Public Member Functions
bool	getCellBlockBounds (const SELECTION &aSel, int &aColMin, int &aColMax, int &aRowMin, int &aRowMax)
	Get the bounding box of a cell block selection.

bool	validatePasteIntoSelection (const SELECTION &aSel, wxString &aErrorMsg)
	Validate if paste-into-cells is possible for the given selection.

bool	pasteCellsIntoSelection (const SELECTION &aSel, T_TABLE *aSourceTable, T_COMMIT &aCommit)
	Paste text content from source table into selected cells.

virtual TOOL_MANAGER *	getToolMgr ()=0

virtual BASE_SCREEN *	getScreen ()=0

virtual const SELECTION &	getTableCellSelection ()=0

virtual void	clearSelection ()=0

virtual T_TABLECELL *	copyCell (T_TABLECELL *aSource)=0

Protected Member Functions
void	addMenus (CONDITIONAL_MENU &selToolMenu)

int	doAddRowAbove (const TOOL_EVENT &aEvent)

int	doAddRowBelow (const TOOL_EVENT &aEvent)

int	doAddColumnBefore (const TOOL_EVENT &aEvent)

int	doAddColumnAfter (const TOOL_EVENT &aEvent)

int	doDeleteRows (const TOOL_EVENT &aEvent)

int	doDeleteColumns (const TOOL_EVENT &aEvent)

int	doMergeCells (const TOOL_EVENT &aEvent)

int	doUnmergeCells (const TOOL_EVENT &aEvent)

Detailed Description

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>
class EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >

SCH_TABLE_EDIT_TOOL and PCB_TABLE_EDIT_TOOL share most of their algorithms, which are implemented here.

Definition at line 42 of file edit_table_tool_base.h.

Member Function Documentation

◆ addMenus()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

void EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::addMenus ( CONDITIONAL_MENU & selToolMenu )

inlineprotected

Definition at line 45 of file edit_table_tool_base.h.

References ACTIONS::addColAfter, ACTIONS::addColBefore, CONDITIONAL_MENU::AddItem(), ACTIONS::addRowAbove, ACTIONS::addRowBelow, CONDITIONAL_MENU::AddSeparator(), ACTIONS::deleteColumns, ACTIONS::deleteRows, ACTIONS::editTable, ACTIONS::exportTableCSV, SELECTION_CONDITIONS::Idle(), ACTIONS::mergeCells, SELECTION_CONDITIONS::MoreThan(), SELECTION_CONDITIONS::OnlyTypes(), PCB_TABLECELL_T, SCH_TABLECELL_T, and ACTIONS::unmergeCells.

◆ clearSelection()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

virtual void EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::clearSelection ( )

pure virtual

Implemented in PCB_EDIT_TABLE_TOOL, and SCH_EDIT_TABLE_TOOL.

Referenced by doDeleteColumns(), and doDeleteRows().

◆ copyCell()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

virtual T_TABLECELL * EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::copyCell ( T_TABLECELL * aSource )

pure virtual

Implemented in PCB_EDIT_TABLE_TOOL, and SCH_EDIT_TABLE_TOOL.

Referenced by doAddColumnAfter(), doAddColumnBefore(), doAddRowAbove(), doAddRowBelow(), and pasteCellsIntoSelection().

◆ doAddColumnAfter()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

int EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::doAddColumnAfter ( const TOOL_EVENT & aEvent )

inlineprotected

Definition at line 269 of file edit_table_tool_base.h.

References _, copyCell(), getScreen(), getTableCellSelection(), getToolMgr(), TOOL_MANAGER::PostEvent(), EVENTS::SelectedEvent, and table.

◆ doAddColumnBefore()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

int EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::doAddColumnBefore ( const TOOL_EVENT & aEvent )

inlineprotected

Definition at line 218 of file edit_table_tool_base.h.

References _, copyCell(), getScreen(), getTableCellSelection(), getToolMgr(), TOOL_MANAGER::PostEvent(), EVENTS::SelectedEvent, and table.

◆ doAddRowAbove()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

int EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::doAddRowAbove ( const TOOL_EVENT & aEvent )

inlineprotected

Definition at line 117 of file edit_table_tool_base.h.

References _, copyCell(), getScreen(), getTableCellSelection(), getToolMgr(), TOOL_MANAGER::PostEvent(), EVENTS::SelectedEvent, and table.

◆ doAddRowBelow()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

int EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::doAddRowBelow ( const TOOL_EVENT & aEvent )

inlineprotected

Definition at line 166 of file edit_table_tool_base.h.

References _, copyCell(), SELECTION::Empty(), getScreen(), getTableCellSelection(), getToolMgr(), TOOL_MANAGER::PostEvent(), EVENTS::SelectedEvent, and table.

◆ doDeleteColumns()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

int EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::doDeleteColumns ( const TOOL_EVENT & aEvent )

inlineprotected

Definition at line 404 of file edit_table_tool_base.h.

References _, clearSelection(), SELECTION::Empty(), getScreen(), getTableCellSelection(), getToolMgr(), TOOL_MANAGER::PostEvent(), EVENTS::SelectedEvent, STRUCT_DELETED, and table.

◆ doDeleteRows()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

int EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::doDeleteRows ( const TOOL_EVENT & aEvent )

inlineprotected

Definition at line 320 of file edit_table_tool_base.h.

References _, clearSelection(), SELECTION::Empty(), getScreen(), getTableCellSelection(), getToolMgr(), TOOL_MANAGER::PostEvent(), EVENTS::SelectedEvent, STRUCT_DELETED, and table.

◆ doMergeCells()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

int EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::doMergeCells ( const TOOL_EVENT & aEvent )

inlineprotected

Definition at line 482 of file edit_table_tool_base.h.

References _, SELECTION::Empty(), getScreen(), getTableCellSelection(), getToolMgr(), TOOL_MANAGER::PostEvent(), EVENTS::SelectedEvent, table, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ doUnmergeCells()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

int EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::doUnmergeCells ( const TOOL_EVENT & aEvent )

inlineprotected

Definition at line 551 of file edit_table_tool_base.h.

References _, SELECTION::Empty(), getScreen(), getTableCellSelection(), getToolMgr(), TOOL_MANAGER::PostEvent(), EVENTS::SelectedEvent, and table.

◆ getCellBlockBounds()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

bool EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::getCellBlockBounds	(	const SELECTION &	aSel,
		int &	aColMin,
		int &	aColMax,
		int &	aRowMin,
		int &	aRowMax )

inline

Get the bounding box of a cell block selection.

Parameters

aSel	The selection to analyze
aColMin	Output: minimum column index
aColMax	Output: maximum column index (exclusive)
aRowMin	Output: minimum row index
aRowMax	Output: maximum row index (exclusive)

Returns: true if selection forms a valid contiguous block, false otherwise

Definition at line 602 of file edit_table_tool_base.h.

References SELECTION::Size().

Referenced by pasteCellsIntoSelection(), and validatePasteIntoSelection().

◆ getScreen()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

virtual BASE_SCREEN * EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::getScreen ( )

pure virtual

Implemented in PCB_EDIT_TABLE_TOOL, and SCH_EDIT_TABLE_TOOL.

Referenced by doAddColumnAfter(), doAddColumnBefore(), doAddRowAbove(), doAddRowBelow(), doDeleteColumns(), doDeleteRows(), doMergeCells(), doUnmergeCells(), and pasteCellsIntoSelection().

◆ getTableCellSelection()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

virtual const SELECTION & EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::getTableCellSelection ( )

pure virtual

Implemented in PCB_EDIT_TABLE_TOOL, and SCH_EDIT_TABLE_TOOL.

Referenced by doAddColumnAfter(), doAddColumnBefore(), doAddRowAbove(), doAddRowBelow(), doDeleteColumns(), doDeleteRows(), doMergeCells(), and doUnmergeCells().

◆ getToolMgr()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

virtual TOOL_MANAGER * EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::getToolMgr ( )

pure virtual

Implemented in PCB_EDIT_TABLE_TOOL, and SCH_EDIT_TABLE_TOOL.

Referenced by doAddColumnAfter(), doAddColumnBefore(), doAddRowAbove(), doAddRowBelow(), doDeleteColumns(), doDeleteRows(), doMergeCells(), and doUnmergeCells().

◆ pasteCellsIntoSelection()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

bool EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::pasteCellsIntoSelection	(	const SELECTION &	aSel,
		T_TABLE *	aSourceTable,
		T_COMMIT &	aCommit )

inline

Paste text content from source table into selected cells.

Parameters

aSel	The target cell selection
aSourceTable	The table containing cells to paste
aCommit	The commit object for tracking changes

Returns: true if paste succeeded, false otherwise

Definition at line 697 of file edit_table_tool_base.h.

References copyCell(), SELECTION::Empty(), getCellBlockBounds(), and getScreen().

Referenced by PCB_CONTROL::Paste(), and SCH_EDITOR_CONTROL::Paste().

◆ validatePasteIntoSelection()

template<typename T_TABLE, typename T_TABLECELL, typename T_COMMIT>

bool EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::validatePasteIntoSelection	(	const SELECTION &	aSel,
		wxString &	aErrorMsg )

inline

Validate if paste-into-cells is possible for the given selection.

Parameters

aSel	The target cell selection
aErrorMsg	Output: error message if validation fails

Returns: true if paste-into is valid, false otherwise

Definition at line 639 of file edit_table_tool_base.h.

References _, SELECTION::Empty(), getCellBlockBounds(), and table.

Referenced by PCB_CONTROL::Paste(), and SCH_EDITOR_CONTROL::Paste().

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

edit_table_tool_base.h

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ addMenus()

◆ clearSelection()

◆ copyCell()

◆ doAddColumnAfter()

◆ doAddColumnBefore()

◆ doAddRowAbove()

◆ doAddRowBelow()

◆ doDeleteColumns()

◆ doDeleteRows()

◆ doMergeCells()

◆ doUnmergeCells()

◆ getCellBlockBounds()

◆ getScreen()

◆ getTableCellSelection()

◆ getToolMgr()

◆ pasteCellsIntoSelection()

◆ validatePasteIntoSelection()