template_fieldnames.h File Reference

#include <wx/string.h>

Go to the source code of this file.

Classes
struct	TEMPLATE_FIELDNAME
	Hold a name of a symbol's field, field value, and default visibility. More...
class	TEMPLATES

Macros
#define	MANDATORY_FIELDS
#define	GLOBALLABEL_MANDATORY_FIELDS   { FIELD_T::INTERSHEET_REFS }
#define	SHEET_MANDATORY_FIELDS
#define	DO_TRANSLATE   true

Enumerations
enum class	FIELD_T : int {   USER , REFERENCE , VALUE , FOOTPRINT ,   DATASHEET , DESCRIPTION , INTERSHEET_REFS , SHEET_NAME ,   SHEET_FILENAME , SHEET_USER }
	The set of all field indices assuming an array like sequence that a SCH_COMPONENT or LIB_PART can hold. More...

Functions
wxString	GetDefaultFieldName (FIELD_T aFieldId, bool aTranslateForHI)
	Return a default symbol field name for a mandatory field type.
wxString	GetUserFieldName (int aFieldNdx, bool aTranslateForHI)
wxString	GetCanonicalFieldName (FIELD_T aFieldType)

Macro Definition Documentation

DO_TRANSLATE

#define DO_TRANSLATE   true

Definition at line 70 of file template_fieldnames.h.

GLOBALLABEL_MANDATORY_FIELDS

#define GLOBALLABEL_MANDATORY_FIELDS   { FIELD_T::INTERSHEET_REFS }

Definition at line 63 of file template_fieldnames.h.

MANDATORY_FIELDS

#define MANDATORY_FIELDS

Value:

                           { FIELD_T::REFERENCE,        \
                           FIELD_T::VALUE,            \
                           FIELD_T::FOOTPRINT,        \
                           FIELD_T::DATASHEET,        \
                           FIELD_T::DESCRIPTION }

Definition at line 57 of file template_fieldnames.h.

SHEET_MANDATORY_FIELDS

#define SHEET_MANDATORY_FIELDS

Value:

                                 { FIELD_T::SHEET_NAME,        \
                                 FIELD_T::SHEET_FILENAME }

Definition at line 65 of file template_fieldnames.h.

Enumeration Type Documentation

FIELD_T

enum class FIELD_T : int

strong

The set of all field indices assuming an array like sequence that a SCH_COMPONENT or LIB_PART can hold.

The first fields are fixed fields and are defined by MANDATORY_FIELDS. After that come an unlimited number of user defined fields, only some of which have indices defined here.

NOTE: this must stay a enum class to prevent developers from trying to use it as an array index.

Enumerator
USER	The field ID hasn't been set yet; field is invalid.
REFERENCE	Field Reference of part, i.e. "IC21".
VALUE	Field Value of part, i.e. "3.3K".
FOOTPRINT	Field Name Module PCB, i.e. "16DIP300".
DATASHEET	name of datasheet
DESCRIPTION	Field Description of part, i.e. "1/4W 1% Metal Film Resistor".
INTERSHEET_REFS	Global label cross-reference page numbers.
SHEET_NAME
SHEET_FILENAME
SHEET_USER

Definition at line 43 of file template_fieldnames.h.

Function Documentation

GetCanonicalFieldName()

wxString GetCanonicalFieldName ( FIELD_T  aFieldType )

inline

Definition at line 85 of file template_fieldnames.h.

References DO_TRANSLATE, and GetDefaultFieldName().

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), TEMPLATES::AddTemplateFieldName(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyBomPreset(), BACK_ANNOTATE::applyChangelist(), FIELDS_EDITOR_GRID_DATA_MODEL::ColIsReference(), FIELDS_EDITOR_GRID_DATA_MODEL::ColIsValue(), FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), SCH_FIELD::GetCanonicalName(), SCH_FIELD::GetName(), PCB_FIELD::GetName(), PCB_FIELD::GetTextTypeDescription(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), SCH_SYMBOL::Init(), EESCHEMA_JOBS_HANDLER::JobExportBom(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames(), SCH_IO_KICAD_LEGACY::loadSymbol(), DIALOG_CHANGE_SYMBOLS::onOkButtonClicked(), SCH_IO_KICAD_SEXPR_PARSER::parseProperty(), SCH_IO_KICAD_SEXPR_PARSER::parseSchField(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveField(), DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties(), FIELDS_EDITOR_GRID_TRICKS::showPopupMenu(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

GetDefaultFieldName()

wxString GetDefaultFieldName	(	FIELD_T	aFieldId,
		bool	aTranslateForHI
	)

Return a default symbol field name for a mandatory field type.

These field names are not modifiable but template field names are.

Parameters

aTranslateForHI

If true, return the translated field name, else get the canonical name (defualt). Translation is intended only for dialogs

Definition at line 55 of file template_fieldnames.cpp.

References _, DATASHEET, DATASHEET_CANONICAL, DESCRIPTION, DESCRIPTION_CANONICAL, FOOTPRINT, FOOTPRINT_CANONICAL, GetUserFieldName(), INTERSHEET_REFS, INTERSHEET_REFS_CANONICAL, REFERENCE, REFERENCE_CANONICAL, s_CanonicalDatasheet(), s_CanonicalDescription(), s_CanonicalFootprint(), s_CanonicalIntersheetRefs(), s_CanonicalReference(), s_CanonicalSheetFile(), s_CanonicalSheetName(), s_CanonicalValue(), SHEET_FILE_CANONICAL, SHEET_FILENAME, SHEET_NAME, SHEET_NAME_CANONICAL, VALUE, and VALUE_CANONICAL.

Referenced by DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), SCH_EDIT_TOOL::editFieldText(), GetCanonicalFieldName(), SCH_FIELD::GetName(), FIELDS_GRID_TABLE::GetValue(), EESCHEMA_JOBS_HANDLER::JobExportBom(), DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames(), SCH_FIELD::SCH_FIELD(), and SCH_SHEET::SCH_SHEET().

GetUserFieldName()

wxString GetUserFieldName	(	int	aFieldNdx,
		bool	aTranslateForHI
	)

Definition at line 90 of file template_fieldnames.cpp.

References _, and USER_FIELD_CANONICAL.

Referenced by GetDefaultFieldName(), PCB_FIELD::GetName(), SCH_IO_KICAD_LEGACY::loadSymbol(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField(), DIALOG_SHEET_PROPERTIES::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), and SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField().