KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Friends | List of all members
LIB_TABLE_GRID Class Referenceabstract

This abstract base class mixes any object derived from LIB_TABLE into wxGridTableBase so the result can be used as any type of library table within wxGrid. More...

#include <lib_table_grid.h>

Inheritance diagram for LIB_TABLE_GRID:
DESIGN_BLOCK_LIB_TABLE_GRID FP_LIB_TABLE_GRID SYMBOL_LIB_TABLE_GRID

Public Member Functions

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 SetValue (int aRow, int aCol, const wxString &aValue) 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)
 
LIB_TABLE_ROW * At (size_t aIndex)
 

Protected Member Functions

virtual LIB_TABLE_ROW * at (size_t aIndex)=0
 
virtual size_t size () const =0
 
virtual LIB_TABLE_ROW * makeNewRow ()=0
 
virtual LIB_TABLE_ROWS_ITER begin ()=0
 
virtual LIB_TABLE_ROWS_ITER insert (LIB_TABLE_ROWS_ITER aIterator, LIB_TABLE_ROW *aRow)=0
 
virtual void push_back (LIB_TABLE_ROW *aRow)=0
 
virtual LIB_TABLE_ROWS_ITER erase (LIB_TABLE_ROWS_ITER aFirst, LIB_TABLE_ROWS_ITER aLast)=0
 

Friends

class LIB_TABLE_GRID_TRICKS
 

Detailed Description

This abstract base class mixes any object derived from LIB_TABLE into wxGridTableBase so the result can be used as any type of library table within wxGrid.

Definition at line 50 of file lib_table_grid.h.

Member Function Documentation

◆ AppendRows()

bool LIB_TABLE_GRID::AppendRows ( size_t  aNumRows = 1)
inlineoverride

Definition at line 170 of file lib_table_grid.h.

References makeNewRow(), and push_back().

Referenced by DESIGN_BLOCK_GRID_TRICKS::paste_text(), SYMBOL_GRID_TRICKS::paste_text(), and FP_GRID_TRICKS::paste_text().

◆ At()

LIB_TABLE_ROW * LIB_TABLE_GRID::At ( size_t  aIndex)
inline

Definition at line 234 of file lib_table_grid.h.

References at().

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

◆ at()

virtual LIB_TABLE_ROW * LIB_TABLE_GRID::at ( size_t  aIndex)
protectedpure virtual

Implemented in DESIGN_BLOCK_LIB_TABLE_GRID, SYMBOL_LIB_TABLE_GRID, and FP_LIB_TABLE_GRID.

Referenced by At(), ContainsNickname(), GetValue(), GetValueAsBool(), SetValue(), and SetValueAsBool().

◆ begin()

virtual LIB_TABLE_ROWS_ITER LIB_TABLE_GRID::begin ( )
protectedpure virtual

Implemented in DESIGN_BLOCK_LIB_TABLE_GRID, SYMBOL_LIB_TABLE_GRID, and FP_LIB_TABLE_GRID.

Referenced by DeleteRows(), and InsertRows().

◆ CanGetValueAs()

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

Definition at line 84 of file lib_table_grid.h.

References COL_ENABLED, COL_VISIBLE, and size().

◆ ContainsNickname()

bool LIB_TABLE_GRID::ContainsNickname ( const wxString &  aNickname)
inline

Definition at line 222 of file lib_table_grid.h.

References at(), LIB_TABLE_ROW::GetNickName(), and size().

◆ DeleteRows()

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

Definition at line 185 of file lib_table_grid.h.

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

◆ erase()

virtual LIB_TABLE_ROWS_ITER LIB_TABLE_GRID::erase ( LIB_TABLE_ROWS_ITER  aFirst,
LIB_TABLE_ROWS_ITER  aLast 
)
protectedpure virtual

Implemented in DESIGN_BLOCK_LIB_TABLE_GRID, SYMBOL_LIB_TABLE_GRID, and FP_LIB_TABLE_GRID.

Referenced by DeleteRows().

◆ GetColLabelValue()

wxString LIB_TABLE_GRID::GetColLabelValue ( int  aCol)
inlineoverride

Definition at line 204 of file lib_table_grid.h.

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

◆ GetNumberCols()

int LIB_TABLE_GRID::GetNumberCols ( )
inlineoverride

Definition at line 60 of file lib_table_grid.h.

References COL_COUNT.

◆ GetNumberRows()

int LIB_TABLE_GRID::GetNumberRows ( )
inlineoverride

