generate_footprint_info.cpp File Reference

#include <generate_footprint_info.h>
#include <kicad_string.h>
#include <footprint.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

GenerateFootprintInfo()

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.

{
    FOOTPRINT_INFO_GENERATOR gen( aFpLibTable, aLibId );
    gen.GenerateHtml();
    return gen.GetHtml();
}

References gen.

Referenced by FP_TREE_MODEL_ADAPTER::GenerateInfo().

Variable Documentation

DescriptionFormat

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.

DocFormat

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().

KeywordsFormat

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().