KiCad PCB EDA Suite
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 ()
 Attempt to reload the library. More...
 
bool SupportsSubLibraries () const
 
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.

48 :
49 LIB_TABLE_ROW( aNick, aURI, aOptions, aDescr )
50 {
51 SetType( aType );
52 SetEnabled( true );
53 }
void SetEnabled(bool aEnabled=true)
Change the enabled status of this library.
void SetType(const wxString &aType) override
Change the schematic plugin type represented by this row.

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.

55 :
56 type( SCH_IO_MGR::SCH_KICAD )
57 {
58 SetEnabled( true );
59 }

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

Definition at line 108 of file symbol_lib_table.h.

108 :
109 LIB_TABLE_ROW( aRow ),
110 type( aRow.type )
111 {
112 SetEnabled( aRow.GetIsEnabled() );
113 }
bool GetIsEnabled() const

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

Member Function Documentation

◆ clone()

LIB_TABLE_ROW * LIB_TABLE_ROW::clone ( ) const
inlineinherited

Definition at line 198 of file lib_table_base.h.

199 {
200 return do_clone();
201 }
virtual LIB_TABLE_ROW * do_clone() const =0

References LIB_TABLE_ROW::do_clone().

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

◆ do_clone()

virtual LIB_TABLE_ROW * SYMBOL_LIB_TABLE_ROW::do_clone ( ) const
inlineoverrideprivatevirtual

Implements LIB_TABLE_ROW.

Definition at line 118 of file symbol_lib_table.h.

119 {
120 return new SYMBOL_LIB_TABLE_ROW( *this );
121 }

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.

72{
73 // In Kicad, we save path and file names using the Unix notation (separator = '/')
74 // So ensure separator is always '/' is saved URI string
75 wxString uri = GetFullURI();
76 uri.Replace( '\\', '/' );
77
78 wxString extraOptions;
79
80 if( !GetIsEnabled() )
81 extraOptions += "(disabled)";
82
83 if( !GetIsVisible() )
84 extraOptions += "(hidden)";
85
86 out->Print( nestLevel, "(lib (name %s)(type %s)(uri %s)(options %s)(descr %s)%s)\n",
87 out->Quotew( GetNickName() ).c_str(),
88 out->Quotew( GetType() ).c_str(),
89 out->Quotew( uri ).c_str(),
90 out->Quotew( GetOptions() ).c_str(),
91 out->Quotew( GetDescr() ).c_str(),
92 extraOptions.ToStdString().c_str() );
93}
const wxString & GetOptions() const
Return the options string, which may hold a password or anything else needed to instantiate the under...
const wxString & GetDescr() const
Return the description of the library referenced by this row.
virtual const wxString GetType() const =0
Return the type of library represented by this row.
const wxString & GetNickName() const
const wxString GetFullURI(bool aSubstituted=false) const
Return the full location specifying URI for the LIB, either in original UI form or in environment var...
bool GetIsVisible() const
std::string Quotew(const wxString &aWrapee) const
Definition: richio.cpp:501
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:433

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
See also
SCH_PLUGIN::GetAvailableSymbolFields

Definition at line 92 of file symbol_lib_table.h.

93 {
94 if( plugin )
96 }
virtual void GetAvailableSymbolFields(std::vector< wxString > &aNames)
Retrieves a list of (custom) field names that are present on symbols in this library.
Definition: sch_io_mgr.h:474
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin

References SCH_PLUGIN::GetAvailableSymbolFields(), and plugin.

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries().

◆ GetDefaultSymbolFields()

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

Definition at line 101 of file symbol_lib_table.h.

102 {
103 if( plugin )
105 }
virtual void GetDefaultSymbolFields(std::vector< wxString > &aNames)
Retrieves a list of (custom) field names that should be shown by default for this library in the symb...
Definition: sch_io_mgr.h:488

References SCH_PLUGIN::GetDefaultSymbolFields(), and plugin.

◆ 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.