Definition at line 58 of file lib_table_grid.h.

References size().

Referenced by DESIGN_BLOCK_GRID_TRICKS::optionsEditor(), SYMBOL_GRID_TRICKS::optionsEditor(), FP_GRID_TRICKS::optionsEditor(), DESIGN_BLOCK_GRID_TRICKS::paste_text(), SYMBOL_GRID_TRICKS::paste_text(), and FP_GRID_TRICKS::paste_text().

◆ GetValue()

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

Definition at line 62 of file lib_table_grid.h.

References at(), COL_DESCR, COL_ENABLED, COL_NICKNAME, COL_OPTIONS, COL_TYPE, COL_URI, COL_VISIBLE, LIB_TABLE_ROW::GetDescr(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetIsEnabled(), LIB_TABLE_ROW::GetIsVisible(), LIB_TABLE_ROW::GetNickName(), LIB_TABLE_ROW::GetOptions(), LIB_TABLE_ROW::GetType(), size(), and UnescapeString().

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

◆ GetValueAsBool()

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

Definition at line 102 of file lib_table_grid.h.

References at(), COL_ENABLED, COL_VISIBLE, LIB_TABLE_ROW::GetIsEnabled(), LIB_TABLE_ROW::GetIsVisible(), and size().

Referenced by LIB_TABLE_GRID_TRICKS::showPopupMenu().

◆ insert()

virtual LIB_TABLE_ROWS_ITER LIB_TABLE_GRID::insert ( LIB_TABLE_ROWS_ITER  aIterator,
LIB_TABLE_ROW *  aRow 
)
protectedpure virtual

Implemented in DESIGN_BLOCK_LIB_TABLE_GRID, SYMBOL_LIB_TABLE_GRID, and FP_LIB_TABLE_GRID.

Referenced by InsertRows().

◆ InsertRows()

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

Definition at line 144 of file lib_table_grid.h.

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

◆ IsEmptyCell()

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

Definition at line 139 of file lib_table_grid.h.

References GetValue().

◆ makeNewRow()

virtual LIB_TABLE_ROW * LIB_TABLE_GRID::makeNewRow ( )
protectedpure virtual

Implemented in DESIGN_BLOCK_LIB_TABLE_GRID, SYMBOL_LIB_TABLE_GRID, and FP_LIB_TABLE_GRID.

Referenced by AppendRows(), and InsertRows().

◆ push_back()

virtual void LIB_TABLE_GRID::push_back ( LIB_TABLE_ROW *  aRow)
protectedpure virtual

Implemented in DESIGN_BLOCK_LIB_TABLE_GRID, SYMBOL_LIB_TABLE_GRID, and FP_LIB_TABLE_GRID.

Referenced by AppendRows().

◆ SetValue()

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

Definition at line 112 of file lib_table_grid.h.

References at(), COL_DESCR, COL_ENABLED, COL_NICKNAME, COL_OPTIONS, COL_TYPE, COL_URI, COL_VISIBLE, CTX_LIBID, EscapeString(), LIB_TABLE_ROW::SetDescr(), LIB_TABLE_ROW::SetEnabled(), LIB_TABLE_ROW::SetFullURI(), LIB_TABLE_ROW::SetNickName(), LIB_TABLE_ROW::SetOptions(), LIB_TABLE_ROW::SetType(), LIB_TABLE_ROW::SetVisible(), and size().

Referenced by DESIGN_BLOCK_LIB_TABLE_GRID::SetValue(), SYMBOL_LIB_TABLE_GRID::SetValue(), and FP_LIB_TABLE_GRID::SetValue().

◆ SetValueAsBool()

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

Definition at line 131 of file lib_table_grid.h.

References at(), COL_ENABLED, COL_VISIBLE, LIB_TABLE_ROW::SetEnabled(), LIB_TABLE_ROW::SetVisible(), and size().

Referenced by LIB_TABLE_GRID_TRICKS::doPopupSelection().

◆ size()

virtual size_t LIB_TABLE_GRID::size ( ) const
protectedpure virtual

Implemented in DESIGN_BLOCK_LIB_TABLE_GRID, SYMBOL_LIB_TABLE_GRID, and FP_LIB_TABLE_GRID.

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

Friends And Related Function Documentation

◆ LIB_TABLE_GRID_TRICKS

friend class LIB_TABLE_GRID_TRICKS
friend

Definition at line 52 of file lib_table_grid.h.

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