KiCad PCB EDA Suite
Loading...
Searching...
No Matches
template_fieldnames.h File Reference
#include <richio.h>
#include <template_fieldnames_lexer.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 DO_TRANSLATE   true
 

Typedefs

typedef std::vector< TEMPLATE_FIELDNAMETEMPLATE_FIELDNAMES
 

Enumerations

enum  MANDATORY_FIELD_T {
  REFERENCE_FIELD = 0 , VALUE_FIELD , FOOTPRINT_FIELD , DATASHEET_FIELD ,
  DESCRIPTION_FIELD , MANDATORY_FIELDS
}
 The set of all field indices assuming an array like sequence that a SCH_COMPONENT or LIB_PART can hold. More...
 

Functions

wxString GetCanonicalFieldName (int idx)
 

Macro Definition Documentation

◆ DO_TRANSLATE

#define DO_TRANSLATE   true

Definition at line 56 of file template_fieldnames.h.

Typedef Documentation

◆ TEMPLATE_FIELDNAMES

typedef std::vector< TEMPLATE_FIELDNAME > TEMPLATE_FIELDNAMES

Definition at line 120 of file template_fieldnames.h.

Enumeration Type Documentation

◆ MANDATORY_FIELD_T

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.

Enumerator
REFERENCE_FIELD 

Field Reference of part, i.e. "IC21".

VALUE_FIELD 

Field Value of part, i.e. "3.3K".

FOOTPRINT_FIELD 

Field Name Module PCB, i.e. "16DIP300".

DATASHEET_FIELD 

name of datasheet

DESCRIPTION_FIELD 

Field Description of part, i.e. "1/4W 1% Metal Film Resistor".

MANDATORY_FIELDS 

The first 5 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.

Definition at line 42 of file template_fieldnames.h.

Function Documentation

◆ GetCanonicalFieldName()