KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
FOOTPRINT_INFO_GENERATOR Class Reference

Public Member Functions

 FOOTPRINT_INFO_GENERATOR (SYMBOL_LIBRARY_ADAPTER *aLibs, LIB_ID const &aLibId, int aUnit)
 
 FOOTPRINT_INFO_GENERATOR (const LIB_SYMBOL *aSymbol, int aUnit)
 
void GenerateHtml ()
 Generate the HTML internally.
 
wxString GetHtml () const
 Return the generated HTML.
 
 FOOTPRINT_INFO_GENERATOR (FOOTPRINT_LIBRARY_ADAPTER *aAdapter, LIB_ID const &aLibId)
 
void GenerateHtml ()
 Generate the HTML internally.
 
wxString GetHtml ()
 Return the generated HTML.
 

Protected Member Functions

void fillFromSymbol ()
 
void SetHtmlName ()
 
void SetHtmlAliasOf ()
 
void SetHtmlDesc ()
 
void SetHtmlKeywords ()
 
wxString GetHtmlFieldRow (const SCH_FIELD &aField) const
 
void SetHtmlFieldTable ()
 
void ClearPlaceholders ()
 

Private Attributes

wxString m_html
 
SYMBOL_LIBRARY_ADAPTER * m_libs
 
LIB_ID const m_lib_id
 
const LIB_SYMBOL * m_symbol
 
int m_unit
 
FOOTPRINT_LIBRARY_ADAPTER * m_adapter
 
const FOOTPRINT * m_footprint
 

Detailed Description

Definition at line 50 of file generate_alias_info.cpp.

Constructor & Destructor Documentation

◆ FOOTPRINT_INFO_GENERATOR() [1/3]

FOOTPRINT_INFO_GENERATOR::FOOTPRINT_INFO_GENERATOR ( SYMBOL_LIBRARY_ADAPTER * aLibs,
LIB_ID const & aLibId,
int aUnit )
inline

Definition at line 53 of file generate_alias_info.cpp.

References DescriptionFormat, m_html, m_lib_id, m_libs, m_symbol, and m_unit.

◆ FOOTPRINT_INFO_GENERATOR() [2/3]

FOOTPRINT_INFO_GENERATOR::FOOTPRINT_INFO_GENERATOR ( const LIB_SYMBOL * aSymbol,
int aUnit )
inline

Definition at line 61 of file generate_alias_info.cpp.

References DescriptionFormat, m_html, m_lib_id, m_libs, m_symbol, and m_unit.

◆ FOOTPRINT_INFO_GENERATOR() [3/3]

FOOTPRINT_INFO_GENERATOR::FOOTPRINT_INFO_GENERATOR ( FOOTPRINT_LIBRARY_ADAPTER * aAdapter,
LIB_ID const & aLibId )
inline

Definition at line 107 of file generate_footprint_info.cpp.

References DescriptionFormat, m_adapter, m_footprint, m_html, and m_lib_id.

Member Function Documentation

◆ ClearPlaceholders()

void FOOTPRINT_INFO_GENERATOR::ClearPlaceholders ( )
inlineprotected

Definition at line 279 of file generate_alias_info.cpp.

References m_html.

Referenced by GenerateHtml().

◆ fillFromSymbol()

void FOOTPRINT_INFO_GENERATOR::fillFromSymbol ( )
inlineprotected

Definition at line 117 of file generate_alias_info.cpp.

References SetHtmlAliasOf(), SetHtmlDesc(), SetHtmlFieldTable(), SetHtmlKeywords(), and SetHtmlName().

Referenced by GenerateHtml().

◆ GenerateHtml() [1/2]

void FOOTPRINT_INFO_GENERATOR::GenerateHtml ( )
inline

Generate the HTML internally.

Definition at line 72 of file generate_alias_info.cpp.

References _, ClearPlaceholders(), fillFromSymbol(), m_lib_id, m_libs, m_symbol, and IO_ERROR::What().

Referenced by GenerateAliasInfo(), GenerateAliasInfo(), and GenerateFootprintInfo().

◆ GenerateHtml() [2/2]

void FOOTPRINT_INFO_GENERATOR::GenerateHtml ( )
inline

Generate the HTML internally.

Definition at line 117 of file generate_footprint_info.cpp.

References DocFormat, EscapeHTML(), GetFootprintDocumentationURL(), KeywordsFormat, LinkifyHTML(), m_adapter, m_footprint, m_html, m_lib_id, name, traceLibraries, UnescapeString(), and IO_ERROR::What().

◆ GetHtml() [1/2]

wxString FOOTPRINT_INFO_GENERATOR::GetHtml ( )
inline

Return the generated HTML.

Definition at line 177 of file generate_footprint_info.cpp.

References m_html.

◆ GetHtml() [2/2]

wxString FOOTPRINT_INFO_GENERATOR::GetHtml ( ) const
inline

Return the generated HTML.

Definition at line 111 of file generate_alias_info.cpp.

References m_html.

Referenced by GenerateAliasInfo(), GenerateAliasInfo(), and GenerateFootprintInfo().

◆ GetHtmlFieldRow()

wxString FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow ( const SCH_FIELD & aField) const
inlineprotected

Definition at line 179 of file generate_alias_info.cpp.

References DATASHEET, EscapeHTML(), FieldFormat, FOR_GUI, SCH_FIELD::GetFullText(), SCH_FIELD::GetId(), SCH_FIELD::GetShownText(), SCH_FIELD::GetUntranslatedName(), SCH_FIELD::HasHypertext(), link, LinkFormat, m_symbol, m_unit, name, REFERENCE, text, and VALUE.

Referenced by SetHtmlFieldTable().

◆ SetHtmlAliasOf()

void FOOTPRINT_INFO_GENERATOR::SetHtmlAliasOf ( )
inlineprotected

Definition at line 131 of file generate_alias_info.cpp.

References _, AliasOfFormat, EscapeHTML(), LIB_SYMBOL::GetDesc(), LIB_SYMBOL::GetName(), m_html, m_symbol, and UnescapeString().

Referenced by fillFromSymbol().

◆ SetHtmlDesc()

void FOOTPRINT_INFO_GENERATOR::SetHtmlDesc ( )
inlineprotected

Definition at line 156 of file generate_alias_info.cpp.

References DescFormat, EscapeHTML(), FOR_GUI, LinkifyHTML(), m_html, m_symbol, and UnescapeString().

Referenced by fillFromSymbol().

◆ SetHtmlFieldTable()

void FOOTPRINT_INFO_GENERATOR::SetHtmlFieldTable ( )
inlineprotected

Definition at line 245 of file generate_alias_info.cpp.

References GetHtmlFieldRow(), m_html, and m_symbol.

Referenced by fillFromSymbol().

◆ SetHtmlKeywords()

void FOOTPRINT_INFO_GENERATOR::SetHtmlKeywords ( )
inlineprotected

Definition at line 169 of file generate_alias_info.cpp.

References EscapeHTML(), FOR_GUI, KeywordsFormat, m_html, and m_symbol.

Referenced by fillFromSymbol().

◆ SetHtmlName()

void FOOTPRINT_INFO_GENERATOR::SetHtmlName ( )
inlineprotected

Definition at line 126 of file generate_alias_info.cpp.

References EscapeHTML(), m_html, m_symbol, and UnescapeString().

Referenced by fillFromSymbol().

Member Data Documentation

◆ m_adapter

FOOTPRINT_LIBRARY_ADAPTER* FOOTPRINT_INFO_GENERATOR::m_adapter
private

Definition at line 184 of file generate_footprint_info.cpp.

Referenced by FOOTPRINT_INFO_GENERATOR(), and GenerateHtml().

◆ m_footprint

const FOOTPRINT* FOOTPRINT_INFO_GENERATOR::m_footprint
private

Definition at line 187 of file generate_footprint_info.cpp.

Referenced by FOOTPRINT_INFO_GENERATOR(), and GenerateHtml().

◆ m_html

wxString FOOTPRINT_INFO_GENERATOR::m_html
private

Definition at line 289 of file generate_alias_info.cpp.

Referenced by ClearPlaceholders(), FOOTPRINT_INFO_GENERATOR(), FOOTPRINT_INFO_GENERATOR(), FOOTPRINT_INFO_GENERATOR(), GenerateHtml(), GetHtml(), GetHtml(), SetHtmlAliasOf(), SetHtmlDesc(), SetHtmlFieldTable(), SetHtmlKeywords(), and SetHtmlName().

◆ m_lib_id

LIB_ID const FOOTPRINT_INFO_GENERATOR::m_lib_id
private

Definition at line 291 of file generate_alias_info.cpp.

Referenced by FOOTPRINT_INFO_GENERATOR(), FOOTPRINT_INFO_GENERATOR(), FOOTPRINT_INFO_GENERATOR(), and GenerateHtml().

◆ m_libs

SYMBOL_LIBRARY_ADAPTER* FOOTPRINT_INFO_GENERATOR::m_libs
private

Definition at line 290 of file generate_alias_info.cpp.

Referenced by FOOTPRINT_INFO_GENERATOR(), FOOTPRINT_INFO_GENERATOR(), and GenerateHtml().

◆ m_symbol

const LIB_SYMBOL* FOOTPRINT_INFO_GENERATOR::m_symbol
private

Definition at line 292 of file generate_alias_info.cpp.

Referenced by FOOTPRINT_INFO_GENERATOR(), FOOTPRINT_INFO_GENERATOR(), GenerateHtml(), GetHtmlFieldRow(), SetHtmlAliasOf(), SetHtmlDesc(), SetHtmlFieldTable(), SetHtmlKeywords(), and SetHtmlName().

◆ m_unit

int FOOTPRINT_INFO_GENERATOR::m_unit
private

Definition at line 293 of file generate_alias_info.cpp.

Referenced by FOOTPRINT_INFO_GENERATOR(), FOOTPRINT_INFO_GENERATOR(), and GetHtmlFieldRow().

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