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

#include <bom_settings.h>

Public Member Functions

bool operator== (const BOM_FMT_PRESET &rhs) const
 

Static Public Member Functions

static BOM_FMT_PRESET CSV ()
 
static BOM_FMT_PRESET TSV ()
 
static BOM_FMT_PRESET Semicolons ()
 
static std::vector< BOM_FMT_PRESET > BuiltInPresets ()
 

Public Attributes

wxString name
 
bool readOnly = false
 
wxString fieldDelimiter
 
wxString stringDelimiter
 
wxString refDelimiter
 
wxString refRangeDelimiter
 
bool keepTabs = false
 
bool keepLineBreaks = false
 
bool includeByteOrderMark = false
 

Detailed Description

Definition at line 95 of file bom_settings.h.

Member Function Documentation

◆ BuiltInPresets()

std::vector< BOM_FMT_PRESET > BOM_FMT_PRESET::BuiltInPresets ( )
static

Definition at line 291 of file bom_settings.cpp.

References CSV(), Semicolons(), and TSV().

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), and DIALOG_FIELDS_TABLE::loadDefaultBomFmtPresets().

◆ CSV()

BOM_FMT_PRESET BOM_FMT_PRESET::CSV ( )
static

Definition at line 271 of file bom_settings.cpp.

References _HKI.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), BuiltInPresets(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), DIALOG_FIELDS_TABLE::rebuildBomFmtPresetsWidget(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ operator==()

bool BOM_FMT_PRESET::operator== ( const BOM_FMT_PRESET & rhs) const

Definition at line 221 of file bom_settings.cpp.

References fieldDelimiter, includeByteOrderMark, keepLineBreaks, keepTabs, name, readOnly, refDelimiter, refRangeDelimiter, and stringDelimiter.

◆ Semicolons()

BOM_FMT_PRESET BOM_FMT_PRESET::Semicolons ( )
static

Definition at line 283 of file bom_settings.cpp.

References _HKI.

Referenced by BuiltInPresets().

◆ TSV()

BOM_FMT_PRESET BOM_FMT_PRESET::TSV ( )
static

Definition at line 277 of file bom_settings.cpp.

References _HKI.

Referenced by BuiltInPresets().

Member Data Documentation

◆ fieldDelimiter

wxString BOM_FMT_PRESET::fieldDelimiter

Definition at line 99 of file bom_settings.h.

Referenced by DIALOG_FIELDS_TABLE::doApplyBomFmtPreset(), FIELDS_TABLE_DATA_MODEL_BASE::Export(), from_json(), DIALOG_FIELDS_TABLE::GetCurrentBomFmtSettings(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), DIALOG_FIELDS_TABLE::loadJobBomFmtPreset(), operator==(), DIALOG_FIELDS_TABLE::saveJobSettings(), and to_json().

◆ includeByteOrderMark

bool BOM_FMT_PRESET::includeByteOrderMark = false

Definition at line 105 of file bom_settings.h.

Referenced by BOOST_AUTO_TEST_CASE(), DIALOG_FIELDS_TABLE::doApplyBomFmtPreset(), FIELDS_TABLE_DATA_MODEL_BASE::Export(), from_json(), DIALOG_FIELDS_TABLE::GetCurrentBomFmtSettings(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), DIALOG_FIELDS_TABLE::loadJobBomFmtPreset(), operator==(), DIALOG_FIELDS_TABLE::saveJobSettings(), and to_json().

◆ keepLineBreaks

bool BOM_FMT_PRESET::keepLineBreaks = false

Definition at line 104 of file bom_settings.h.

Referenced by DIALOG_FIELDS_TABLE::doApplyBomFmtPreset(), FIELDS_TABLE_DATA_MODEL_BASE::Export(), from_json(), DIALOG_FIELDS_TABLE::GetCurrentBomFmtSettings(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), DIALOG_FIELDS_TABLE::loadJobBomFmtPreset(), operator==(), DIALOG_FIELDS_TABLE::saveJobSettings(), and to_json().

◆ keepTabs

bool BOM_FMT_PRESET::keepTabs = false

Definition at line 103 of file bom_settings.h.

Referenced by DIALOG_FIELDS_TABLE::doApplyBomFmtPreset(), FIELDS_TABLE_DATA_MODEL_BASE::Export(), from_json(), DIALOG_FIELDS_TABLE::GetCurrentBomFmtSettings(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), DIALOG_FIELDS_TABLE::loadJobBomFmtPreset(), operator==(), DIALOG_FIELDS_TABLE::saveJobSettings(), and to_json().

◆ name

wxString BOM_FMT_PRESET::name

Definition at line 97 of file bom_settings.h.

Referenced by DIALOG_FIELDS_TABLE::ApplyBomFmtPreset(), from_json(), DIALOG_FIELDS_TABLE::GetCurrentBomFmtSettings(), DIALOG_FIELDS_TABLE::loadJobBomFmtPreset(), DIALOG_FIELDS_TABLE::onBomFmtPresetChanged(), operator<(), operator==(), and to_json().

◆ readOnly

bool BOM_FMT_PRESET::readOnly = false

Definition at line 98 of file bom_settings.h.

Referenced by DIALOG_FIELDS_TABLE::onBomFmtPresetChanged(), and operator==().

◆ refDelimiter

wxString BOM_FMT_PRESET::refDelimiter

Definition at line 101 of file bom_settings.h.

Referenced by DIALOG_FIELDS_TABLE::doApplyBomFmtPreset(), FIELDS_TABLE_DATA_MODEL_BASE::Export(), from_json(), DIALOG_FIELDS_TABLE::GetCurrentBomFmtSettings(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), DIALOG_FIELDS_TABLE::loadJobBomFmtPreset(), operator==(), DIALOG_FIELDS_TABLE::saveJobSettings(), and to_json().

◆ refRangeDelimiter

wxString BOM_FMT_PRESET::refRangeDelimiter

Definition at line 102 of file bom_settings.h.

Referenced by DIALOG_FIELDS_TABLE::doApplyBomFmtPreset(), FIELDS_TABLE_DATA_MODEL_BASE::Export(), from_json(), DIALOG_FIELDS_TABLE::GetCurrentBomFmtSettings(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), DIALOG_FIELDS_TABLE::loadJobBomFmtPreset(), operator==(), DIALOG_FIELDS_TABLE::saveJobSettings(), and to_json().

◆ stringDelimiter

wxString BOM_FMT_PRESET::stringDelimiter

Definition at line 100 of file bom_settings.h.

Referenced by DIALOG_FIELDS_TABLE::doApplyBomFmtPreset(), FIELDS_TABLE_DATA_MODEL_BASE::Export(), from_json(), DIALOG_FIELDS_TABLE::GetCurrentBomFmtSettings(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), DIALOG_FIELDS_TABLE::loadJobBomFmtPreset(), operator==(), DIALOG_FIELDS_TABLE::saveJobSettings(), and to_json().

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