KiCad PCB EDA Suite
Configuration strings
static const wxString PlotLineWidthEntry = "PlotLineWidth_mm"
 
static const wxString ShowMicrowaveEntry = "ShowMicrowaveTools"
 
static const wxString ShowLayerManagerEntry = "ShowLayerManagerTools"
 
static const wxString ShowPageLimitsEntry = "ShowPageLimits"
 
#define OPTKEY_LAYERBASE   wxT( "PlotLayer_%d" )
 
#define OPTKEY_PRINT_LINE_WIDTH   wxT( "PrintLineWidth" )
 
#define OPTKEY_PRINT_SCALE   wxT( "PrintScale" )
 
#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" )
 
static const wxChar FootprintPreviewEntry [] = wxT( "FootprintPreview" )
 
static const wxChar DefaultBusWidthEntry [] = wxT( "DefaultBusWidth" )
 
static const wxChar DefaultDrawLineWidthEntry [] = wxT( "DefaultDrawLineWidth" )
 
static const wxChar DefaultJctSizeEntry [] = wxT( "DefaultJunctionSize" )
 
static const wxChar ShowHiddenPinsEntry [] = wxT( "ShowHiddenPins" )
 
static const wxChar HorzVertLinesOnlyEntry [] = wxT( "HorizVertLinesOnly" )
 
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 defaultLibWidthEntry [] = wxT( "LibeditLibWidth" )
 
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 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...
 
static const wxString FirstRunShownKeyword (wxT("FirstRunShown"))
 
#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" )
 
#define UserUnitsEntryKeyword   "Units"
 User units. More...
 
#define ShowGridEntryKeyword   "ShowGrid"
 Nonzero to show grid (suffix) More...
 
#define GridColorEntryKeyword   "GridColor"
 Grid color ID (suffix) More...
 
#define LastGridSizeIdKeyword   "_LastGridSize"
 Most recently used grid size (suffix) More...
 
#define CanvasTypeKeyBase   "canvas_type"
 The key to store the canvas type in config. More...
 
#define USE_ICONS_IN_MENUS_KEY   wxT( "UseIconsInMenus" )
 
#define ICON_SCALE_KEY   wxT( "IconScale" )
 
#define AUTOSAVE_INTERVAL_KEY   wxT( "AutoSaveInterval" )
 
#define ENBL_ZOOM_NO_CENTER_KEY   wxT( "ZoomNoCenter" )
 
#define ENBL_MOUSEWHEEL_PAN_KEY   wxT( "MousewheelPAN" )
 
#define MIDDLE_BUTT_PAN_LIMITED_KEY   wxT( "MiddleBtnPANLimited" )
 
#define ENBL_AUTO_PAN_KEY   wxT( "AutoPAN" )
 
#define FILE_HISTORY_SIZE_KEY   wxT( "FileHistorySize" )
 
#define GAL_DISPLAY_OPTIONS_KEY   wxT( "GalDisplayOptions" )
 
#define GAL_ANTIALIASING_MODE_KEY   wxT( "OpenGLAntialiasingMode" )
 
#define CAIRO_ANTIALIASING_MODE_KEY   wxT( "CairoAntialiasingMode" )
 

Detailed Description

This page documents keys used in the KiCad configuration files.

config-strings

Macro Definition Documentation

◆ AUTOSAVE_INTERVAL_KEY

#define AUTOSAVE_INTERVAL_KEY   wxT( "AutoSaveInterval" )

Definition at line 47 of file pgm_base.h.

◆ CAIRO_ANTIALIASING_MODE_KEY

#define CAIRO_ANTIALIASING_MODE_KEY   wxT( "CairoAntialiasingMode" )

Definition at line 55 of file pgm_base.h.

◆ CanvasTypeKeyBase

#define CanvasTypeKeyBase   "canvas_type"

The key to store the canvas type in config.

This is the base key. can be a suffix if the canvas_type in config is specific to a frame

Definition at line 73 of file draw_frame.h.

◆ CONFIG_PS_FINEWIDTH_ADJ

#define CONFIG_PS_FINEWIDTH_ADJ   wxT( "PSPlotFineWidthAdj" )

Definition at line 62 of file pcbplot.h.

◆ ENBL_AUTO_PAN_KEY

#define ENBL_AUTO_PAN_KEY   wxT( "AutoPAN" )

Definition at line 51 of file pgm_base.h.

◆ ENBL_MOUSEWHEEL_PAN_KEY

#define ENBL_MOUSEWHEEL_PAN_KEY   wxT( "MousewheelPAN" )

Definition at line 49 of file pgm_base.h.

◆ ENBL_ZOOM_NO_CENTER_KEY

#define ENBL_ZOOM_NO_CENTER_KEY   wxT( "ZoomNoCenter" )

Definition at line 48 of file pgm_base.h.

◆ FILE_HISTORY_SIZE_KEY

#define FILE_HISTORY_SIZE_KEY   wxT( "FileHistorySize" )

Definition at line 52 of file pgm_base.h.

◆ GAL_ANTIALIASING_MODE_KEY

#define GAL_ANTIALIASING_MODE_KEY   wxT( "OpenGLAntialiasingMode" )

Definition at line 54 of file pgm_base.h.

◆ GAL_DISPLAY_OPTIONS_KEY

#define GAL_DISPLAY_OPTIONS_KEY   wxT( "GalDisplayOptions" )

Definition at line 53 of file pgm_base.h.

◆ GridColorEntryKeyword

#define GridColorEntryKeyword   "GridColor"

Grid color ID (suffix)

Definition at line 67 of file draw_frame.h.

◆ ICON_SCALE_KEY

#define ICON_SCALE_KEY   wxT( "IconScale" )

Definition at line 46 of file pgm_base.h.

◆ LastGridSizeIdKeyword

#define LastGridSizeIdKeyword   "_LastGridSize"

Most recently used grid size (suffix)

Definition at line 69 of file draw_frame.h.

◆ MIDDLE_BUTT_PAN_LIMITED_KEY

#define MIDDLE_BUTT_PAN_LIMITED_KEY   wxT( "MiddleBtnPANLimited" )

Definition at line 50 of file pgm_base.h.

◆ OPTKEY_LAYERBASE [1/2]

#define OPTKEY_LAYERBASE   wxT( "PlotLayer_%d" )

Definition at line 48 of file dialog_print_gerbview.cpp.

◆ OPTKEY_LAYERBASE [2/2]

#define OPTKEY_LAYERBASE   wxT( "PlotLayer_%d" )

Definition at line 53 of file pcbplot.h.

◆ OPTKEY_PLOT_CHECK_ZONES

#define OPTKEY_PLOT_CHECK_ZONES   wxT( "CheckZonesBeforePlotting" )

Definition at line 63 of file pcbplot.h.

◆ OPTKEY_PLOT_X_FINESCALE_ADJ

#define OPTKEY_PLOT_X_FINESCALE_ADJ   wxT( "PlotXFineScaleAdj" )

Definition at line 60 of file pcbplot.h.

◆ OPTKEY_PLOT_Y_FINESCALE_ADJ

#define OPTKEY_PLOT_Y_FINESCALE_ADJ   wxT( "PlotYFineScaleAdj" )

Definition at line 61 of file pcbplot.h.

◆ OPTKEY_PRINT_LINE_WIDTH

#define OPTKEY_PRINT_LINE_WIDTH   wxT( "PrintLineWidth" )

Definition at line 54 of file pcbplot.h.

◆ OPTKEY_PRINT_MONOCHROME_MODE [1/2]

#define OPTKEY_PRINT_MONOCHROME_MODE   wxT( "PrintMonochrome" )

Definition at line 53 of file dialog_print_gerbview.cpp.

◆ OPTKEY_PRINT_MONOCHROME_MODE [2/2]

#define OPTKEY_PRINT_MONOCHROME_MODE   wxT( "PrintMonochrome" )

Definition at line 57 of file pcbplot.h.

◆ OPTKEY_PRINT_PADS_DRILL

#define OPTKEY_PRINT_PADS_DRILL   wxT( "PrintPadsDrillOpt" )

Definition at line 59 of file pcbplot.h.

◆ OPTKEY_PRINT_PAGE_FRAME [1/2]

#define OPTKEY_PRINT_PAGE_FRAME   wxT( "PrintPageFrame" )

Definition at line 52 of file dialog_print_gerbview.cpp.

◆ OPTKEY_PRINT_PAGE_FRAME [2/2]

#define OPTKEY_PRINT_PAGE_FRAME   wxT( "PrintPageFrame" )

Definition at line 56 of file pcbplot.h.

◆ OPTKEY_PRINT_PAGE_PER_LAYER

#define OPTKEY_PRINT_PAGE_PER_LAYER   wxT( "PrintSinglePage" )

Definition at line 58 of file pcbplot.h.

◆ OPTKEY_PRINT_SCALE [1/2]

#define OPTKEY_PRINT_SCALE   wxT( "PrintScale" )

Definition at line 51 of file dialog_print_gerbview.cpp.

◆ OPTKEY_PRINT_SCALE [2/2]

#define OPTKEY_PRINT_SCALE   wxT( "PrintScale" )

Definition at line 55 of file pcbplot.h.

◆ OPTKEY_PRINT_X_FINESCALE_ADJ

#define OPTKEY_PRINT_X_FINESCALE_ADJ   wxT( "PrintXFineScaleAdj" )

Definition at line 49 of file dialog_print_gerbview.cpp.

◆ OPTKEY_PRINT_Y_FINESCALE_ADJ

#define OPTKEY_PRINT_Y_FINESCALE_ADJ   wxT( "PrintYFineScaleAdj" )

Definition at line 50 of file dialog_print_gerbview.cpp.

◆ ShowGridEntryKeyword

#define ShowGridEntryKeyword   "ShowGrid"

Nonzero to show grid (suffix)

Definition at line 65 of file draw_frame.h.

◆ USE_ICONS_IN_MENUS_KEY

#define USE_ICONS_IN_MENUS_KEY   wxT( "UseIconsInMenus" )

Definition at line 45 of file pgm_base.h.

◆ UserUnitsEntryKeyword

#define UserUnitsEntryKeyword   "Units"

User units.

Definition at line 63 of file draw_frame.h.

Function Documentation

◆ FirstRunShownKeyword()

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

Variable Documentation

◆ AutoplaceAlignEntry

const wxChar AutoplaceAlignEntry[] = wxT( "AutoplaceAlign" )

◆ AutoplaceFieldsEntry

const wxChar AutoplaceFieldsEntry[] = wxT( "AutoplaceFields" )

◆ AutoplaceJustifyEntry

const wxChar AutoplaceJustifyEntry[] = wxT( "AutoplaceJustify" )

◆ DefaultBusWidthEntry

const wxChar DefaultBusWidthEntry[] = wxT( "DefaultBusWidth" )
static

◆ DefaultDrawLineWidthEntry

const wxChar DefaultDrawLineWidthEntry[] = wxT( "DefaultDrawLineWidth" )
static

◆ DefaultJctSizeEntry

const wxChar DefaultJctSizeEntry[] = wxT( "DefaultJunctionSize" )
static

◆ defaultLibWidthEntry

const wxChar defaultLibWidthEntry[] = wxT( "LibeditLibWidth" )
static

◆ DefaultPinLengthEntry

const wxChar DefaultPinLengthEntry[] = wxT( "DefaultPinLength" )
static

◆ defaultPinNameSizeEntry

const wxChar defaultPinNameSizeEntry[] = wxT( "LibeditPinNameSize" )
static

◆ defaultPinNumSizeEntry

const wxChar defaultPinNumSizeEntry[] = wxT( "LibeditPinNumSize" )
static

◆ entryAutoSaveInterval

const wxString entryAutoSaveInterval = "AutoSaveInterval"
static

Configuration file entry name for auto save interval.

Definition at line 56 of file eda_base_frame.cpp.

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

◆ entryMaximized

const wxString entryMaximized = "Maximized"
static

Nonzero iff frame is maximized (suffix)

Definition at line 68 of file eda_base_frame.cpp.

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ entryMruPath

const wxString entryMruPath = "MostRecentlyUsedPath"
static

Configuration file entry for most recently used path.

Definition at line 62 of file eda_base_frame.cpp.

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

◆ entryPerspective

const wxString entryPerspective = "Perspective"
static

Configuration file entry for wxAuiManger perspective.

Definition at line 59 of file eda_base_frame.cpp.

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

◆ entryPosX

const wxString entryPosX = "Pos_x"
static

X position of frame, in pixels (suffix)

Definition at line 65 of file eda_base_frame.cpp.

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ entryPosY

const wxString entryPosY = "Pos_y"
static

Y position of frame, in pixels (suffix)

Definition at line 64 of file eda_base_frame.cpp.

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ entrySizeX

const wxString entrySizeX = "Size_x"
static

Width of frame, in pixels (suffix)

Definition at line 67 of file eda_base_frame.cpp.

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ entrySizeY

const wxString entrySizeY = "Size_y"
static

Height of frame, in pixels (suffix)

Definition at line 66 of file eda_base_frame.cpp.

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ FieldNamesEntry

