KiCad PCB EDA Suite
Loading...
Searching...
No Matches
SYMBOL_LIB_TABLE_ROW Class Reference

Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN object in the SYMBOL_LIB_TABLE. More...

#include <symbol_lib_table.h>

Inheritance diagram for SYMBOL_LIB_TABLE_ROW:
LIB_TABLE_ROW

Public Types

typedef SCH_IO_MGR::SCH_FILE_T LIB_T
 

Public Member Functions

 SYMBOL_LIB_TABLE_ROW (const wxString &aNick, const wxString &aURI, const wxString &aType, const wxString &aOptions=wxEmptyString, const wxString &aDescr=wxEmptyString)
 
 SYMBOL_LIB_TABLE_ROW ()
 
bool operator== (const SYMBOL_LIB_TABLE_ROW &aRow) const
 
bool operator!= (const SYMBOL_LIB_TABLE_ROW &aRow) const
 
LIB_T SchLibType () const
 
const wxString GetType () const override
 Return the type of symbol library table represented by this row. More...
 
void SetType (const wxString &aType) override
 Change the schematic plugin type represented by this row. More...
 
bool Refresh () override
 Attempt to reload the library. More...
 
bool SupportsSubLibraries () const
 
bool SupportsSettingsDialog () const override
 
void ShowSettingsDialog (wxWindow *aWindow) const override
 
void GetSubLibraryNames (std::vector< wxString > &aNames) const
 
void GetAvailableSymbolFields (std::vector< wxString > &aNames) const
 
void GetDefaultSymbolFields (std::vector< wxString > &aNames) const
 
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...
 
bool GetIsVisible () const
 
void SetVisible (bool aVisible=true)
 
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...
 
LIB_TABLEGetParent () const
 
void SetParent (LIB_TABLE *aParent)
 
std::mutex & GetMutex ()
 
const STRING_UTF8_MAPGetProperties () 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_ROWclone () const
 

Protected Member Functions

 SYMBOL_LIB_TABLE_ROW (const SYMBOL_LIB_TABLE_ROW &aRow)
 

Private Member Functions

virtual LIB_TABLE_ROWdo_clone () const override
 
void setPlugin (SCH_PLUGIN *aPlugin)
 
void setProperties (STRING_UTF8_MAP *aProperties)
 

Private Attributes

SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
 
LIB_T type
 
wxString nickName
 
wxString uri_user
 what user entered from UI or loaded from disk More...
 
wxString options
 
wxString description
 
bool enabled = true
 Whether the LIB_TABLE_ROW is enabled. More...
 
bool visible = true
 Whether the LIB_TABLE_ROW is visible in choosers. More...
 
bool m_loaded = false
 Whether the LIB_TABLE_ROW is loaded. More...
 
LIB_TABLEm_parent
 Pointer to the table this row lives in (maybe null) More...
 
std::unique_ptr< STRING_UTF8_MAPproperties
 
std::mutex m_loadMutex
 

Friends

class SYMBOL_LIB_TABLE
 

Detailed Description

Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN object in the SYMBOL_LIB_TABLE.

Definition at line 41 of file symbol_lib_table.h.

Member Typedef Documentation

◆ LIB_T

typedef SCH_IO_MGR::SCH_FILE_T SYMBOL_LIB_TABLE_ROW::LIB_T

Definition at line 44 of file symbol_lib_table.h.

Constructor & Destructor Documentation

◆ SYMBOL_LIB_TABLE_ROW() [1/3]

SYMBOL_LIB_TABLE_ROW::SYMBOL_LIB_TABLE_ROW ( const wxString &  aNick,
const wxString &  aURI,
const wxString &  aType,
const wxString &  aOptions = wxEmptyString,
const wxString &  aDescr = wxEmptyString 
)
inline

Definition at line 46 of file symbol_lib_table.h.

References LIB_TABLE_ROW::SetEnabled(), and SetType().

◆ SYMBOL_LIB_TABLE_ROW() [2/3]

SYMBOL_LIB_TABLE_ROW::SYMBOL_LIB_TABLE_ROW ( )
inline

Definition at line 55 of file symbol_lib_table.h.

References LIB_TABLE_ROW::SetEnabled().

Referenced by do_clone().

◆ SYMBOL_LIB_TABLE_ROW() [3/3]

SYMBOL_LIB_TABLE_ROW::SYMBOL_LIB_TABLE_ROW ( const SYMBOL_LIB_TABLE_ROW aRow)
inlineprotected

Member Function Documentation

◆ clone()

LIB_TABLE_ROW * LIB_TABLE_ROW::clone ( ) const
inlineinherited

◆ do_clone()

