KiCad PCB EDA Suite
|
#include <generate_footprint_info.h>
#include <string_utils.h>
#include <footprint.h>
#include <fp_lib_table.h>
#include <wx/log.h>
Go to the source code of this file.
Classes | |
class | FOOTPRINT_INFO_GENERATOR |
Functions | |
std::optional< wxString > | GetFootprintDocumentationURL (const FOOTPRINT &aFootprint) |
Get a URL to the documentation for a LIB_ID in a FP_LIB_TABLE. | |
wxString | GenerateFootprintInfo (FP_LIB_TABLE *aFpLibTable, LIB_ID const &aLibId) |
Return an HTML page describing a LIB_ID in a FP_LIB_TABLE. | |
Variables | |
static const wxString | DescriptionFormat |
static const wxString | KeywordsFormat |
static const wxString | DocFormat |
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 181 of file generate_footprint_info.cpp.
References FOOTPRINT_INFO_GENERATOR::GenerateHtml(), and FOOTPRINT_INFO_GENERATOR::GetHtml().
Referenced by FP_TREE_MODEL_ADAPTER::GenerateInfo().
std::optional< wxString > GetFootprintDocumentationURL | ( | const FOOTPRINT & | aFootprint | ) |
Get a URL to the documentation for a LIB_ID in a FP_LIB_TABLE.
This is suitable for opening in a web browser. Currently, for want of a proper home in the format, this is usually found in the "description" field of the footprint.
Definition at line 48 of file generate_footprint_info.cpp.
References FOOTPRINT::GetLibDescription().
Referenced by FOOTPRINT_INFO_GENERATOR::GenerateHtml(), and FOOTPRINT_EDITOR_CONTROL::ShowDatasheet().
|
static |
Definition at line 28 of file generate_footprint_info.cpp.
|
static |
Definition at line 41 of file generate_footprint_info.cpp.
Referenced by FOOTPRINT_INFO_GENERATOR::GenerateHtml().
|
static |
Definition at line 35 of file generate_footprint_info.cpp.
Referenced by FOOTPRINT_INFO_GENERATOR::GenerateHtml(), and FOOTPRINT_INFO_GENERATOR::SetHtmlKeywords().