KiCad PCB EDA Suite: DESIGN_BLOCK_LIB_TABLE_GRID Class Reference

KiCad PCB EDA Suite

Loading...

Searching...

No Matches

This class builds a wxGridTableBase by wrapping an #DESIGN_BLOCK_LIB_TABLE object. More...

Inheritance diagram for DESIGN_BLOCK_LIB_TABLE_GRID:

Public Member Functions
	DESIGN_BLOCK_LIB_TABLE_GRID (const LIBRARY_TABLE &aTableToEdit)

void	SetValue (int aRow, int aCol, const wxString &aValue) override

int	GetNumberRows () override

int	GetNumberCols () override

wxString	GetValue (int aRow, int aCol) override

bool	CanGetValueAs (int aRow, int aCol, const wxString &aTypeName) override

bool	GetValueAsBool (int aRow, int aCol) override

void	SetValueAsBool (int aRow, int aCol, bool aValue) override

bool	IsEmptyCell (int aRow, int aCol) override

bool	InsertRows (size_t aPos=0, size_t aNumRows=1) override

bool	AppendRows (size_t aNumRows=1) override

bool	DeleteRows (size_t aPos, size_t aNumRows) override

wxString	GetColLabelValue (int aCol) override

bool	ContainsNickname (const wxString &aNickname)

LIBRARY_TABLE_ROW &	At (size_t aIndex)

LIBRARY_TABLE &	Table ()

LIBRARY_MANAGER_ADAPTER *	Adapter () const

Protected Member Functions
virtual LIBRARY_TABLE_ROW &	at (size_t aIndex)

virtual size_t	size () const

virtual LIBRARY_TABLE_ROW	makeNewRow ()

virtual LIBRARY_TABLE_ROWS_ITER	begin ()

virtual LIBRARY_TABLE_ROWS_ITER	insert (LIBRARY_TABLE_ROWS_ITER aIterator, const LIBRARY_TABLE_ROW &aRow)

virtual void	push_back (const LIBRARY_TABLE_ROW &aRow)

virtual LIBRARY_TABLE_ROWS_ITER	erase (LIBRARY_TABLE_ROWS_ITER aFirst, LIBRARY_TABLE_ROWS_ITER aLast)

Protected Attributes
LIBRARY_TABLE	m_table
	Working copy of a table.

LIBRARY_MANAGER_ADAPTER *	m_adapter
	Handle to the adapter for the type of table this grid represents (may be null)

Friends
class	PANEL_DESIGN_BLOCK_LIB_TABLE

class	DESIGN_BLOCK_GRID_TRICKS

Detailed Description

This class builds a wxGridTableBase by wrapping an #DESIGN_BLOCK_LIB_TABLE object.

Definition at line 148 of file panel_design_block_lib_table.cpp.

Constructor & Destructor Documentation

◆ DESIGN_BLOCK_LIB_TABLE_GRID()

DESIGN_BLOCK_LIB_TABLE_GRID::DESIGN_BLOCK_LIB_TABLE_GRID ( const LIBRARY_TABLE & aTableToEdit )

inline

Definition at line 154 of file panel_design_block_lib_table.cpp.

References LIB_TABLE_GRID::LIB_TABLE_GRID().

Member Function Documentation

◆ Adapter()

LIBRARY_MANAGER_ADAPTER * LIB_TABLE_GRID::Adapter ( ) const

inlineinherited

Definition at line 96 of file lib_table_grid.h.

References m_adapter.

Referenced by LIB_TABLE_GRID_TRICKS::showPopupMenu().

◆ AppendRows()

bool LIB_TABLE_GRID::AppendRows ( size_t aNumRows = 1 )

overrideinherited

Definition at line 140 of file lib_table_grid.cpp.

References makeNewRow(), and push_back().

◆ At()

LIBRARY_TABLE_ROW & LIB_TABLE_GRID::At ( size_t aIndex )

inlineinherited

Definition at line 89 of file lib_table_grid.h.

References at().

Referenced by LIB_TABLE_GRID_TRICKS::doPopupSelection().

◆ at()

LIBRARY_TABLE_ROW & LIB_TABLE_GRID::at ( size_t aIndex )

protectedvirtualinherited

Definition at line 211 of file lib_table_grid.cpp.

References m_table.

Referenced by At(), ContainsNickname(), GetValue(), GetValueAsBool(), FP_GRID_TRICKS::optionsEditor(), DESIGN_BLOCK_LIB_TABLE_GRID::SetValue(), FP_LIB_TABLE_GRID::SetValue(), SetValue(), SYMBOL_LIB_TABLE_GRID::SetValue(), and SetValueAsBool().

◆ begin()

LIBRARY_TABLE_ROWS_ITER LIB_TABLE_GRID::begin ( )