61{
62 if( aSubstituted )
63 {
64 return ExpandEnvVarSubstitutions( uri_user, nullptr );
65 }
66
67 return uri_user;
68}
wxString uri_user
what user entered from UI or loaded from disk
const wxString ExpandEnvVarSubstitutions(const wxString &aString, const PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition: common.cpp:299

References ExpandEnvVarSubstitutions(), and LIB_TABLE_ROW::uri_user.

Referenced by EXPORTER_STEP::composePCB(), 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(), 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(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_LIBRARY_MANAGER::SaveLibrary(), SYMBOL_LIB_TABLE::SaveSymbol(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), and PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists().

◆ GetIsEnabled()

bool LIB_TABLE_ROW::GetIsEnabled ( ) const
inlineinherited
Returns
the enabled status of this library row

Definition at line 120 of file lib_table_base.h.

120{ return enabled; }
bool enabled
Whether the LIB_TABLE_ROW is enabled.

References LIB_TABLE_ROW::enabled.

Referenced by LIB_TABLE::findRow(), LIB_TABLE_ROW::Format(), LIB_TABLE_GRID::GetValue(), LIB_TABLE_GRID::GetValueAsBool(), SYMBOL_LIB_TABLE_ROW(), and PANEL_SYM_LIB_TABLE::verifyTables().

◆ GetIsLoaded()

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

Definition at line 110 of file lib_table_base.h.

110{ return m_loaded; }
bool m_loaded
Whether the LIB_TABLE_ROW is loaded.

References LIB_TABLE_ROW::m_loaded.

Referenced by SYMBOL_LIB_TABLE::IsSymbolLibLoaded().

◆ GetIsVisible()

bool LIB_TABLE_ROW::GetIsVisible ( ) const
inlineinherited

◆ GetMutex()

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

Definition at line 180 of file lib_table_base.h.

180{ return m_loadMutex; }
std::mutex m_loadMutex

References LIB_TABLE_ROW::m_loadMutex.

Referenced by SYMBOL_LIB_TABLE::LoadSymbol(), and SYMBOL_LIB_TABLE::LoadSymbolLib().

◆ 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 159 of file lib_table_base.h.

159{ return options; }
wxString options

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(), and FP_GRID_TRICKS::optionsEditor().

◆ GetParent()

LIB_TABLE * LIB_TABLE_ROW::GetParent ( void  ) const
inlineinherited

Definition at line 176 of file lib_table_base.h.

176{ return m_parent; }
LIB_TABLE * m_parent
Pointer to the table this row lives in (maybe null)

References LIB_TABLE_ROW::m_parent.

Referenced by Refresh(), and PANEL_SYM_LIB_TABLE::verifyTables().

◆ GetProperties()

◆ GetSubLibraryNames()

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

Definition at line 94 of file symbol_lib_table.cpp.

95{
96 if( !plugin )
97 return;
98
99 plugin->GetSubLibraryNames( aNames );
100}
virtual void GetSubLibraryNames(std::vector< wxString > &aNames)
Retrieves a list of sub-libraries in this library.
Definition: sch_io_mgr.h:463

References SCH_PLUGIN::GetSubLibraryNames(), and plugin.

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), and SYMBOL_VIEWER_FRAME::ReCreateLibList().

◆ GetType()

const wxString SYMBOL_LIB_TABLE_ROW::GetType ( ) const
inlineoverridevirtual

Return the type of symbol library table represented by this row.

Implements LIB_TABLE_ROW.

Definition at line 70 of file symbol_lib_table.h.

70{ return SCH_IO_MGR::ShowType( type ); }
static const wxString ShowType(SCH_FILE_T aFileType)
Return a brief name for a plugin, given aFileType enum.
Definition: sch_io_mgr.cpp:81

References SCH_IO_MGR::ShowType(), and type.

Referenced by SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SYMBOL_EDIT_FRAME::IsSymbolFromLegacyLibrary(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_LIB_TABLE_RESCUER::OpenRescueLibrary(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

◆ operator!=() [1/2]

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

Definition at line 95 of file lib_table_base.h.

95{ return !( *this == r ); }

◆ 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.

63{ return !( *this == aRow ); }

◆ 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 59 of file symbol_lib_table.cpp.

60{
61 return LIB_TABLE_ROW::operator == ( aRow ) && type == aRow.type;
62}
bool operator==(const LIB_TABLE_ROW &r) const

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

◆ Refresh()

bool SYMBOL_LIB_TABLE_ROW::Refresh ( )

Attempt to reload the library.

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

Definition at line 76 of file symbol_lib_table.cpp.

77{
78 if( !plugin )
79 {
80 wxArrayString dummyList;
81
82 plugin.set( SCH_IO_MGR::FindPlugin( type ) );
83 SetLoaded( false );
84 plugin->SetLibTable( static_cast<SYMBOL_LIB_TABLE*>( GetParent() ) );
85 plugin->EnumerateSymbolLib( dummyList, GetFullURI( true ), GetProperties() );
86 SetLoaded( true );
87 return true;
88 }
89
90 return false;
91}
LIB_TABLE * GetParent() const
void SetLoaded(bool aLoaded)
Mark the row as being a loaded library.
const STRING_UTF8_MAP * GetProperties() const
Return the constant #PROPERTIES for this library (LIB_TABLE_ROW).
void set(SCH_PLUGIN *aPlugin)
Definition: sch_io_mgr.h:562
virtual void EnumerateSymbolLib(wxArrayString &aSymbolNameList, const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr)
Populate a list of LIB_SYMBOL alias names contained within the library aLibraryPath.
Definition: sch_plugin.cpp:67
virtual void SetLibTable(SYMBOL_LIB_TABLE *aTable)
Some library plugins need to have access to their parent library table.
Definition: sch_io_mgr.h:515

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.

65{ return type; }

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 174 of file lib_table_base.h.

174{ description = aDescr; }

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 125 of file lib_table_base.h.

125{ enabled = aEnabled; }

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 115 of file lib_table_base.h.

115{ m_loaded = aLoaded; };

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 105 of file lib_table_base.h.

105{ nickName = aNickName; }

References LIB_TABLE_ROW::nickName.

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

◆ SetOptions()

void LIB_TABLE_ROW::SetOptions ( const wxString &  aOptions)
inherited

Change the library options strings.

Definition at line 107 of file lib_table_base.cpp.

108{
109 options = aOptions;
110
111 // set PROPERTIES* from options
113}
void setProperties(STRING_UTF8_MAP *aProperties)
static STRING_UTF8_MAP * ParseOptions(const std::string &aOptionsList)
Parses aOptionsList and places the result into a #PROPERTIES object which is returned.
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96

References LIB_TABLE_ROW::options, LIB_TABLE::ParseOptions(), LIB_TABLE_ROW::setProperties(), and TO_UTF8.

Referenced by SYMBOL_LIB_TABLE::EnumerateSymbolLib(), LIB_TABLE_ROW::LIB_TABLE_ROW(), SYMBOL_LIB_TABLE::LoadSymbolLib(), FP_GRID_TRICKS::optionsEditor(), and LIB_TABLE_GRID::SetValue().

◆ SetParent()

void LIB_TABLE_ROW::SetParent ( LIB_TABLE aParent)
inlineinherited

Definition at line 178 of file lib_table_base.h.

178{ m_parent = aParent; }

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 123 of file symbol_lib_table.h.

124 {
125 plugin.set( aPlugin );
126 }

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.

49{
50 properties.reset( aProperties );
51}

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 65 of file symbol_lib_table.cpp.

66{
68
69 if( SCH_IO_MGR::SCH_FILE_T( -1 ) == type )
70 type = SCH_IO_MGR::SCH_LEGACY;
71
73}
static SCH_FILE_T EnumFromStr(const wxString &aFileType)
Return the #SCH_FILE_T from the corresponding plugin type name: "kicad", "legacy",...
Definition: sch_io_mgr.cpp:101

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 129 of file lib_table_base.h.

129{ visible = aVisible; }

References LIB_TABLE_ROW::visible.

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

◆ 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 116 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 232 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 234 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 239 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 235 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 228 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 233 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: