KiCad PCB EDA Suite
Configuration strings
static const wxString IconScaleEntry = "PcbIconScale"
 
static const wxString PlotLineWidthEntry = "PlotLineWidth_mm"
 
static const wxString MagneticPadsEntry = "PcbMagPadOpt"
 
static const wxString MagneticTracksEntry = "PcbMagTrackOpt"
 
static const wxString ShowMicrowaveEntry = "ShowMicrowaveTools"
 
static const wxString ShowLayerManagerEntry = "ShowLayerManagerTools"
 
static const wxString ShowPageLimitsEntry = "ShowPageLimits"
 
static const wxString IconScaleEntry = "PcbIconScale"
 
#define OPTKEY_LAYERBASE   wxT( "PlotLayer_%d" )
 
#define OPTKEY_PRINT_X_FINESCALE_ADJ   wxT( "PrintXFineScaleAdj" )
 
#define OPTKEY_PRINT_Y_FINESCALE_ADJ   wxT( "PrintYFineScaleAdj" )
 
#define OPTKEY_PRINT_SCALE   wxT( "PrintScale" )
 
#define OPTKEY_PRINT_MODULE_SCALE   wxT( "PrintModuleScale" )
 
#define OPTKEY_PRINT_PAGE_FRAME   wxT( "PrintPageFrame" )
 
#define OPTKEY_PRINT_MONOCHROME_MODE   wxT( "PrintMonochrome" )
 
#define OPTKEY_PRINT_PAGE_PER_LAYER   wxT( "PrintSinglePage" )
 
#define OPTKEY_PRINT_PADS_DRILL   wxT( "PrintPadsDrillOpt" )
 
#define OPTKEY_PLOT_X_FINESCALE_ADJ   wxT( "PlotXFineScaleAdj" )
 
#define OPTKEY_PLOT_Y_FINESCALE_ADJ   wxT( "PlotYFineScaleAdj" )
 
#define CONFIG_PS_FINEWIDTH_ADJ   wxT( "PSPlotFineWidthAdj" )
 
#define OPTKEY_PLOT_CHECK_ZONES   wxT( "CheckZonesBeforePlotting" )
 
static const wxString FilterFootprintEntry = "FilterFootprint"
 
const wxChar RescueNeverShowEntry [] = wxT( "RescueNeverShow" )
 
const wxChar AutoplaceFieldsEntry [] = wxT( "AutoplaceFields" )
 
const wxChar AutoplaceJustifyEntry [] = wxT( "AutoplaceJustify" )
 
const wxChar AutoplaceAlignEntry [] = wxT( "AutoplaceAlign" )
 
const wxChar SchIconScaleEntry [] = wxT( "SchIconScale" )
 
const wxChar LibIconScaleEntry [] = wxT( "LibIconScale" )
 
static const wxChar FootprintPreviewEntry [] = wxT( "FootprintPreview" )
 
static const wxChar DefaultBusWidthEntry [] = wxT( "DefaultBusWidth" )
 
static const wxChar DefaultDrawLineWidthEntry [] = wxT( "DefaultDrawLineWidth" )
 
static const wxChar ShowHiddenPinsEntry [] = wxT( "ShowHiddenPins" )
 
static const wxChar HorzVertLinesOnlyEntry [] = wxT( "HorizVertLinesOnly" )
 
static const wxChar PreviewFramePositionXEntry [] = wxT( "PreviewFramePositionX" )
 
static const wxChar PreviewFramePositionYEntry [] = wxT( "PreviewFramePositionY" )
 
static const wxChar PreviewFrameWidthEntry [] = wxT( "PreviewFrameWidth" )
 
static const wxChar PreviewFrameHeightEntry [] = wxT( "PreviewFrameHeight" )
 
static const wxChar PrintDialogPositionXEntry [] = wxT( "PrintDialogPositionX" )
 
static const wxChar PrintDialogPositionYEntry [] = wxT( "PrintDialogPositionY" )
 
static const wxChar PrintDialogWidthEntry [] = wxT( "PrintDialogWidth" )
 
static const wxChar PrintDialogHeightEntry [] = wxT( "PrintDialogHeight" )
 
static const wxChar FindDialogPositionXEntry [] = wxT( "FindDialogPositionX" )
 
static const wxChar FindDialogPositionYEntry [] = wxT( "FindDialogPositionY" )
 
static const wxChar FindDialogWidthEntry [] = wxT( "FindDialogWidth" )
 
static const wxChar FindDialogHeightEntry [] = wxT( "FindDialogHeight" )
 
static const wxChar FindReplaceFlagsEntry [] = wxT( "LastFindReplaceFlags" )
 
static const wxChar FindStringEntry [] = wxT( "LastFindString" )
 
static const wxChar ReplaceStringEntry [] = wxT( "LastReplaceString" )
 
static const wxChar FindStringHistoryEntry [] = wxT( "FindStringHistoryList%d" )
 
static const wxChar ReplaceStringHistoryEntry [] = wxT( "ReplaceStringHistoryList%d" )
 
static const wxChar FieldNamesEntry [] = wxT( "FieldNames" )
 
static const wxChar SimulatorCommandEntry [] = wxT( "SimCmdLine" )
 
static const wxString ShowPageLimitsEntry = "ShowPageLimits"
 
static const wxString UnitsEntry = "Units"
 
static const wxString PrintMonochromeEntry = "PrintMonochrome"
 
static const wxString PrintSheetRefEntry = "PrintSheetReferenceAndTitleBlock"
 
static const wxString RepeatStepXEntry = "RepeatStepX"
 
static const wxString RepeatStepYEntry = "RepeatStepY"
 
static const wxString RepeatLabelIncrementEntry = "RepeatLabelIncrement"
 
static const wxChar defaultPinNumSizeEntry [] = wxT( "LibeditPinNumSize" )
 
static const wxChar defaultPinNameSizeEntry [] = wxT( "LibeditPinNameSize" )
 
static const wxChar DefaultPinLengthEntry [] = wxT( "DefaultPinLength" )
 
static const wxChar repeatLibLabelIncEntry [] = wxT( "LibeditRepeatLabelInc" )
 
static const wxChar pinRepeatStepEntry [] = wxT( "LibeditPinRepeatStep" )
 
static const wxChar repeatLibStepXEntry [] = wxT( "LibeditRepeatStepX" )
 
static const wxChar repeatLibStepYEntry [] = wxT( "LibeditRepeatStepY" )
 
static const wxChar showPinElectricalType [] = wxT( "LibeditShowPinElectricalType" )
 
static const wxString ShowGridEntryKeyword (wxT("ShowGrid"))
 Nonzero to show grid (suffix) More...
 
static const wxString GridColorEntryKeyword (wxT("GridColor"))
 Grid color ID (suffix) More...
 
static const wxString LastGridSizeIdKeyword (wxT("_LastGridSize"))
 Most recently used grid size (suffix) More...
 
static const wxString GalDisplayOptionsKeyword (wxT("GalDisplayOptions"))
 GAL Display Options. More...
 
static const wxString FirstRunShownKeyword (wxT("FirstRunShown"))
 
#define ENBL_ZOOM_NO_CENTER_KEY   wxT( "ZoomNoCenter" )
 
#define ENBL_MOUSEWHEEL_PAN_KEY   wxT( "MousewheelPAN" )
 
#define ENBL_MIDDLE_BUTT_PAN_KEY   wxT( "MiddleButtonPAN" )
 
#define MIDDLE_BUTT_PAN_LIMITED_KEY   wxT( "MiddleBtnPANLimited" )
 
#define ENBL_AUTO_PAN_KEY   wxT( "AutoPAN" )
 
static const wxString entryAutoSaveInterval = "AutoSaveInterval"
 Configuration file entry name for auto save interval. More...
 
static const wxString entryPerspective = "Perspective"
 Configuration file entry for wxAuiManger perspective. More...
 
static const wxString entryMruPath = "MostRecentlyUsedPath"
 Configuration file entry for most recently used path. More...
 
static const wxString entryPosY = "Pos_y"
 Y position of frame, in pixels (suffix) More...
 
static const wxString entryPosX = "Pos_x"
 X position of frame, in pixels (suffix) More...
 
static const wxString entrySizeY = "Size_y"
 Height of frame, in pixels (suffix) More...
 
static const wxString entrySizeX = "Size_x"
 Width of frame, in pixels (suffix) More...
 
static const wxString entryMaximized = "Maximized"
 Nonzero iff frame is maximized (suffix) More...
 
#define OPTKEY_LAYERBASE   wxT( "PlotLayer_%d" )
 
#define OPTKEY_PRINT_X_FINESCALE_ADJ   wxT( "PrintXFineScaleAdj" )
 
#define OPTKEY_PRINT_Y_FINESCALE_ADJ   wxT( "PrintYFineScaleAdj" )
 
#define OPTKEY_PRINT_SCALE   wxT( "PrintScale" )
 
#define OPTKEY_PRINT_PAGE_FRAME   wxT( "PrintPageFrame" )
 
#define OPTKEY_PRINT_MONOCHROME_MODE   wxT( "PrintMonochrome" )
 

Detailed Description

This page documents keys used in the KiCad configuration files.

config-strings

Macro Definition Documentation

#define CONFIG_PS_FINEWIDTH_ADJ   wxT( "PSPlotFineWidthAdj" )

Definition at line 63 of file pcbplot.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), and DIALOG_PLOT::init_Dialog().

#define ENBL_AUTO_PAN_KEY   wxT( "AutoPAN" )
#define ENBL_MIDDLE_BUTT_PAN_KEY   wxT( "MiddleButtonPAN" )

Definition at line 57 of file draw_panel.cpp.

#define ENBL_MOUSEWHEEL_PAN_KEY   wxT( "MousewheelPAN" )
#define ENBL_ZOOM_NO_CENTER_KEY   wxT( "ZoomNoCenter" )
#define MIDDLE_BUTT_PAN_LIMITED_KEY   wxT( "MiddleBtnPANLimited" )

Definition at line 58 of file draw_panel.cpp.

#define OPTKEY_LAYERBASE   wxT( "PlotLayer_%d" )
#define OPTKEY_LAYERBASE   wxT( "PlotLayer_%d" )
#define OPTKEY_PLOT_CHECK_ZONES   wxT( "CheckZonesBeforePlotting" )

Definition at line 64 of file pcbplot.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), and DIALOG_PLOT::init_Dialog().

#define OPTKEY_PLOT_X_FINESCALE_ADJ   wxT( "PlotXFineScaleAdj" )

Definition at line 61 of file pcbplot.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), and DIALOG_PLOT::init_Dialog().

#define OPTKEY_PLOT_Y_FINESCALE_ADJ   wxT( "PlotYFineScaleAdj" )

Definition at line 62 of file pcbplot.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), and DIALOG_PLOT::init_Dialog().

#define OPTKEY_PRINT_MODULE_SCALE   wxT( "PrintModuleScale" )
#define OPTKEY_PRINT_MONOCHROME_MODE   wxT( "PrintMonochrome" )
#define OPTKEY_PRINT_MONOCHROME_MODE   wxT( "PrintMonochrome" )
#define OPTKEY_PRINT_PADS_DRILL   wxT( "PrintPadsDrillOpt" )
#define OPTKEY_PRINT_PAGE_FRAME   wxT( "PrintPageFrame" )
#define OPTKEY_PRINT_PAGE_FRAME   wxT( "PrintPageFrame" )
#define OPTKEY_PRINT_PAGE_PER_LAYER   wxT( "PrintSinglePage" )
#define OPTKEY_PRINT_SCALE   wxT( "PrintScale" )
#define OPTKEY_PRINT_SCALE   wxT( "PrintScale" )
#define OPTKEY_PRINT_X_FINESCALE_ADJ   wxT( "PrintXFineScaleAdj" )
#define OPTKEY_PRINT_X_FINESCALE_ADJ   wxT( "PrintXFineScaleAdj" )
#define OPTKEY_PRINT_Y_FINESCALE_ADJ   wxT( "PrintYFineScaleAdj" )
#define OPTKEY_PRINT_Y_FINESCALE_ADJ   wxT( "PrintYFineScaleAdj" )

Function Documentation

static const wxString FirstRunShownKeyword ( wxT("FirstRunShown")  )
static
static const wxString GalDisplayOptionsKeyword ( wxT("GalDisplayOptions")  )
static

GAL Display Options.

Referenced by EDA_DRAW_FRAME::LoadSettings(), and EDA_DRAW_FRAME::SaveSettings().

static const wxString GridColorEntryKeyword ( wxT("GridColor")  )
static

Grid color ID (suffix)

Referenced by EDA_DRAW_FRAME::LoadSettings(), and EDA_DRAW_FRAME::SaveSettings().

