KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
DATABASE_FIELD_MAPPING Struct Reference

#include <database_lib_settings.h>

Public Member Functions

 DATABASE_FIELD_MAPPING ()
 
 DATABASE_FIELD_MAPPING (const std::string &aColumn, const std::string &aName, bool aVisibleOnAdd, bool aVisibleInChooser, bool aShowName, bool aInheritProperties)
 
void SetName (const std::string &aName)
 

Public Attributes

std::string column
 Database column name.
 
std::string name
 KiCad field name.
 
wxString name_wx
 KiCad field name (converted)
 
bool visible_on_add
 Whether to show the field when placing the symbol.
 
bool visible_in_chooser
 Whether the column is shown by default in the chooser.
 
bool show_name
 Whether or not to show the field name as well as its value.
 
bool inherit_properties
 Whether or not to inherit properties from symbol field.
 
nlohmann::json source
 Raw JSON as loaded; untouched keys are written back verbatim.
 

Detailed Description

Definition at line 51 of file database_lib_settings.h.

Constructor & Destructor Documentation

◆ DATABASE_FIELD_MAPPING() [1/2]

DATABASE_FIELD_MAPPING::DATABASE_FIELD_MAPPING ( )

Definition at line 39 of file database_lib_settings.cpp.

References inherit_properties, show_name, source, visible_in_chooser, and visible_on_add.

◆ DATABASE_FIELD_MAPPING() [2/2]

DATABASE_FIELD_MAPPING::DATABASE_FIELD_MAPPING ( const std::string & aColumn,
const std::string & aName,
bool aVisibleOnAdd,
bool aVisibleInChooser,
bool aShowName,
bool aInheritProperties )
explicit

Definition at line 49 of file database_lib_settings.cpp.

References column, inherit_properties, name, name_wx, show_name, source, visible_in_chooser, and visible_on_add.

Member Function Documentation

◆ SetName()

void DATABASE_FIELD_MAPPING::SetName ( const std::string & aName)

Definition at line 64 of file database_lib_settings.cpp.

References name, and name_wx.

Referenced by DIALOG_DATABASE_LIB_SETTINGS::OnFieldCellChanged().

Member Data Documentation

◆ column

std::string DATABASE_FIELD_MAPPING::column

Database column name.

Definition at line 53 of file database_lib_settings.h.

Referenced by DIALOG_DATABASE_LIB_SETTINGS::autofillColumns(), SCH_IO_DATABASE::connect(), DATABASE_FIELD_MAPPING(), DIALOG_DATABASE_LIB_SETTINGS::fieldForColumn(), DATABASE_LIB_SETTINGS::fieldToJson(), DIALOG_DATABASE_LIB_SETTINGS::loadFields(), SCH_IO_DATABASE::loadSymbolFromRow(), DIALOG_DATABASE_LIB_SETTINGS::OnAddUnmappedColumns(), and DIALOG_DATABASE_LIB_SETTINGS::OnFieldCellChanged().

◆ inherit_properties

bool DATABASE_FIELD_MAPPING::inherit_properties

Whether or not to inherit properties from symbol field.

Definition at line 59 of file database_lib_settings.h.

Referenced by DATABASE_FIELD_MAPPING(), DATABASE_FIELD_MAPPING(), DATABASE_LIB_SETTINGS::fieldToJson(), DIALOG_DATABASE_LIB_SETTINGS::loadFields(), SCH_IO_DATABASE::loadSymbolFromRow(), and DIALOG_DATABASE_LIB_SETTINGS::OnFieldCellChanged().

◆ name

std::string DATABASE_FIELD_MAPPING::name

KiCad field name.

Definition at line 54 of file database_lib_settings.h.

Referenced by DIALOG_DATABASE_LIB_SETTINGS::autofillColumns(), DATABASE_FIELD_MAPPING(), DATABASE_LIB_SETTINGS::fieldToJson(), findField(), DIALOG_DATABASE_LIB_SETTINGS::loadFields(), DIALOG_DATABASE_LIB_SETTINGS::OnFieldCellChanged(), and SetName().

◆ name_wx

wxString DATABASE_FIELD_MAPPING::name_wx

KiCad field name (converted)

Definition at line 55 of file database_lib_settings.h.

Referenced by DATABASE_FIELD_MAPPING(), SCH_IO_DATABASE::loadSymbolFromRow(), and SetName().

◆ show_name

bool DATABASE_FIELD_MAPPING::show_name

Whether or not to show the field name as well as its value.

Definition at line 58 of file database_lib_settings.h.

Referenced by DATABASE_FIELD_MAPPING(), DATABASE_FIELD_MAPPING(), DATABASE_LIB_SETTINGS::fieldToJson(), DIALOG_DATABASE_LIB_SETTINGS::loadFields(), SCH_IO_DATABASE::loadSymbolFromRow(), and DIALOG_DATABASE_LIB_SETTINGS::OnFieldCellChanged().

◆ source

nlohmann::json DATABASE_FIELD_MAPPING::source

Raw JSON as loaded; untouched keys are written back verbatim.

Definition at line 60 of file database_lib_settings.h.

Referenced by DATABASE_FIELD_MAPPING(), DATABASE_FIELD_MAPPING(), DATABASE_LIB_SETTINGS::fieldFromJson(), and DATABASE_LIB_SETTINGS::fieldToJson().

◆ visible_in_chooser

bool DATABASE_FIELD_MAPPING::visible_in_chooser

Whether the column is shown by default in the chooser.

Definition at line 57 of file database_lib_settings.h.

Referenced by DATABASE_FIELD_MAPPING(), DATABASE_FIELD_MAPPING(), DATABASE_LIB_SETTINGS::fieldToJson(), DIALOG_DATABASE_LIB_SETTINGS::loadFields(), SCH_IO_DATABASE::loadSymbolFromRow(), and DIALOG_DATABASE_LIB_SETTINGS::OnFieldCellChanged().

◆ visible_on_add

bool DATABASE_FIELD_MAPPING::visible_on_add

Whether to show the field when placing the symbol.

Definition at line 56 of file database_lib_settings.h.

Referenced by DATABASE_FIELD_MAPPING(), DATABASE_FIELD_MAPPING(), DATABASE_LIB_SETTINGS::fieldToJson(), DIALOG_DATABASE_LIB_SETTINGS::loadFields(), SCH_IO_DATABASE::loadSymbolFromRow(), and DIALOG_DATABASE_LIB_SETTINGS::OnFieldCellChanged().

The documentation for this struct was generated from the following files: