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_LIB_TABLE *aSymbolLibTable, LIB_ID const &aLibId, int aUnit)
 
void GenerateHtml ()
 Generate the HTML internally.
 
wxString GetHtml () const
 Return the generated HTML.
 
 FOOTPRINT_INFO_GENERATOR (FP_LIB_TABLE *aFpLibTable, LIB_ID const &aLibId)
 
void GenerateHtml ()
 Generate the HTML internally.
 
wxString GetHtml ()
 Return the generated HTML.
 

Protected Member Functions

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

Private Attributes

wxString m_html
 
SYMBOL_LIB_TABLE * m_sym_lib_table
 
LIB_ID const m_lib_id
 
LIB_SYMBOL * m_symbol
 
int m_unit
 
FP_LIB_TABLE * m_fp_lib_table
 
const FOOTPRINT * m_footprint
 

Detailed Description

Definition at line 48 of file generate_alias_info.cpp.

Constructor & Destructor Documentation

◆ FOOTPRINT_INFO_GENERATOR() [1/2]

FOOTPRINT_INFO_GENERATOR::FOOTPRINT_INFO_GENERATOR ( SYMBOL_LIB_TABLE *  aSymbolLibTable,
LIB_ID const &  aLibId,
int  aUnit 
)
inline

Definition at line 57 of file generate_alias_info.cpp.

◆ FOOTPRINT_INFO_GENERATOR() [2/2]

FOOTPRINT_INFO_GENERATOR::FOOTPRINT_INFO_GENERATOR ( FP_LIB_TABLE *  aFpLibTable,
LIB_ID const &  aLibId 
)
inline

Definition at line 103 of file generate_footprint_info.cpp.

Member Function Documentation

◆ GenerateHtml() [1/2]

void FOOTPRINT_INFO_GENERATOR::GenerateHtml ( )
inline

Generate the HTML internally.

Definition at line 68 of file generate_alias_info.cpp.

References _, LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_ID::IsValid(), SYMBOL_LIB_TABLE::LoadSymbol(), m_lib_id, m_sym_lib_table, m_symbol, SetHtmlAliasOf(), SetHtmlDesc(), SetHtmlFieldTable(), SetHtmlKeywords(), SetHtmlName(), IO_ERROR::What(), and UTF8::wx_str().

Referenced by GenerateAliasInfo(), and GenerateFootprintInfo().

◆ GenerateHtml() [2/2]

void FOOTPRINT_INFO_GENERATOR::GenerateHtml ( )
inline

Generate the HTML internally.

Definition at line 113 of file generate_footprint_info.cpp.

References _, DocFormat, EscapeHTML(), FP_LIB_TABLE::GetEnumeratedFootprint(), GetFootprintDocumentationURL(), FOOTPRINT::GetKeywords(), FOOTPRINT::GetLibDescription(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_ID::IsValid(), KeywordsFormat, LinkifyHTML(), m_footprint, m_fp_lib_table, m_html, m_lib_id, name, UnescapeString(), IO_ERROR::What(), and UTF8::wx_str().

◆ GetHtml() [1/2]

wxString FOOTPRINT_INFO_GENERATOR::GetHtml ( )
inline

Return the generated HTML.

Definition at line 173 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 101 of file generate_alias_info.cpp.

References m_html.

Referenced by GenerateAliasInfo(), and GenerateFootprintInfo().

◆ GetHtmlFieldRow()

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

Definition at line 164 of file generate_alias_info.cpp.

References DATASHEET_FIELD, DatasheetLinkFormat, EscapeHTML(), FieldFormat, SCH_FIELD::GetCanonicalName(), LIB_SYMBOL::GetDatasheetField(), SCH_FIELD::GetFullText(), SCH_FIELD::GetId(), SCH_FIELD::GetShownText(), m_symbol, m_unit, name, REFERENCE_FIELD, text, and VALUE_FIELD.

Referenced by SetHtmlFieldTable().

◆ SetHtmlAliasOf()

void FOOTPRINT_INFO_GENERATOR::SetHtmlAliasOf ( )
inlineprotected

Definition at line 113 of file generate_alias_info.cpp.

References _, AliasOfFormat, EscapeHTML(), LIB_SYMBOL::GetParent(), LIB_SYMBOL::IsRoot(), m_html, m_symbol, and UnescapeString().

Referenced by GenerateHtml().

◆ SetHtmlDesc()

void FOOTPRINT_INFO_GENERATOR::SetHtmlDesc ( )
inlineprotected

Definition at line 139 of file generate_alias_info.cpp.

References DescFormat, EscapeHTML(), LIB_SYMBOL::GetDescription(), LinkifyHTML(), m_html, m_symbol, and UnescapeString().

Referenced by GenerateHtml().

◆ SetHtmlFieldTable()

void FOOTPRINT_INFO_GENERATOR::SetHtmlFieldTable ( )
inlineprotected

Definition at line 214 of file generate_alias_info.cpp.

References LIB_SYMBOL::FindField(), LIB_SYMBOL::GetFields(), GetHtmlFieldRow(), LIB_SYMBOL::GetParent(), LIB_SYMBOL::IsAlias(), m_html, and m_symbol.

Referenced by GenerateHtml().

◆ SetHtmlKeywords()

void FOOTPRINT_INFO_GENERATOR::SetHtmlKeywords ( )
inlineprotected

Definition at line 153 of file generate_alias_info.cpp.

References EscapeHTML(), LIB_SYMBOL::GetKeyWords(), KeywordsFormat, m_html, and m_symbol.

Referenced by GenerateHtml().

◆ SetHtmlName()

void FOOTPRINT_INFO_GENERATOR::SetHtmlName ( )
inlineprotected

Definition at line 107 of file generate_alias_info.cpp.

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

Referenced by GenerateHtml().

Member Data Documentation

◆ m_footprint

const FOOTPRINT* FOOTPRINT_INFO_GENERATOR::m_footprint
private

Definition at line 100 of file generate_footprint_info.cpp.

Referenced by GenerateHtml().

◆ m_fp_lib_table

FP_LIB_TABLE* FOOTPRINT_INFO_GENERATOR::m_fp_lib_table
private

Definition at line 97 of file generate_footprint_info.cpp.

Referenced by GenerateHtml().

◆ m_html

wxString FOOTPRINT_INFO_GENERATOR::m_html
private

Definition at line 50 of file generate_alias_info.cpp.

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

◆ m_lib_id

LIB_ID const FOOTPRINT_INFO_GENERATOR::m_lib_id
private

Definition at line 52 of file generate_alias_info.cpp.

Referenced by GenerateHtml().

◆ m_sym_lib_table

SYMBOL_LIB_TABLE* FOOTPRINT_INFO_GENERATOR::m_sym_lib_table
private

Definition at line 51 of file generate_alias_info.cpp.

Referenced by GenerateHtml().

◆ m_symbol

LIB_SYMBOL* FOOTPRINT_INFO_GENERATOR::m_symbol
private

Definition at line 53 of file generate_alias_info.cpp.

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

◆ m_unit

int FOOTPRINT_INFO_GENERATOR::m_unit
private

Definition at line 54 of file generate_alias_info.cpp.

Referenced by GetHtmlFieldRow().

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