virtual LIB_TABLE_ROW * SYMBOL_LIB_TABLE_ROW::do_clone ( ) const
inlineoverrideprivatevirtual

Implements LIB_TABLE_ROW.

Definition at line 126 of file symbol_lib_table.h.

References SYMBOL_LIB_TABLE_ROW().

◆ Format()

void LIB_TABLE_ROW::Format ( OUTPUTFORMATTER out,
int  nestLevel 
) const
inherited

Serialize this object as utf8 text to an OUTPUTFORMATTER, and tries to make it look good using multiple lines and indentation.

Parameters
outis an OUTPUTFORMATTER
nestLevelis the indentation level to base all lines of the output. Actual indentation will be 2 spaces for each nestLevel.

Definition at line 71 of file lib_table_base.cpp.

References 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(), OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

◆ GetAvailableSymbolFields()

void SYMBOL_LIB_TABLE_ROW::GetAvailableSymbolFields ( std::vector< wxString > &  aNames) const
inline

◆ GetDefaultSymbolFields()

void SYMBOL_LIB_TABLE_ROW::GetDefaultSymbolFields ( std::vector< wxString > &  aNames) const
inline

◆ GetDescr()

const wxString & LIB_TABLE_ROW::GetDescr ( ) const
inlineinherited

◆ GetFullURI()

const wxString LIB_TABLE_ROW::GetFullURI ( bool  aSubstituted = false) const
inherited

Return the full location specifying URI for the LIB, either in original UI form or in environment variable expanded form.

Parameters
aSubstitutedTells if caller wanted the substituted form, else not.

Definition at line 60 of file lib_table_base.cpp.

References ExpandEnvVarSubstitutions(), and LIB_TABLE_ROW::uri_user.

