haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Pull existing settings into Doxygen module

This commit is contained in:
Chris Pavlina 2016-05-12 15:45:47 -04:00
parent 84d3fbfd68
commit 0f407a756c
14 changed files with 107 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
common/basicframe.cpp
View File

@ -3,7 +3,7 @@
*
* Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 2013-2015 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 1992-2015 KiCad Developers, see AUTHORS.txt for contributors.
* Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -46,15 +46,24 @@
const wxChar traceAutoSave[] = wxT( "KicadAutoSave" );
///@{
/// \ingroup config
/// Configuration file entry name for auto save interval.
static const wxChar entryAutoSaveInterval[] = wxT( "AutoSaveInterval" );
static const wxString entryAutoSaveInterval = "AutoSaveInterval";
/// Configuration file entry for wxAuiManger perspective.
static const wxChar entryPerspective[] = wxT( "Perspective" );
static const wxString entryPerspective = "Perspective";
/// Configuration file entry for most recently used path.
static const wxChar entryMruPath[] = wxT( "MostRecentlyUsedPath" );
static const wxString entryMruPath = "MostRecentlyUsedPath";
static const wxString entryPosY = "Pos_y"; ///< Y position of frame, in pixels (suffix)
static const wxString entryPosX = "Pos_x"; ///< X position of frame, in pixels (suffix)
static const wxString entrySizeY = "Size_y"; ///< Height of frame, in pixels (suffix)
static const wxString entrySizeX = "Size_x"; ///< Width of frame, in pixels (suffix)
static const wxString entryMaximized = "Maximized"; ///< Nonzero iff frame is maximized (suffix)
///@}
EDA_BASE_FRAME::EDA_BASE_FRAME( wxWindow* aParent, FRAME_T aFrameType,
const wxString& aTitle, const wxPoint& aPos, const wxSize& aSize,
@ -218,19 +227,19 @@ void EDA_BASE_FRAME::LoadSettings( wxConfigBase* aCfg )
wxString baseCfgName = ConfigBaseName();
wxString text = baseCfgName + wxT( "Pos_x" );
wxString text = baseCfgName + entryPosX;
aCfg->Read( text, &m_FramePos.x );
text = baseCfgName + wxT( "Pos_y" );
text = baseCfgName + entryPosY;
aCfg->Read( text, &m_FramePos.y );
text = baseCfgName + wxT( "Size_x" );
text = baseCfgName + entrySizeX;
aCfg->Read( text, &m_FrameSize.x, 600 );
text = baseCfgName + wxT( "Size_y" );
text = baseCfgName + entrySizeY;
aCfg->Read( text, &m_FrameSize.y, 400 );
text = baseCfgName + wxT( "Maximized" );
text = baseCfgName + entryMaximized;
aCfg->Read( text, &maximized, 0 );
if( m_hasAutoSave )

10
common/draw_frame.cpp
View File

@ -61,12 +61,20 @@
static const wxString traceScrollSettings( wxT( "KicadScrollSettings" ) );
// Configuration entry names.
///@{
/// \ingroup config
/// Nonzero iff fullscreen cursor is to be used (suffix)
static const wxString CursorShapeEntryKeyword( wxT( "CursorShape" ) );
/// Nonzero to show grid (suffix)
static const wxString ShowGridEntryKeyword( wxT( "ShowGrid" ) );
/// Grid color ID (suffix)
static const wxString GridColorEntryKeyword( wxT( "GridColor" ) );
/// Most recently used grid size (suffix)
static const wxString LastGridSizeIdKeyword( wxT( "_LastGridSize" ) );
///@}
/**
* Integer to set the maximum number of undo items on the stack. If zero,
* undo items are unlimited.

6
common/draw_panel.cpp
View File

@ -46,13 +46,17 @@ static const int CURSOR_SIZE = 12; ///< Cursor size in pixels
#define CLIP_BOX_PADDING 2
// keys to store options in config:
///@{
/// \ingroup config
#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" )
///@}
// Definitions for enabling and disabling debugging features in drawpanel.cpp.
// Please don't forget to turn these off before making any commits to Launchpad.

3
cvpcb/cvpcb.h
View File

@ -31,9 +31,6 @@
// Define print format to display a schematic component line
#define CMP_FORMAT wxT( "%3d %8s - %16s : %s" )
#define FILTERFOOTPRINTKEY "FilterFootprint"
extern const wxString EquFileExtension;
extern const wxString EquFilesWildcard;

16
cvpcb/cvpcb_mainframe.cpp
View File

@ -54,10 +54,16 @@
#define FRAME_MIN_SIZE_Y 300
// option key to close CvPcb after saving files
static const wxString KeepCvpcbOpenEntry( wxT( "KeepCvpcbOpen" ) );
static const wxString FootprintDocFileEntry( wxT( "footprints_doc_file" ) );
///@{
/// \ingroup config
/// Nonzero iff cvpcb should be kept open after saving files
static const wxString KeepCvpcbOpenEntry = "KeepCvpcbOpen";
static const wxString FootprintDocFileEntry = "footprints_doc_file";
static const wxString FilterFootprintEntry = "FilterFootprint";
///@}
BEGIN_EVENT_TABLE( CVPCB_MAINFRAME, KIWAY_PLAYER )
@ -210,7 +216,7 @@ void CVPCB_MAINFRAME::LoadSettings( wxConfigBase* aCfg )
aCfg->Read( KeepCvpcbOpenEntry, &m_keepCvpcbOpen, true );
aCfg->Read( FootprintDocFileEntry, &m_DocModulesFileName,
DEFAULT_FOOTPRINTS_LIST_FILENAME );
aCfg->Read( FILTERFOOTPRINTKEY, &m_filteringOptions, FOOTPRINTS_LISTBOX::UNFILTERED_FP_LIST );
aCfg->Read( FilterFootprintEntry, &m_filteringOptions, FOOTPRINTS_LISTBOX::UNFILTERED_FP_LIST );
}
@ -220,7 +226,7 @@ void CVPCB_MAINFRAME::SaveSettings( wxConfigBase* aCfg )
aCfg->Write( KeepCvpcbOpenEntry, m_keepCvpcbOpen );
aCfg->Write( FootprintDocFileEntry, m_DocModulesFileName );
aCfg->Write( FILTERFOOTPRINTKEY, m_filteringOptions );
aCfg->Write( FilterFootprintEntry, m_filteringOptions );
}

4
eeschema/autoplace_fields.cpp
View File

@ -125,8 +125,8 @@ public:
:m_screen( aScreen ), m_component( aComponent )
{
m_component->GetFields( m_fields, /* aVisibleOnly */ true );
Kiface().KifaceSettings()->Read( AUTOPLACE_JUSTIFY_KEY, &m_allow_rejustify, true );
Kiface().KifaceSettings()->Read( AUTOPLACE_ALIGN_KEY, &m_align_to_grid, false );
Kiface().KifaceSettings()->Read( AutoplaceJustifyEntry, &m_allow_rejustify, true );
Kiface().KifaceSettings()->Read( AutoplaceAlignEntry, &m_align_to_grid, false );
m_comp_bbox = m_component->GetBodyBoundingBox();
m_fbox_size = ComputeFBoxSize( /* aDynamic */ true );

4
eeschema/dialogs/dialog_eeschema_config.cpp
View File

@ -130,7 +130,7 @@ DIALOG_EESCHEMA_CONFIG::DIALOG_EESCHEMA_CONFIG( wxWindow* aParent,
// Load setting for cache rescue
m_config = Kiface().KifaceSettings();
bool rescueNeverShow = false;
m_config->Read( RESCUE_NEVER_SHOW_KEY, &rescueNeverShow, false );
m_config->Read( RescueNeverShowEntry, &rescueNeverShow, false );
m_cbRescue->SetValue( !rescueNeverShow );
wxString msg = wxString::Format( _(
@ -250,7 +250,7 @@ void DIALOG_EESCHEMA_CONFIG::OnOkClick( wxCommandEvent& event )
*m_callers_lib_names = list;
}
m_config->Write( RESCUE_NEVER_SHOW_KEY, ! m_cbRescue->GetValue() );
m_config->Write( RescueNeverShowEntry, ! m_cbRescue->GetValue() );
EndModal( wxID_OK );
}

2
eeschema/dialogs/dialog_rescue_each.cpp
View File

@ -289,7 +289,7 @@ void DIALOG_RESCUE_EACH::OnNeverShowClick( wxCommandEvent& aEvent )
if( resp == wxID_YES )
{
m_Config->Write( RESCUE_NEVER_SHOW_KEY, true );
m_Config->Write( RescueNeverShowEntry, true );
m_Rescuer->m_chosen_candidates.clear();
Close();
}

31
eeschema/eeschema_config.cpp
View File

@ -494,10 +494,13 @@ void SCH_EDIT_FRAME::SaveProjectSettings( bool aAskForSave )
prj.ConfigSave( Kiface().KifaceSearch(), GROUP_SCH_EDITOR, GetProjectFileParametersList() );
}
///@{
/// \ingroup config
static const wxChar AutoplaceFieldsEntry[] = wxT( "AutoplaceFields" );
static const wxChar AutoplaceJustifyEntry[] = AUTOPLACE_JUSTIFY_KEY;
static const wxChar AutoplaceAlignEntry[] = AUTOPLACE_ALIGN_KEY;
const wxChar RescueNeverShowEntry[] = wxT( "RescueNeverShow" );
const wxChar AutoplaceFieldsEntry[] = wxT( "AutoplaceFields" );
const wxChar AutoplaceJustifyEntry[] = wxT( "AutoplaceJustify" );
const wxChar AutoplaceAlignEntry[] = wxT( "AutoplaceAlign" );
static const wxChar DefaultBusWidthEntry[] = wxT( "DefaultBusWidth" );
static const wxChar DefaultDrawLineWidthEntry[] = wxT( "DefaultDrawLineWidth" );
static const wxChar ShowHiddenPinsEntry[] = wxT( "ShowHiddenPins" );
@ -521,6 +524,13 @@ static const wxChar FindStringHistoryEntry[] = wxT( "FindStringHistoryList%
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";
// Library editor wxConfig entry names.
static const wxChar lastLibExportPathEntry[] = wxT( "LastLibraryExportPath" );
@ -533,33 +543,34 @@ static const wxChar pinRepeatStepEntry[] = wxT( "LibeditPinRepeatStep"
static const wxChar repeatLibStepXEntry[] = wxT( "LibeditRepeatStepX" );
static const wxChar repeatLibStepYEntry[] = wxT( "LibeditRepeatStepY" );
///@}
PARAM_CFG_ARRAY& SCH_EDIT_FRAME::GetConfigurationSettings()
{
if( !m_configSettings.empty() )
return m_configSettings;
m_configSettings.push_back( new PARAM_CFG_BOOL( true, wxT( "ShowPageLimits" ),
m_configSettings.push_back( new PARAM_CFG_BOOL( true, ShowPageLimitsEntry,
&m_showPageLimits, true ) );
m_configSettings.push_back( new PARAM_CFG_INT( true, wxT( "Units" ),
m_configSettings.push_back( new PARAM_CFG_INT( true, UnitsEntry,
(int*)&g_UserUnit, MILLIMETRES ) );
m_configSettings.push_back( new PARAM_CFG_BOOL( true, wxT( "PrintMonochrome" ),
m_configSettings.push_back( new PARAM_CFG_BOOL( true, PrintMonochromeEntry,
&m_printMonochrome, true ) );
m_configSettings.push_back( new PARAM_CFG_BOOL( true, wxT( "PrintSheetReferenceAndTitleBlock" ),
m_configSettings.push_back( new PARAM_CFG_BOOL( true, PrintSheetRefEntry,
&m_printSheetReference, true ) );
m_configSettings.push_back( new PARAM_CFG_INT( true, wxT( "RepeatStepX" ),
m_configSettings.push_back( new PARAM_CFG_INT( true, RepeatStepXEntry,
&m_repeatStep.x,
DEFAULT_REPEAT_OFFSET_X,
-REPEAT_OFFSET_MAX,
REPEAT_OFFSET_MAX ) );
m_configSettings.push_back( new PARAM_CFG_INT( true, wxT( "RepeatStepY" ),
m_configSettings.push_back( new PARAM_CFG_INT( true, RepeatStepYEntry,
&m_repeatStep.y,
DEFAULT_REPEAT_OFFSET_Y,
-REPEAT_OFFSET_MAX,
REPEAT_OFFSET_MAX ) );
m_configSettings.push_back( new PARAM_CFG_INT( true, wxT( "RepeatLabelIncrement" ),
m_configSettings.push_back( new PARAM_CFG_INT( true, RepeatLabelIncrementEntry,
&m_repeatDeltaLabel,
DEFAULT_REPEAT_LABEL_INC, -10, +10 ) );
return m_configSettings;

10
eeschema/eeschema_config.h
View File

@ -7,11 +7,9 @@
#include <config_params.h>
// a key to read write in user config the visibility of the rescue library dialog
#define RESCUE_NEVER_SHOW_KEY wxT("RescueNeverShow")
// define autoplace key here to avoid having to take the long trip to get at the SCH_EDIT_FRAME
#define AUTOPLACE_JUSTIFY_KEY wxT("AutoplaceJustify")
#define AUTOPLACE_ALIGN_KEY wxT("AutoplaceAlign")
extern const wxChar RescueNeverShowEntry[];
extern const wxChar AutoplaceFieldsEntry[];
extern const wxChar AutoplaceJustifyEntry[];
extern const wxChar AutoplaceAlignEntry[];
#endif // EESCHEMA_CONFIG_H

2
eeschema/files-io.cpp
View File

@ -312,7 +312,7 @@ bool SCH_EDIT_FRAME::OpenProjectFiles( const std::vector<wxString>& aFileSet, in
// Only do this if RescueNeverShow was not set.
wxConfigBase *config = Kiface().KifaceSettings();
bool rescueNeverShow = false;
config->Read( RESCUE_NEVER_SHOW_KEY, &rescueNeverShow, false );
config->Read( RescueNeverShowEntry, &rescueNeverShow, false );
if( !rescueNeverShow )
{

6
gerbview/pcbplot.h
View File

@ -29,7 +29,9 @@
#ifndef PCBPLOT_H
#define PCBPLOT_H
/* Shared Config keys for plot and print */
///@{
/// \ingroup config
#define OPTKEY_LAYERBASE wxT( "PlotLayer_%d" )
#define OPTKEY_PRINT_X_FINESCALE_ADJ wxT( "PrintXFineScaleAdj" )
#define OPTKEY_PRINT_Y_FINESCALE_ADJ wxT( "PrintYFineScaleAdj" )
@ -37,4 +39,6 @@
#define OPTKEY_PRINT_PAGE_FRAME wxT( "PrintPageFrame" )
#define OPTKEY_PRINT_MONOCHROME_MODE wxT( "PrintMonochrome" )
///@}
#endif // ifndef PCBPLOT_H

42
pcbnew/pcbframe.cpp
View File

@ -80,13 +80,17 @@
#include <gal/graphics_abstraction_layer.h>
#include <boost/bind.hpp>
// Keys used in read/write config
#define OPTKEY_DEFAULT_LINEWIDTH_VALUE wxT( "PlotLineWidth_mm" )
#define PCB_MAGNETIC_PADS_OPT wxT( "PcbMagPadOpt" )
#define PCB_MAGNETIC_TRACKS_OPT wxT( "PcbMagTrackOpt" )
#define SHOW_MICROWAVE_TOOLS wxT( "ShowMicrowaveTools" )
#define SHOW_LAYER_MANAGER_TOOLS wxT( "ShowLayerManagerTools" )
#define SHOW_PAGE_LIMITS_KEY wxT( "ShowPageLimits" )
///@{
/// \ingroup config
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";
///@}
BEGIN_EVENT_TABLE( PCB_EDIT_FRAME, PCB_BASE_FRAME )
@ -724,7 +728,7 @@ void PCB_EDIT_FRAME::LoadSettings( wxConfigBase* aCfg )
wxConfigLoadSetups( aCfg, GetConfigurationSettings() );
double dtmp;
aCfg->Read( OPTKEY_DEFAULT_LINEWIDTH_VALUE, &dtmp, 0.1 ); // stored in mm
aCfg->Read( PlotLineWidthEntry, &dtmp, 0.1 ); // stored in mm
if( dtmp < 0.01 )
dtmp = 0.01;
@ -734,11 +738,11 @@ void PCB_EDIT_FRAME::LoadSettings( wxConfigBase* aCfg )
g_DrawDefaultLineThickness = Millimeter2iu( dtmp );
aCfg->Read( PCB_MAGNETIC_PADS_OPT, &g_MagneticPadOption );
aCfg->Read( PCB_MAGNETIC_TRACKS_OPT, &g_MagneticTrackOption );
aCfg->Read( SHOW_MICROWAVE_TOOLS, &m_show_microwave_tools );
aCfg->Read( SHOW_LAYER_MANAGER_TOOLS, &m_show_layer_manager_tools );
aCfg->Read( SHOW_PAGE_LIMITS_KEY, &m_showPageLimits );
aCfg->Read( MagneticPadsEntry, &g_MagneticPadOption );
aCfg->Read( MagneticTracksEntry, &g_MagneticTrackOption );
aCfg->Read( ShowMicrowaveEntry, &m_show_microwave_tools );
aCfg->Read( ShowLayerManagerEntry, &m_show_layer_manager_tools );
aCfg->Read( ShowPageLimitsEntry, &m_showPageLimits );
}
@ -749,12 +753,12 @@ void PCB_EDIT_FRAME::SaveSettings( wxConfigBase* aCfg )
wxConfigSaveSetups( aCfg, GetConfigurationSettings() );
// This value is stored in mm )
aCfg->Write( OPTKEY_DEFAULT_LINEWIDTH_VALUE, MM_PER_IU * g_DrawDefaultLineThickness );
aCfg->Write( PCB_MAGNETIC_PADS_OPT, (long) g_MagneticPadOption );
aCfg->Write( PCB_MAGNETIC_TRACKS_OPT, (long) g_MagneticTrackOption );
aCfg->Write( SHOW_MICROWAVE_TOOLS, (long) m_show_microwave_tools );
aCfg->Write( SHOW_LAYER_MANAGER_TOOLS, (long)m_show_layer_manager_tools );
aCfg->Write( SHOW_PAGE_LIMITS_KEY, m_showPageLimits );
aCfg->Write( PlotLineWidthEntry, MM_PER_IU * g_DrawDefaultLineThickness );
aCfg->Write( MagneticPadsEntry, (long) g_MagneticPadOption );
aCfg->Write( MagneticTracksEntry, (long) g_MagneticTrackOption );
aCfg->Write( ShowMicrowaveEntry, (long) m_show_microwave_tools );
aCfg->Write( ShowLayerManagerEntry, (long)m_show_layer_manager_tools );
aCfg->Write( ShowPageLimitsEntry, m_showPageLimits );
}

6
pcbnew/pcbplot.h
View File

@ -46,7 +46,9 @@ class ZONE_CONTAINER;
class BOARD;
class REPORTER;
// Shared Config keys for plot and print
///@{
/// \ingroup config
#define OPTKEY_LAYERBASE wxT( "PlotLayer_%d" )
#define OPTKEY_PRINT_X_FINESCALE_ADJ wxT( "PrintXFineScaleAdj" )
#define OPTKEY_PRINT_Y_FINESCALE_ADJ wxT( "PrintYFineScaleAdj" )
@ -60,6 +62,8 @@ class REPORTER;
#define OPTKEY_PLOT_Y_FINESCALE_ADJ wxT( "PlotYFineScaleAdj" )
#define CONFIG_PS_FINEWIDTH_ADJ wxT( "PSPlotFineWidthAdj" )
///@}
// Define min and max reasonable values for plot/print scale
#define PLOT_MIN_SCALE 0.01
#define PLOT_MAX_SCALE 100.0