static const wxString LastGridSizeIdKeyword ( wxT("_LastGridSize")  )
static

Most recently used grid size (suffix)

Referenced by EDA_DRAW_FRAME::LoadSettings(), and EDA_DRAW_FRAME::SaveSettings().

static const wxString ShowGridEntryKeyword ( wxT("ShowGrid")  )
static

Nonzero to show grid (suffix)

Referenced by EDA_DRAW_FRAME::LoadSettings(), and EDA_DRAW_FRAME::SaveSettings().

Variable Documentation

const wxChar AutoplaceAlignEntry[] = wxT( "AutoplaceAlign" )
const wxChar AutoplaceFieldsEntry[] = wxT( "AutoplaceFields" )
const wxChar AutoplaceJustifyEntry[] = wxT( "AutoplaceJustify" )
const wxChar DefaultBusWidthEntry[] = wxT( "DefaultBusWidth" )
static
const wxChar DefaultDrawLineWidthEntry[] = wxT( "DefaultDrawLineWidth" )
static
const wxChar DefaultPinLengthEntry[] = wxT( "DefaultPinLength" )
static
const wxChar defaultPinNameSizeEntry[] = wxT( "LibeditPinNameSize" )
static
const wxChar defaultPinNumSizeEntry[] = wxT( "LibeditPinNumSize" )
static
const wxString entryAutoSaveInterval = "AutoSaveInterval"
static

Configuration file entry name for auto save interval.

Definition at line 58 of file eda_base_frame.cpp.

Referenced by EDA_BASE_FRAME::LoadSettings(), and EDA_BASE_FRAME::SaveSettings().

const wxString entryMaximized = "Maximized"
static

Nonzero iff frame is maximized (suffix)

Definition at line 70 of file eda_base_frame.cpp.

Referenced by EDA_BASE_FRAME::LoadSettings().

const wxString entryMruPath = "MostRecentlyUsedPath"
static

Configuration file entry for most recently used path.

Definition at line 64 of file eda_base_frame.cpp.

Referenced by EDA_BASE_FRAME::LoadSettings(), and EDA_BASE_FRAME::SaveSettings().

const wxString entryPerspective = "Perspective"
static

Configuration file entry for wxAuiManger perspective.

Definition at line 61 of file eda_base_frame.cpp.

Referenced by EDA_BASE_FRAME::LoadSettings(), and EDA_BASE_FRAME::SaveSettings().

const wxString entryPosX = "Pos_x"
static

X position of frame, in pixels (suffix)

Definition at line 67 of file eda_base_frame.cpp.

Referenced by EDA_BASE_FRAME::LoadSettings().

const wxString entryPosY = "Pos_y"
static

Y position of frame, in pixels (suffix)

Definition at line 66 of file eda_base_frame.cpp.

Referenced by EDA_BASE_FRAME::LoadSettings().

const wxString entrySizeX = "Size_x"
static

Width of frame, in pixels (suffix)

Definition at line 69 of file eda_base_frame.cpp.

Referenced by EDA_BASE_FRAME::LoadSettings().

const wxString entrySizeY = "Size_y"
static

Height of frame, in pixels (suffix)

Definition at line 68 of file eda_base_frame.cpp.

Referenced by EDA_BASE_FRAME::LoadSettings().

const wxChar FieldNamesEntry[] = wxT( "FieldNames" )
static
const wxString FilterFootprintEntry = "FilterFootprint"
static
const wxChar FindDialogHeightEntry[] = wxT( "FindDialogHeight" )
static
const wxChar FindDialogPositionXEntry[] = wxT( "FindDialogPositionX" )
static
const wxChar FindDialogPositionYEntry[] = wxT( "FindDialogPositionY" )
static
const wxChar FindDialogWidthEntry[] = wxT( "FindDialogWidth" )
static
const wxChar FindReplaceFlagsEntry[] = wxT( "LastFindReplaceFlags" )
static
const wxChar FindStringEntry[] = wxT( "LastFindString" )
static
const wxChar FindStringHistoryEntry[] = wxT( "FindStringHistoryList%d" )
static
const wxChar FootprintPreviewEntry[] = wxT( "FootprintPreview" )
static
const wxChar HorzVertLinesOnlyEntry[] = wxT( "HorizVertLinesOnly" )
static
const wxString IconScaleEntry = "PcbIconScale"
static

Definition at line 78 of file footprint_edit_frame.cpp.

Referenced by FOOTPRINT_EDIT_FRAME::GetIconScale().

const wxString IconScaleEntry = "PcbIconScale"
static
const wxChar LibIconScaleEntry[] = wxT( "LibIconScale" )
const wxString MagneticPadsEntry = "PcbMagPadOpt"
static

Definition at line 90 of file pcb_edit_frame.cpp.

const wxString MagneticTracksEntry = "PcbMagTrackOpt"
static

Definition at line 91 of file pcb_edit_frame.cpp.

const wxChar pinRepeatStepEntry[] = wxT( "LibeditPinRepeatStep" )
static
const wxString PlotLineWidthEntry = "PlotLineWidth_mm"
static
const wxChar PreviewFrameHeightEntry[] = wxT( "PreviewFrameHeight" )
static
const wxChar PreviewFramePositionXEntry[] = wxT( "PreviewFramePositionX" )
static
const wxChar PreviewFramePositionYEntry[] = wxT( "PreviewFramePositionY" )
static
const wxChar PreviewFrameWidthEntry[] = wxT( "PreviewFrameWidth" )
static
const wxChar PrintDialogHeightEntry[] = wxT( "PrintDialogHeight" )
static
const wxChar PrintDialogPositionXEntry[] = wxT( "PrintDialogPositionX" )
static
const wxChar PrintDialogPositionYEntry[] = wxT( "PrintDialogPositionY" )
static
const wxChar PrintDialogWidthEntry[] = wxT( "PrintDialogWidth" )
static
const wxString PrintMonochromeEntry = "PrintMonochrome"
static

Definition at line 461 of file eeschema_config.cpp.

Referenced by SCH_EDIT_FRAME::GetConfigurationSettings().

const wxString PrintSheetRefEntry = "PrintSheetReferenceAndTitleBlock"
static

Definition at line 462 of file eeschema_config.cpp.

Referenced by SCH_EDIT_FRAME::GetConfigurationSettings().

const wxString RepeatLabelIncrementEntry = "RepeatLabelIncrement"
static

Definition at line 465 of file eeschema_config.cpp.

Referenced by SCH_EDIT_FRAME::GetConfigurationSettings().

const wxChar repeatLibLabelIncEntry[] = wxT( "LibeditRepeatLabelInc" )
static
const wxChar repeatLibStepXEntry[] = wxT( "LibeditRepeatStepX" )
static
const wxChar repeatLibStepYEntry[] = wxT( "LibeditRepeatStepY" )
static
const wxString RepeatStepXEntry = "RepeatStepX"
static

Definition at line 463 of file eeschema_config.cpp.

Referenced by SCH_EDIT_FRAME::GetConfigurationSettings().

const wxString RepeatStepYEntry = "RepeatStepY"
static

Definition at line 464 of file eeschema_config.cpp.

Referenced by SCH_EDIT_FRAME::GetConfigurationSettings().

const wxChar ReplaceStringEntry[] = wxT( "LastReplaceString" )
static
const wxChar ReplaceStringHistoryEntry[] = wxT( "ReplaceStringHistoryList%d" )
static
const wxChar RescueNeverShowEntry[] = wxT( "RescueNeverShow" )
const wxChar SchIconScaleEntry[] = wxT( "SchIconScale" )
const wxChar ShowHiddenPinsEntry[] = wxT( "ShowHiddenPins" )
static
const wxString ShowLayerManagerEntry = "ShowLayerManagerTools"
static
const wxString ShowMicrowaveEntry = "ShowMicrowaveTools"
static
const wxString ShowPageLimitsEntry = "ShowPageLimits"
static
const wxString ShowPageLimitsEntry = "ShowPageLimits"
static

Definition at line 459 of file eeschema_config.cpp.

Referenced by SCH_EDIT_FRAME::GetConfigurationSettings().

const wxChar showPinElectricalType[] = wxT( "LibeditShowPinElectricalType" )
static
const wxChar SimulatorCommandEntry[] = wxT( "SimCmdLine" )
static
const wxString UnitsEntry = "Units"
static

Definition at line 460 of file eeschema_config.cpp.

Referenced by SCH_EDIT_FRAME::GetConfigurationSettings().