Referenced by EXPORTER_STEP::buildFootprint3DShapes(), SYMBOL_LIB_TABLE::CreateSymbolLib(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), SYMBOL_LIB_TABLE::DeleteSymbol(), SYMBOL_LIB_TABLE::DeleteSymbolLib(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), FOOTPRINT_EDIT_FRAME::DuplicateFootprint(), SYMBOL_LIB_TABLE::EnumerateSymbolLib(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), 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(), LIB_TABLE_ROW::Format(), FP_LIB_TABLE::GenerateTimestamp(), FP_LIB_TABLE::GetEnumeratedFootprint(), LIB_TABLE::GetFullURI(), SYMBOL_LIBRARY_MANAGER::GetLibraryHash(), LIB_TABLE_GRID::GetValue(), idf_export_footprint(), FP_LIB_TABLE::IsFootprintLibWritable(), SYMBOL_LIB_TABLE::IsSymbolLibWritable(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_VIEWER_FRAME::KiwayMailIn(), RENDER_3D_RAYTRACE::load3DModels(), RENDER_3D_OPENGL::load3dModels(), FP_LIB_TABLE::LoadGlobalTable(), SYMBOL_LIB_TABLE::LoadGlobalTable(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIB_TABLE::LoadSymbolLib(), FP_LIB_TABLE::PrefetchLib(), Refresh(), PCB::IFACE::SaveFileAs(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), SYMBOL_LIBRARY_MANAGER::SaveLibrary(), SYMBOL_LIB_TABLE::SaveSymbol(), PCB_BASE_FRAME::setFPWatcher(), SCH_BASE_FRAME::setSymWatcher(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), and PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists().

◆ GetIsEnabled()

bool LIB_TABLE_ROW::GetIsEnabled ( ) const
inlineinherited

◆ GetIsLoaded()

bool LIB_TABLE_ROW::GetIsLoaded ( ) const
inlineinherited
Returns
true if the library was loaded without error

Definition at line 112 of file lib_table_base.h.

References LIB_TABLE_ROW::m_loaded.

Referenced by SYMBOL_LIB_TABLE::IsSymbolLibLoaded().

◆ GetIsVisible()

◆ GetMutex()

std::mutex & LIB_TABLE_ROW::GetMutex ( )
inlineinherited

◆ GetNickName()

◆ GetOptions()

const wxString & LIB_TABLE_ROW::GetOptions ( ) const
inlineinherited

Return the options string, which may hold a password or anything else needed to instantiate the underlying library plugin.

Definition at line 167 of file lib_table_base.h.

References LIB_TABLE_ROW::options.

Referenced by SYMBOL_LIB_TABLE::EnumerateSymbolLib(), LIB_TABLE_ROW::Format(), LIB_TABLE_GRID::GetValue(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_LIB_TABLE::LoadSymbolLib(), SYMBOL_GRID_TRICKS::optionsEditor(), and FP_GRID_TRICKS::optionsEditor().

◆ GetParent()

LIB_TABLE * LIB_TABLE_ROW::GetParent ( ) const
inlineinherited

Definition at line 184 of file lib_table_base.h.

References LIB_TABLE_ROW::m_parent.

Referenced by Refresh().

◆ GetProperties()

◆ GetSubLibraryNames()

void SYMBOL_LIB_TABLE_ROW::GetSubLibraryNames ( std::vector< wxString > &  aNames) const

◆ GetType()

const wxString SYMBOL_LIB_TABLE_ROW::GetType ( ) const
inlineoverridevirtual

◆ operator!=() [1/2]

bool LIB_TABLE_ROW::operator!= ( const LIB_TABLE_ROW r) const
inlineinherited

Definition at line 97 of file lib_table_base.h.

◆ operator!=() [2/2]

bool SYMBOL_LIB_TABLE_ROW::operator!= ( const SYMBOL_LIB_TABLE_ROW aRow) const
inline

Definition at line 63 of file symbol_lib_table.h.

◆ operator==() [1/2]

bool LIB_TABLE_ROW::operator== ( const LIB_TABLE_ROW r) const
inherited

◆ operator==() [2/2]

bool SYMBOL_LIB_TABLE_ROW::operator== ( const SYMBOL_LIB_TABLE_ROW aRow) const

Definition at line 62 of file symbol_lib_table.cpp.

References LIB_TABLE_ROW::operator==(), and type.

◆ Refresh()

bool SYMBOL_LIB_TABLE_ROW::Refresh ( )
overridevirtual

Attempt to reload the library.

Returns
true if a reload was required.
Exceptions
IO_ERRORif the reload was unsuccessful.

Reimplemented from LIB_TABLE_ROW.

Definition at line 79 of file symbol_lib_table.cpp.

References SCH_PLUGIN::EnumerateSymbolLib(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetParent(), LIB_TABLE_ROW::GetProperties(), plugin, SCH_PLUGIN::SCH_PLUGIN_RELEASER::set(), SCH_PLUGIN::SetLibTable(), LIB_TABLE_ROW::SetLoaded(), and type.

Referenced by PANEL_SYM_LIB_TABLE::verifyTables().

◆ SchLibType()

LIB_T SYMBOL_LIB_TABLE_ROW::SchLibType ( ) const
inline

Definition at line 65 of file symbol_lib_table.h.

References type.

◆ SetDescr()

void LIB_TABLE_ROW::SetDescr ( const wxString &  aDescr)
inlineinherited

Change the description of the library referenced by this row.

Definition at line 182 of file lib_table_base.h.

References LIB_TABLE_ROW::description.

Referenced by LIB_TABLE_GRID::SetValue().

◆ SetEnabled()

void LIB_TABLE_ROW::SetEnabled ( bool  aEnabled = true)
inlineinherited

Change the enabled status of this library.

Definition at line 127 of file lib_table_base.h.

References LIB_TABLE_ROW::enabled.

Referenced by LIB_TABLE_GRID::SetValue(), LIB_TABLE_GRID::SetValueAsBool(), and SYMBOL_LIB_TABLE_ROW().

◆ SetFullURI()

void LIB_TABLE_ROW::SetFullURI ( const wxString &  aFullURI)
inherited

◆ SetLoaded()

void LIB_TABLE_ROW::SetLoaded ( bool  aLoaded)
inlineinherited

Mark the row as being a loaded library.

Definition at line 117 of file lib_table_base.h.

References LIB_TABLE_ROW::m_loaded.

Referenced by SYMBOL_LIB_TABLE::EnumerateSymbolLib(), SYMBOL_LIB_TABLE::LoadSymbolLib(), and Refresh().

◆ SetNickName()

void LIB_TABLE_ROW::SetNickName ( const wxString &  aNickName)
inlineinherited

Change the logical name of this library, useful for an editor.

Definition at line 107 of file lib_table_base.h.

References LIB_TABLE_ROW::nickName.

Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry(), and LIB_TABLE_GRID::SetValue().

◆ SetOptions()

◆ SetParent()

void LIB_TABLE_ROW::SetParent ( LIB_TABLE aParent)
inlineinherited

Definition at line 186 of file lib_table_base.h.

References LIB_TABLE_ROW::m_parent.

Referenced by LIB_TABLE::InsertRow(), and PANEL_SYM_LIB_TABLE::verifyTables().

◆ setPlugin()

void SYMBOL_LIB_TABLE_ROW::setPlugin ( SCH_PLUGIN aPlugin)
inlineprivate

Definition at line 131 of file symbol_lib_table.h.

References plugin, and SCH_PLUGIN::SCH_PLUGIN_RELEASER::set().

Referenced by SYMBOL_LIB_TABLE::FindRow().

◆ setProperties()

void LIB_TABLE_ROW::setProperties ( STRING_UTF8_MAP aProperties)
privateinherited

Definition at line 48 of file lib_table_base.cpp.

References LIB_TABLE_ROW::properties.

Referenced by LIB_TABLE_ROW::SetOptions().

◆ SetType()

void SYMBOL_LIB_TABLE_ROW::SetType ( const wxString &  aType)
overridevirtual

Change the schematic plugin type represented by this row.

Implements LIB_TABLE_ROW.

Definition at line 68 of file symbol_lib_table.cpp.

References SCH_IO_MGR::EnumFromStr(), plugin, SCH_PLUGIN::SCH_PLUGIN_RELEASER::release(), and type.

Referenced by SYMBOL_EDIT_FRAME::replaceLibTableEntry(), and SYMBOL_LIB_TABLE_ROW().

◆ SetVisible()

void LIB_TABLE_ROW::SetVisible ( bool  aVisible = true)
inlineinherited

Definition at line 131 of file lib_table_base.h.

References LIB_TABLE_ROW::visible.

Referenced by LIB_TABLE_GRID::SetValue(), and LIB_TABLE_GRID::SetValueAsBool().

◆ ShowSettingsDialog()

void SYMBOL_LIB_TABLE_ROW::ShowSettingsDialog ( wxWindow *  aWindow) const
overridevirtual

Reimplemented from LIB_TABLE_ROW.

Definition at line 106 of file symbol_lib_table.cpp.

References plugin, and type.

◆ SupportsSettingsDialog()

bool SYMBOL_LIB_TABLE_ROW::SupportsSettingsDialog ( ) const
inlineoverridevirtual

Reimplemented from LIB_TABLE_ROW.

Definition at line 87 of file symbol_lib_table.h.

References type.

◆ SupportsSubLibraries()

bool SYMBOL_LIB_TABLE_ROW::SupportsSubLibraries ( ) const
inline

Friends And Related Function Documentation

◆ SYMBOL_LIB_TABLE

friend class SYMBOL_LIB_TABLE
friend

Definition at line 124 of file symbol_lib_table.h.

Member Data Documentation

◆ description

wxString LIB_TABLE_ROW::description
privateinherited

◆ enabled

bool LIB_TABLE_ROW::enabled = true
privateinherited

Whether the LIB_TABLE_ROW is enabled.

Definition at line 240 of file lib_table_base.h.

Referenced by LIB_TABLE_ROW::GetIsEnabled(), LIB_TABLE_ROW::operator==(), and LIB_TABLE_ROW::SetEnabled().

◆ m_loaded

bool LIB_TABLE_ROW::m_loaded = false
privateinherited

Whether the LIB_TABLE_ROW is loaded.

Definition at line 242 of file lib_table_base.h.

Referenced by LIB_TABLE_ROW::GetIsLoaded(), and LIB_TABLE_ROW::SetLoaded().

◆ m_loadMutex

std::mutex LIB_TABLE_ROW::m_loadMutex
privateinherited

Definition at line 247 of file lib_table_base.h.

Referenced by LIB_TABLE_ROW::GetMutex().

◆ m_parent

LIB_TABLE* LIB_TABLE_ROW::m_parent
privateinherited

Pointer to the table this row lives in (maybe null)

Definition at line 243 of file lib_table_base.h.

Referenced by LIB_TABLE_ROW::GetParent(), and LIB_TABLE_ROW::SetParent().

◆ nickName

wxString LIB_TABLE_ROW::nickName
privateinherited

◆ options

wxString LIB_TABLE_ROW::options
privateinherited

◆ plugin

◆ properties

std::unique_ptr<STRING_UTF8_MAP> LIB_TABLE_ROW::properties
privateinherited

◆ type

LIB_T SYMBOL_LIB_TABLE_ROW::type
private

◆ uri_user

wxString LIB_TABLE_ROW::uri_user
privateinherited

what user entered from UI or loaded from disk

Definition at line 236 of file lib_table_base.h.

Referenced by LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::operator==(), and LIB_TABLE_ROW::SetFullURI().

◆ visible

bool LIB_TABLE_ROW::visible = true
privateinherited

Whether the LIB_TABLE_ROW is visible in choosers.

Definition at line 241 of file lib_table_base.h.

Referenced by LIB_TABLE_ROW::GetIsVisible(), LIB_TABLE_ROW::operator==(), and LIB_TABLE_ROW::SetVisible().


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