KiCad PCB EDA Suite
generate_footprint_info.cpp File Reference
#include <generate_footprint_info.h>
#include <kicad_string.h>
#include <class_module.h>
#include <fp_lib_table.h>

Go to the source code of this file.

Classes

class  FOOTPRINT_INFO_GENERATOR
 

Functions

wxString GenerateFootprintInfo (FP_LIB_TABLE *aFpLibTable, LIB_ID const &aLibId)
 Return an HTML page describing a LIB_ID in a FP_LIB_TABLE. More...
 

Variables

static const wxString DescriptionFormat
 
static const wxString KeywordsFormat
 
static const wxString DocFormat
 

Function Documentation

wxString GenerateFootprintInfo ( FP_LIB_TABLE aFpLibTable,
LIB_ID const &  aLibId 
)

Return an HTML page describing a LIB_ID in a FP_LIB_TABLE.

This is suitable for inclusion in a wxHtmlWindow.

Definition at line 136 of file generate_footprint_info.cpp.

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

Referenced by FP_TREE_MODEL_ADAPTER::GenerateInfo().

137 {
138  FOOTPRINT_INFO_GENERATOR gen( aFpLibTable, aLibId );
139  gen.GenerateHtml();
140  return gen.GetHtml();
141 }

Variable Documentation

const wxString DescriptionFormat
static
Initial value:
=
"<b>__NAME__</b>"
"<br>__DESC__"
"<hr><table border=0>"
"__FIELDS__"
"</table>"

Definition at line 27 of file generate_footprint_info.cpp.

const wxString DocFormat
static
Initial value:
=
"<tr>"
" <td><b>" + _( "Documentation" ) + "</b></td>"
" <td><a href=\"__HREF__\">__TEXT__</a></td>"
"</tr>"

Definition at line 40 of file generate_footprint_info.cpp.

Referenced by FOOTPRINT_INFO_GENERATOR::GenerateHtml().

const wxString KeywordsFormat
static
Initial value:
=
"<tr>"
" <td><b>" + _( "Keywords" ) + "</b></td>"
" <td>__KEYWORDS__</td>"
"</tr>"

Definition at line 34 of file generate_footprint_info.cpp.

Referenced by FOOTPRINT_INFO_GENERATOR::GenerateHtml().