const wxChar FieldNamesEntry[] = wxT( "FieldNames" )
static

◆ FilterFootprintEntry

const wxString FilterFootprintEntry = "FilterFootprint"
static

◆ FindReplaceFlagsEntry

const wxChar FindReplaceFlagsEntry[] = wxT( "LastFindReplaceFlags" )
static

◆ FindStringEntry

const wxChar FindStringEntry[] = wxT( "LastFindString" )
static

◆ FindStringHistoryEntry

const wxChar FindStringHistoryEntry[] = wxT( "FindStringHistoryList%d" )
static

◆ FootprintPreviewEntry

const wxChar FootprintPreviewEntry[] = wxT( "FootprintPreview" )
static

◆ HorzVertLinesOnlyEntry

const wxChar HorzVertLinesOnlyEntry[] = wxT( "HorizVertLinesOnly" )
static

◆ pinRepeatStepEntry

const wxChar pinRepeatStepEntry[] = wxT( "LibeditPinRepeatStep" )
static

◆ PlotLineWidthEntry

const wxString PlotLineWidthEntry = "PlotLineWidth_mm"
static

◆ PrintMonochromeEntry

const wxString PrintMonochromeEntry = "PrintMonochrome"
static

Definition at line 336 of file eeschema_config.cpp.

Referenced by SCH_EDIT_FRAME::GetConfigurationSettings().

◆ PrintSheetRefEntry

const wxString PrintSheetRefEntry = "PrintSheetReferenceAndTitleBlock"
static

Definition at line 337 of file eeschema_config.cpp.

Referenced by SCH_EDIT_FRAME::GetConfigurationSettings().

◆ RepeatLabelIncrementEntry

const wxString RepeatLabelIncrementEntry = "RepeatLabelIncrement"
static

Definition at line 340 of file eeschema_config.cpp.

Referenced by SCH_EDIT_FRAME::GetConfigurationSettings().

◆ repeatLibLabelIncEntry

const wxChar repeatLibLabelIncEntry[] = wxT( "LibeditRepeatLabelInc" )
static

◆ repeatLibStepXEntry

const wxChar repeatLibStepXEntry[] = wxT( "LibeditRepeatStepX" )
static

◆ repeatLibStepYEntry

const wxChar repeatLibStepYEntry[] = wxT( "LibeditRepeatStepY" )
static

◆ RepeatStepXEntry

const wxString RepeatStepXEntry = "RepeatStepX"
static

Definition at line 338 of file eeschema_config.cpp.

Referenced by SCH_EDIT_FRAME::GetConfigurationSettings().

◆ RepeatStepYEntry

const wxString RepeatStepYEntry = "RepeatStepY"
static

Definition at line 339 of file eeschema_config.cpp.

Referenced by SCH_EDIT_FRAME::GetConfigurationSettings().

◆ ReplaceStringEntry

const wxChar ReplaceStringEntry[] = wxT( "LastReplaceString" )
static

◆ ReplaceStringHistoryEntry

const wxChar ReplaceStringHistoryEntry[] = wxT( "ReplaceStringHistoryList%d" )
static

◆ RescueNeverShowEntry

const wxChar RescueNeverShowEntry[] = wxT( "RescueNeverShow" )

◆ ShowHiddenPinsEntry

const wxChar ShowHiddenPinsEntry[] = wxT( "ShowHiddenPins" )
static

◆ ShowLayerManagerEntry

const wxString ShowLayerManagerEntry = "ShowLayerManagerTools"
static

◆ ShowMicrowaveEntry

const wxString ShowMicrowaveEntry = "ShowMicrowaveTools"
static

◆ ShowPageLimitsEntry [1/2]

const wxString ShowPageLimitsEntry = "ShowPageLimits"
static

◆ ShowPageLimitsEntry [2/2]

const wxString ShowPageLimitsEntry = "ShowPageLimits"
static

Definition at line 334 of file eeschema_config.cpp.

Referenced by SCH_EDIT_FRAME::GetConfigurationSettings().

◆ showPinElectricalType

const wxChar showPinElectricalType[] = wxT( "LibeditShowPinElectricalType" )
static

◆ SimulatorCommandEntry

const wxChar SimulatorCommandEntry[] = wxT( "SimCmdLine" )
static

◆ UnitsEntry

const wxString UnitsEntry = "Units"
static

Definition at line 335 of file eeschema_config.cpp.

Referenced by SCH_EDIT_FRAME::GetConfigurationSettings().