KiCad PCB EDA Suite
Loading...
Searching...
No Matches
generate_alias_info.cpp File Reference
#include <generate_alias_info.h>
#include <string_utils.h>
#include <template_fieldnames.h>
#include <lib_symbol.h>
#include <symbol_lib_table.h>
#include <wx/log.h>

Go to the source code of this file.

Classes

class  FOOTPRINT_INFO_GENERATOR
 

Functions

wxString GenerateAliasInfo (SYMBOL_LIB_TABLE *aSymLibTable, LIB_ID const &aLibId, int aUnit)
 Return an HTML page describing a LIB_ID in a SYMBOL_LIB_TABLE. More...
 

Variables

static const wxString DescriptionFormat
 
static const wxString AliasOfFormat = wxS( "<br><i>" ) + _( "Derived from" ) + wxS( " %s (%s)</i>" )
 
static const wxString DescFormat = wxS( "<br>%s" )
 
static const wxString KeywordsFormat = wxS( "<br>" ) + _( "Keywords" ) + wxS( ": %s" )
 
static const wxString FieldFormat
 
static const wxString DatasheetLinkFormat = wxS( "<a href=\"__HREF__\">__TEXT__</a>" )
 

Function Documentation

◆ GenerateAliasInfo()

wxString GenerateAliasInfo ( SYMBOL_LIB_TABLE aSymLibTable,
LIB_ID const &  aLibId,
int  aUnit 
)

Return an HTML page describing a LIB_ID in a SYMBOL_LIB_TABLE.

This is suitable for inclusion in a HTML_WINDOW (wxHtmlWindow).

Definition at line 250 of file generate_alias_info.cpp.

References FOOTPRINT_INFO_GENERATOR::GenerateHtml(), and FOOTPRINT_INFO_GENERATOR::GetHtml().

Referenced by SYMBOL_TREE_MODEL_ADAPTER::GenerateInfo().

Variable Documentation

◆ AliasOfFormat

const wxString AliasOfFormat = wxS( "<br><i>" ) + _( "Derived from" ) + wxS( " %s (%s)</i>" )
static

Definition at line 37 of file generate_alias_info.cpp.

Referenced by FOOTPRINT_INFO_GENERATOR::SetHtmlAliasOf().

◆ DatasheetLinkFormat

const wxString DatasheetLinkFormat = wxS( "<a href=\"__HREF__\">__TEXT__</a>" )
static

Definition at line 45 of file generate_alias_info.cpp.

Referenced by FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow().

◆ DescFormat

const wxString DescFormat = wxS( "<br>%s" )
static

Definition at line 38 of file generate_alias_info.cpp.

Referenced by FOOTPRINT_INFO_GENERATOR::SetHtmlDesc().

◆ DescriptionFormat

const wxString DescriptionFormat
static
Initial value:
= wxS(
"<b>__NAME__</b>"
"__ALIASOF__"
"__DESC__"
"__KEY__"
"<hr><table border=0>"
"__FIELDS__"
"</table>" )

Definition at line 28 of file generate_alias_info.cpp.

◆ FieldFormat

const wxString FieldFormat
static
Initial value:
= wxS(
"<tr>"
" <td><b>__NAME__</b></td>"
" <td>__VALUE__</td>"
"</tr>" )

Definition at line 40 of file generate_alias_info.cpp.

Referenced by FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow().

◆ KeywordsFormat

const wxString KeywordsFormat = wxS( "<br>" ) + _( "Keywords" ) + wxS( ": %s" )
static

Definition at line 39 of file generate_alias_info.cpp.