KiCad PCB EDA Suite
Loading...
Searching...
No Matches
common_settings.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2020 Jon Evans <[email protected]>
5 * Copyright (C) 2020, 2023 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#ifndef _COMMON_SETTINGS_H
22#define _COMMON_SETTINGS_H
23
26
27
29{
30 // WARNING: these are encoded as integers in the file, so don't change their values.
31 DRAG_ANY = -2,
33 SELECT,
34 ZOOM,
35 PAN,
36 NONE
37};
38
39enum class ICON_THEME
40{
41 LIGHT,
42 DARK,
43 AUTO
44};
45
46
48{
49public:
51 {
61 };
62
64 {
65 bool enabled;
70
72 unsigned long long limit_total_size;
73 };
74
76 {
78 };
79
80 struct INPUT
81 {
90
94
98
102
104 };
105
106 struct GRAPHICS
107 {
110 };
111
112 struct SESSION
113 {
115 std::vector<wxString> pinned_symbol_libs;
116 std::vector<wxString> pinned_fp_libs;
117 };
118
119 struct SYSTEM
120 {
122 wxString text_editor;
125 wxString language;
128 wxString working_dir;
130 };
131
133 {
139 };
140
142 {
146 };
147
149 {
151 };
152
154 {
155 wxString name;
156 wxString path;
157 wxString authType;
158 wxString username;
159 wxString ssh_path;
160 bool active;
162 };
163
164 struct GIT
165 {
166 std::vector<GIT_REPOSITORY> repositories;
168 wxString authorName;
169 wxString authorEmail;
170 };
171
172 struct API
173 {
176 };
177
179
180 virtual ~COMMON_SETTINGS() {}
181
182 virtual bool MigrateFromLegacy( wxConfigBase* aLegacyConfig ) override;
183
187 void InitializeEnvironment();
188
189private:
190 bool migrateSchema0to1();
191 bool migrateSchema1to2();
192 bool migrateSchema2to3();
193
195 {
196 wxString m_Alias; // alias to the base path
197 wxString m_Pathvar; // base path as stored in the config file
198 wxString m_Pathexp; // expanded base path
199 wxString m_Description; // description of the aliased path
200 };
201
202 static bool getLegacy3DHollerith( const std::string& aString, size_t& aIndex,
203 wxString& aResult );
204 bool readLegacy3DResolverCfg( const wxString& aPath,
205 std::vector<LEGACY_3D_SEARCH_PATH>& aSearchPaths );
206
207public:
209
211
213
215
217
219
221
223
225
227
229
231};
232
233#endif
NETCLASS_PANEL m_NetclassPanel
APPEARANCE m_Appearance
virtual ~COMMON_SETTINGS()
PACKAGE_MANAGER m_PackageManager
AUTO_BACKUP m_Backup
DO_NOT_SHOW_AGAIN m_DoNotShowAgain
ENVIRONMENT m_Env
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig)
Migrates from wxConfig to JSON-based configuration.
MOUSE_DRAG_ACTION
ICON_THEME
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
#define KICOMMON_API
Definition: kicommon.h:28
int min_interval
Minimum time, in seconds, between subsequent backups.
bool backup_on_autosave
Trigger a backup on autosave.
unsigned long long limit_total_size
Maximum total size of backups (bytes), 0 for unlimited.
int limit_total_files
Maximum number of backup archives to retain.
int limit_daily_files
Maximum files to keep per day, 0 for unlimited.
bool enabled
Automatically back up the project when files are saved.
std::vector< GIT_REPOSITORY > repositories
MOUSE_DRAG_ACTION drag_right
MOUSE_DRAG_ACTION drag_middle
MOUSE_DRAG_ACTION drag_left
std::vector< wxString > pinned_fp_libs
std::vector< wxString > pinned_symbol_libs