protectedvirtualinherited

Definition at line 229 of file lib_table_grid.cpp.

References m_table.

Referenced by DeleteRows(), and InsertRows().

◆ CanGetValueAs()

bool LIB_TABLE_GRID::CanGetValueAs	(	int	aRow,
		int	aCol,
		const wxString &	aTypeName )

overrideinherited

Definition at line 51 of file lib_table_grid.cpp.

References COL_ENABLED, COL_VISIBLE, and size().

◆ ContainsNickname()

bool LIB_TABLE_GRID::ContainsNickname ( const wxString & aNickname )

inherited

Definition at line 198 of file lib_table_grid.cpp.

References at(), LIBRARY_TABLE_ROW::Nickname(), and size().

◆ DeleteRows()

bool LIB_TABLE_GRID::DeleteRows	(	size_t	aPos,
		size_t	aNumRows )

overrideinherited

Definition at line 156 of file lib_table_grid.cpp.

References begin(), erase(), and size().

◆ erase()

LIBRARY_TABLE_ROWS_ITER LIB_TABLE_GRID::erase	(	LIBRARY_TABLE_ROWS_ITER	aFirst,
		LIBRARY_TABLE_ROWS_ITER	aLast )

protectedvirtualinherited

Definition at line 247 of file lib_table_grid.cpp.

References m_table.

Referenced by DeleteRows().

◆ GetColLabelValue()

wxString LIB_TABLE_GRID::GetColLabelValue ( int aCol )

overrideinherited

Definition at line 178 of file lib_table_grid.cpp.

References _, COL_DESCR, COL_ENABLED, COL_NICKNAME, COL_OPTIONS, COL_STATUS, COL_TYPE, COL_URI, and COL_VISIBLE.

◆ GetNumberCols()

int LIB_TABLE_GRID::GetNumberCols ( )

inlineoverrideinherited

Definition at line 62 of file lib_table_grid.h.

References COL_COUNT.

◆ GetNumberRows()

int LIB_TABLE_GRID::GetNumberRows ( )

inlineoverrideinherited

Definition at line 60 of file lib_table_grid.h.

References size().

Referenced by FP_GRID_TRICKS::optionsEditor().

◆ GetValue()

wxString LIB_TABLE_GRID::GetValue	(	int	aRow,
		int	aCol )

overrideinherited

Definition at line 24 of file lib_table_grid.cpp.

References at(), COL_DESCR, COL_ENABLED, COL_NICKNAME, COL_OPTIONS, COL_STATUS, COL_TYPE, COL_URI, COL_VISIBLE, LIBRARY_TABLE_ROW::Description(), LIBRARY_TABLE_ROW::Disabled(), LIBRARY_TABLE_ROW::ErrorDescription(), LIBRARY_TABLE_ROW::Hidden(), LIBRARY_TABLE_ROW::Nickname(), LIBRARY_TABLE_ROW::Options(), size(), LIBRARY_TABLE_ROW::Type(), UnescapeString(), and LIBRARY_TABLE_ROW::URI().

Referenced by IsEmptyCell(), and LIB_TABLE_GRID_TRICKS::showPopupMenu().

◆ GetValueAsBool()

bool LIB_TABLE_GRID::GetValueAsBool	(	int	aRow,
		int	aCol )

overrideinherited

Definition at line 70 of file lib_table_grid.cpp.

References at(), COL_ENABLED, COL_VISIBLE, LIBRARY_TABLE_ROW::Disabled(), LIBRARY_TABLE_ROW::Hidden(), and size().

Referenced by LIB_TABLE_GRID_TRICKS::showPopupMenu().

◆ insert()

LIBRARY_TABLE_ROWS_ITER LIB_TABLE_GRID::insert	(	LIBRARY_TABLE_ROWS_ITER	aIterator,
		const LIBRARY_TABLE_ROW &	aRow )

protectedvirtualinherited

Definition at line 235 of file lib_table_grid.cpp.

References m_table.

Referenced by InsertRows().

◆ InsertRows()

bool LIB_TABLE_GRID::InsertRows	(	size_t	aPos = 0,
		size_t	aNumRows = 1 )

overrideinherited

Definition at line 119 of file lib_table_grid.cpp.

References begin(), insert(), makeNewRow(), and size().

◆ IsEmptyCell()

bool LIB_TABLE_GRID::IsEmptyCell	(	int	aRow,
		int	aCol )

inlineoverrideinherited

Definition at line 74 of file lib_table_grid.h.

References GetValue().

◆ makeNewRow()

LIBRARY_TABLE_ROW LIB_TABLE_GRID::makeNewRow ( )

protectedvirtualinherited

Definition at line 223 of file lib_table_grid.cpp.

References m_table.

Referenced by AppendRows(), and InsertRows().

◆ push_back()

void LIB_TABLE_GRID::push_back ( const LIBRARY_TABLE_ROW & aRow )

protectedvirtualinherited

Definition at line 241 of file lib_table_grid.cpp.

References m_table.

Referenced by AppendRows().

◆ SetValue()

void DESIGN_BLOCK_LIB_TABLE_GRID::SetValue	(	int	aRow,
		int	aCol,
		const wxString &	aValue )

inlineoverride

Definition at line 159 of file panel_design_block_lib_table.cpp.

References LIB_TABLE_GRID::at(), COL_TYPE, COL_URI, LIBRARY_MANAGER::ExpandURI(), DESIGN_BLOCK_IO_MGR::FILE_TYPE_NONE, GetSettingsManager(), DESIGN_BLOCK_IO_MGR::GuessPluginTypeFromLibPath(), DESIGN_BLOCK_IO_MGR::KICAD_SEXP, Pgm(), Prj(), SetValue(), LIB_TABLE_GRID::SetValue(), DESIGN_BLOCK_IO_MGR::ShowType(), LIB_TABLE_GRID::size(), and LIBRARY_TABLE_ROW::URI().

Referenced by SetValue().

◆ SetValueAsBool()

void LIB_TABLE_GRID::SetValueAsBool	(	int	aRow,
		int	aCol,
		bool	aValue )

overrideinherited

Definition at line 107 of file lib_table_grid.cpp.

References at(), COL_ENABLED, COL_VISIBLE, LIBRARY_TABLE_ROW::SetDisabled(), LIBRARY_TABLE_ROW::SetHidden(), and size().

Referenced by LIB_TABLE_GRID_TRICKS::doPopupSelection().

◆ size()

size_t LIB_TABLE_GRID::size ( ) const

protectedvirtualinherited

Definition at line 217 of file lib_table_grid.cpp.

References m_table.

Referenced by CanGetValueAs(), ContainsNickname(), DeleteRows(), GetNumberRows(), GetValue(), GetValueAsBool(), InsertRows(), DESIGN_BLOCK_LIB_TABLE_GRID::SetValue(), FP_LIB_TABLE_GRID::SetValue(), SetValue(), SYMBOL_LIB_TABLE_GRID::SetValue(), and SetValueAsBool().

◆ Table()

LIBRARY_TABLE & LIB_TABLE_GRID::Table ( )

inlineinherited

Definition at line 94 of file lib_table_grid.h.

References m_table.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE::moveDownHandler(), PANEL_FP_LIB_TABLE::moveDownHandler(), PANEL_SYM_LIB_TABLE::moveDownHandler(), PANEL_DESIGN_BLOCK_LIB_TABLE::moveUpHandler(), PANEL_FP_LIB_TABLE::moveUpHandler(), PANEL_SYM_LIB_TABLE::moveUpHandler(), FP_GRID_TRICKS::paste_text(), SYMBOL_GRID_TRICKS::paste_text(), PANEL_DESIGN_BLOCK_LIB_TABLE::TransferDataFromWindow(), PANEL_FP_LIB_TABLE::TransferDataFromWindow(), and PANEL_SYM_LIB_TABLE::TransferDataFromWindow().

Friends And Related Symbol Documentation

◆ DESIGN_BLOCK_GRID_TRICKS

friend class DESIGN_BLOCK_GRID_TRICKS

friend

Definition at line 151 of file panel_design_block_lib_table.cpp.

References DESIGN_BLOCK_GRID_TRICKS.

Referenced by DESIGN_BLOCK_GRID_TRICKS.

◆ PANEL_DESIGN_BLOCK_LIB_TABLE

friend class PANEL_DESIGN_BLOCK_LIB_TABLE

friend

Definition at line 150 of file panel_design_block_lib_table.cpp.

References PANEL_DESIGN_BLOCK_LIB_TABLE.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE.

Member Data Documentation

◆ m_adapter

LIBRARY_MANAGER_ADAPTER* LIB_TABLE_GRID::m_adapter

protectedinherited

Handle to the adapter for the type of table this grid represents (may be null)

Definition at line 118 of file lib_table_grid.h.

Referenced by Adapter(), and LIB_TABLE_GRID().

◆ m_table

LIBRARY_TABLE LIB_TABLE_GRID::m_table

protectedinherited

Working copy of a table.

Definition at line 115 of file lib_table_grid.h.

Referenced by at(), begin(), erase(), insert(), LIB_TABLE_GRID(), makeNewRow(), push_back(), size(), and Table().

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

panel_design_block_lib_table.cpp

DESIGN_BLOCK_LIB_TABLE_GRID
Generated on Tue Nov 4 2025 00:07:00 for KiCad PCB EDA Suite by 1.13.2