generate_alias_info.cpp File Reference

#include <generate_alias_info.h>
#include <ki_exception.h>
#include <string_utils.h>
#include <template_fieldnames.h>
#include <lib_symbol.h>
#include <libraries/symbol_library_adapter.h>
#include <wx/log.h>

Go to the source code of this file.

Classes
class	FOOTPRINT_INFO_GENERATOR

Functions
wxString	GenerateAliasInfo (SYMBOL_LIBRARY_ADAPTER *aLibs, LIB_ID const &aLibId, int aUnit)
	Return an HTML page describing a LIB_ID in a SYMBOL_LIBRARY_ADAPTER.
wxString	GenerateAliasInfo (const LIB_SYMBOL *aSymbol, int aUnit)
	Return an HTML page describing an already loaded symbol, for symbols that do not live in a library table.

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

Function Documentation

GenerateAliasInfo() [1/2]

wxString GenerateAliasInfo	(	const LIB_SYMBOL *	aSymbol,
		int	aUnit )

Return an HTML page describing an already loaded symbol, for symbols that do not live in a library table.

Definition at line 305 of file generate_alias_info.cpp.

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

GenerateAliasInfo() [2/2]

wxString GenerateAliasInfo	(	SYMBOL_LIBRARY_ADAPTER *	aLibs,
		LIB_ID const &	aLibId,
		int	aUnit )

Return an HTML page describing a LIB_ID in a SYMBOL_LIBRARY_ADAPTER.

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

Definition at line 297 of file generate_alias_info.cpp.

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

Referenced by DB_LIB_PREVIEW_TREE_ADAPTER::GenerateInfo(), and SYMBOL_TREE_MODEL_ADAPTER::GenerateInfo().

Variable Documentation

AliasOfFormat

const wxString AliasOfFormat

static

Initial value:

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

Definition at line 38 of file generate_alias_info.cpp.

Referenced by FOOTPRINT_INFO_GENERATOR::SetHtmlAliasOf().

DescFormat

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

static

Definition at line 40 of file generate_alias_info.cpp.

Referenced by DESIGN_BLOCK_TREE_MODEL_ADAPTER::GenerateInfo(), and 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 29 of file generate_alias_info.cpp.

Referenced by DESIGN_BLOCK_TREE_MODEL_ADAPTER::GenerateInfo().

FieldFormat

const wxString FieldFormat

static

Initial value:

= wxS(
    "<tr>"
    "   <td><b>__NAME__</b></td>"
    "   <td>__VALUE__</td>"
    "</tr>" )

Definition at line 42 of file generate_alias_info.cpp.

Referenced by DESIGN_BLOCK_TREE_MODEL_ADAPTER::GenerateInfo(), and FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow().

KeywordsFormat

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

static

Definition at line 41 of file generate_alias_info.cpp.

Referenced by DESIGN_BLOCK_TREE_MODEL_ADAPTER::GenerateInfo().

LinkFormat

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

static

Definition at line 47 of file generate_alias_info.cpp.

Referenced by FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow().