![]() |
KiCad PCB EDA Suite
|
Hold a record identifying a library accessed by the appropriate footprint library PLUGIN object in the FP_LIB_TABLE. More...
#include <fp_lib_table.h>
Public Types | |
typedef IO_MGR::PCB_FILE_T | LIB_T |
Public Member Functions | |
FP_LIB_TABLE_ROW (const wxString &aNick, const wxString &aURI, const wxString &aType, const wxString &aOptions, const wxString &aDescr=wxEmptyString) | |
FP_LIB_TABLE_ROW () | |
bool | operator== (const FP_LIB_TABLE_ROW &aRow) const |
bool | operator!= (const FP_LIB_TABLE_ROW &aRow) const |
const wxString | GetType () const override |
return the type of footprint library table represented by this row. More... | |
void | SetType (const wxString &aType) override |
Change the type represented by this row. More... | |
bool | operator== (const LIB_TABLE_ROW &r) const |
bool | operator!= (const LIB_TABLE_ROW &r) const |
const wxString & | GetNickName () const |
void | SetNickName (const wxString &aNickName) |
Change the logical name of this library, useful for an editor. More... | |
bool | GetIsLoaded () const |
void | SetLoaded (bool aLoaded) |
Mark the row as being a loaded library. More... | |
bool | GetIsEnabled () const |
void | SetEnabled (bool aEnabled=true) |
Change the enabled status of this library. More... | |
const wxString | GetFullURI (bool aSubstituted=false) const |
Return the full location specifying URI for the LIB, either in original UI form or in environment variable expanded form. More... | |
void | SetFullURI (const wxString &aFullURI) |
Change the full URI for the library. More... | |
const wxString & | GetOptions () const |
Return the options string, which may hold a password or anything else needed to instantiate the underlying library plugin. More... | |
void | SetOptions (const wxString &aOptions) |
Change the library options strings. More... | |
const wxString & | GetDescr () const |
Return the description of the library referenced by this row. More... | |
void | SetDescr (const wxString &aDescr) |
Change the description of the library referenced by this row. More... | |
const PROPERTIES * | GetProperties () const |
Return the constant PROPERTIES for this library (LIB_TABLE_ROW). More... | |
void | Format (OUTPUTFORMATTER *out, int nestLevel) const |
Serialize this object as utf8 text to an OUTPUTFORMATTER, and tries to make it look good using multiple lines and indentation. More... | |
LIB_TABLE_ROW * | clone () const |
Protected Member Functions | |
FP_LIB_TABLE_ROW (const FP_LIB_TABLE_ROW &aRow) | |
Private Member Functions | |
virtual LIB_TABLE_ROW * | do_clone () const override |
void | setPlugin (PLUGIN *aPlugin) |
Private Attributes | |
PLUGIN::RELEASER | plugin |
LIB_T | type |
Friends | |
class | FP_LIB_TABLE |
Hold a record identifying a library accessed by the appropriate footprint library PLUGIN object in the FP_LIB_TABLE.
Definition at line 40 of file fp_lib_table.h.
Definition at line 43 of file fp_lib_table.h.
|
inline |
Definition at line 45 of file fp_lib_table.h.
References SetType().
|
inline |
|
inlineprotected |
Definition at line 72 of file fp_lib_table.h.
|
inlineinherited |
Definition at line 186 of file lib_table_base.h.
References LIB_TABLE_ROW::do_clone().
Referenced by new_clone(), SYMBOL_GRID_TRICKS::paste_text(), and FP_GRID_TRICKS::paste_text().
|
inlineoverrideprivatevirtual |
Implements LIB_TABLE_ROW.
Definition at line 79 of file fp_lib_table.h.
References FP_LIB_TABLE_ROW().
|
inherited |
Serialize this object as utf8 text to an OUTPUTFORMATTER, and tries to make it look good using multiple lines and indentation.
out | is an OUTPUTFORMATTER |
nestLevel | is the indentation level to base all lines of the output. Actual indentation will be 2 spaces for each nestLevel. |
Definition at line 80 of file lib_table_base.cpp.
References OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().
|
inlineinherited |
Return the description of the library referenced by this row.
Definition at line 163 of file lib_table_base.h.
References LIB_TABLE_ROW::description.
Referenced by LIB_TABLE::GetDescription(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), and SCH_EDIT_FRAME::LoadSheetFromFile().
|
inherited |
Return the full location specifying URI for the LIB, either in original UI form or in environment variable expanded form.
aSubstituted | Tells if caller wanted the substituted form, else not. |
Definition at line 64 of file lib_table_base.cpp.
References ExpandEnvVarSubstitutions().
Referenced by SYMBOL_LIB_TABLE::CreateSymbolLib(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), SYMBOL_LIB_TABLE::DeleteSymbol(), SYMBOL_LIB_TABLE::DeleteSymbolLib(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), SYMBOL_LIB_TABLE::EnumerateSymbolLib(), FP_LIB_TABLE::FootprintDelete(), FP_LIB_TABLE::FootprintEnumerate(), FP_LIB_TABLE::FootprintExists(), FP_LIB_TABLE::FootprintLibCreate(), FP_LIB_TABLE::FootprintLibDelete(), FP_LIB_TABLE::FootprintLoad(), FP_LIB_TABLE::FootprintSave(), FP_LIB_TABLE::GenerateTimestamp(), FP_LIB_TABLE::GetEnumeratedFootprint(), LIB_TABLE::GetFullURI(), SYMBOL_LIBRARY_MANAGER::GetLibraryHash(), FP_LIB_TABLE::IsFootprintLibWritable(), SYMBOL_LIB_TABLE::IsSymbolLibWritable(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIB_TABLE::LoadSymbolLib(), FP_LIB_TABLE::PrefetchLib(), SCH::IFACE::SaveFileAs(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_LIB_TABLE::SaveSymbol(), and FOOTPRINT_VIEWER_FRAME::UpdateTitle().
|
inlineinherited |
Definition at line 118 of file lib_table_base.h.
References LIB_TABLE_ROW::enabled.
Referenced by LIB_TABLE::findRow(), LIB_TABLE_GRID::GetValueAsBool(), SYMBOL_LIB_TABLE_ROW::SYMBOL_LIB_TABLE_ROW(), and PANEL_SYM_LIB_TABLE::verifyTables().
|
inlineinherited |
Definition at line 108 of file lib_table_base.h.
References LIB_TABLE_ROW::m_loaded.
Referenced by SYMBOL_LIB_TABLE::IsSymbolLibLoaded().
|
inlineinherited |
Definition at line 98 of file lib_table_base.h.
References LIB_TABLE_ROW::nickName.
Referenced by LIB_TABLE_GRID::ContainsNickname(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), FP_LIB_TABLE::FootprintLoad(), LIB_TABLE::InsertRow(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIB_TABLE::LoadSymbolLib(), FP_GRID_TRICKS::optionsEditor(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), and PANEL_SYM_LIB_TABLE::verifyTables().
|
inlineinherited |
Return the options string, which may hold a password or anything else needed to instantiate the underlying library plugin.
Definition at line 153 of file lib_table_base.h.
References LIB_TABLE_ROW::options.
Referenced by SYMBOL_LIB_TABLE::EnumerateSymbolLib(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_LIB_TABLE::LoadSymbolLib(), and FP_GRID_TRICKS::optionsEditor().
|
inlineinherited |
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).
These are the "options" in a table.
Definition at line 174 of file lib_table_base.h.
References LIB_TABLE_ROW::properties.
Referenced by SYMBOL_LIB_TABLE::CreateSymbolLib(), SYMBOL_LIB_TABLE::DeleteSymbol(), SYMBOL_LIB_TABLE::DeleteSymbolLib(), SYMBOL_LIB_TABLE::EnumerateSymbolLib(), FP_LIB_TABLE::FootprintDelete(), FP_LIB_TABLE::FootprintEnumerate(), FP_LIB_TABLE::FootprintExists(), FP_LIB_TABLE::FootprintLibCreate(), FP_LIB_TABLE::FootprintLibDelete(), FP_LIB_TABLE::FootprintLoad(), FP_LIB_TABLE::FootprintSave(), FP_LIB_TABLE::GetEnumeratedFootprint(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIB_TABLE::LoadSymbolLib(), FP_LIB_TABLE::PrefetchLib(), and SYMBOL_LIB_TABLE::SaveSymbol().
|
inlineoverridevirtual |
return the type of footprint library table represented by this row.
Implements LIB_TABLE_ROW.
Definition at line 64 of file fp_lib_table.h.
References IO_MGR::ShowType(), and type.
|
inline |
Definition at line 59 of file fp_lib_table.h.
|
inlineinherited |
bool FP_LIB_TABLE_ROW::operator== | ( | const FP_LIB_TABLE_ROW & | aRow | ) | const |
Definition at line 48 of file fp_lib_table.cpp.
References LIB_TABLE_ROW::operator==(), and type.
|
inherited |
Definition at line 105 of file lib_table_base.cpp.
References r.
Referenced by operator==(), and SYMBOL_LIB_TABLE_ROW::operator==().
|
inlineinherited |
Change the description of the library referenced by this row.
Definition at line 168 of file lib_table_base.h.
References LIB_TABLE_ROW::description.
|
inlineinherited |
Change the enabled status of this library.
Definition at line 123 of file lib_table_base.h.
References LIB_TABLE_ROW::enabled.
Referenced by LIB_TABLE_GRID::SetValueAsBool(), and SYMBOL_LIB_TABLE_ROW::SYMBOL_LIB_TABLE_ROW().
|
inherited |
Change the full URI for the library.
Definition at line 54 of file lib_table_base.cpp.
Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry(), LIB_TABLE_ROW::LIB_TABLE_ROW(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), and SCH::IFACE::SaveFileAs().
|
inlineinherited |
Mark the row as being a loaded library.
Definition at line 113 of file lib_table_base.h.
References LIB_TABLE_ROW::m_loaded.
Referenced by SYMBOL_LIB_TABLE::EnumerateSymbolLib(), and SYMBOL_LIB_TABLE::LoadSymbolLib().
|
inlineinherited |
Change the logical name of this library, useful for an editor.
Definition at line 103 of file lib_table_base.h.
References LIB_TABLE_ROW::nickName.
Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry().
|
inherited |
Change the library options strings.
Definition at line 115 of file lib_table_base.cpp.
References LIB_TABLE::ParseOptions(), and TO_UTF8.
Referenced by SYMBOL_LIB_TABLE::EnumerateSymbolLib(), LIB_TABLE_ROW::LIB_TABLE_ROW(), SYMBOL_LIB_TABLE::LoadSymbolLib(), and FP_GRID_TRICKS::optionsEditor().
|
inlineprivate |
Definition at line 84 of file fp_lib_table.h.
References plugin, and PLUGIN::RELEASER::set().
Referenced by FP_LIB_TABLE::FindRow().
|
overridevirtual |
Change the type represented by this row.
Implements LIB_TABLE_ROW.
Definition at line 54 of file fp_lib_table.cpp.
References IO_MGR::EnumFromStr(), and IO_MGR::KICAD_SEXP.
Referenced by FP_LIB_TABLE_ROW().
|
friend |
Definition at line 89 of file fp_lib_table.h.
|
private |
Definition at line 91 of file fp_lib_table.h.
Referenced by FP_LIB_TABLE::FindRow(), FP_LIB_TABLE::FootprintDelete(), FP_LIB_TABLE::FootprintEnumerate(), FP_LIB_TABLE::FootprintExists(), FP_LIB_TABLE::FootprintLibCreate(), FP_LIB_TABLE::FootprintLibDelete(), FP_LIB_TABLE::FootprintLoad(), FP_LIB_TABLE::FootprintSave(), FP_LIB_TABLE::GenerateTimestamp(), FP_LIB_TABLE::GetEnumeratedFootprint(), FP_LIB_TABLE::IsFootprintLibWritable(), FP_LIB_TABLE::PrefetchLib(), and setPlugin().
|
private |
Definition at line 92 of file fp_lib_table.h.
Referenced by FP_LIB_TABLE::FindRow(), GetType(), and operator==().