KiCad PCB EDA Suite
lib_field.h File Reference
#include <eda_text.h>
#include <lib_item.h>

Go to the source code of this file.

Classes

class  LIB_FIELD
 Field object used in symbol libraries. More...
 

Macros

#define TRANSLATE_FIELD_NAME   true
 Returns the field name. More...
 
#define NATIVE_FIELD_NAME   false
 

Typedefs

typedef std::vector< LIB_FIELDLIB_FIELDS
 

Macro Definition Documentation

◆ NATIVE_FIELD_NAME

#define NATIVE_FIELD_NAME   false

Definition at line 125 of file lib_field.h.

◆ TRANSLATE_FIELD_NAME

#define TRANSLATE_FIELD_NAME   true

Returns the field name.

The first four field IDs are reserved and therefore always return their respective names. The user definable fields will return FieldN where N is the ID of the field when the m_name member is empty.

Parameters
aTranslatetrue to return translated field name. note: has meaning mainly for mandatory fields or to return a default field name. Should be used only in messages (never when trying to find a field by name) false to return the english name. Normal option when the name is used as keyword in netlists.
Returns
Name of the field.

Definition at line 124 of file lib_field.h.

Typedef Documentation

◆ LIB_FIELDS

typedef std::vector< LIB_FIELD > LIB_FIELDS

Definition at line 223 of file lib_field.h.