app_settings.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2020 Jon Evans <[email protected]>
 * Copyright (C) 2020-2023 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 as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef _APP_SETTINGS_H
#define _APP_SETTINGS_H
 
#include <gal/color4d.h>
#include <settings/json_settings.h>
#include <settings/grid_settings.h>
 
struct KICOMMON_API CROSS_PROBING_SETTINGS
{
 bool on_selection; 
 bool center_on_items; 
 bool zoom_to_fit; 
 bool auto_highlight; 
};
 
struct KICOMMON_API CURSOR_SETTINGS
{
 bool always_show_cursor;
 bool fullscreen_cursor;
};
 
enum class ARC_EDIT_MODE
{
 KEEP_CENTER_ADJUST_ANGLE_RADIUS,
 KEEP_ENDPOINTS_OR_START_DIRECTION
};
 
struct KICOMMON_API WINDOW_STATE
{
 bool maximized;
 int size_x;
 int size_y;
 int pos_x;
 int pos_y;
 unsigned int display;
};
 
struct KICOMMON_API WINDOW_SETTINGS
{
 WINDOW_STATE state;
 wxString mru_path;
 wxString perspective;
 std::vector<double> zoom_factors;
 
 CURSOR_SETTINGS cursor;
 GRID_SETTINGS grid;
};
 
class KICOMMON_API APP_SETTINGS_BASE : public JSON_SETTINGS
{
public:
 struct FIND_REPLACE
 {
 wxString find_string;
 std::vector<wxString> find_history;
 wxString replace_string;
 std::vector<wxString> replace_history;
 
 bool search_and_replace;
 
 bool match_case;
 int match_mode;
 };
 
 struct GRAPHICS
 {
 int canvas_type;
 float highlight_factor; 
 float select_factor; 
 };
 
 struct COLOR_PICKER
 {
 int default_tab;
 };
 
 struct LIB_TREE
 {
 std::vector<wxString> columns; 
 std::map<wxString, int> column_widths; 
 std::vector<wxString> open_libs; 
 };
 
 struct PRINTING
 {
 bool background; 
 bool monochrome; 
 double scale; 
 bool use_theme; 
 wxString color_theme; 
 bool title_block; 
 std::vector<int> layers; 
 };
 
 struct SYSTEM
 {
 bool first_run_shown; //@todo RFB remove? - not used
 int max_undo_items;
 std::vector<wxString> file_history;
 int units;
 int last_metric_units;
 int last_imperial_units;
 };
 
 APP_SETTINGS_BASE( const std::string& aFilename, int aSchemaVersion );
 
 virtual ~APP_SETTINGS_BASE() {}
 
 virtual bool MigrateFromLegacy( wxConfigBase* aCfg ) override;
 
 const std::vector<GRID> DefaultGridSizeList() const;
 
public:
 CROSS_PROBING_SETTINGS m_CrossProbing;
 
 FIND_REPLACE m_FindReplace;
 
 GRAPHICS m_Graphics;
 
 COLOR_PICKER m_ColorPicker;
 
 LIB_TREE m_LibTree;
 
 PRINTING m_Printing;
 
 SYSTEM m_System;
 
 WINDOW_SETTINGS m_Window;
 
 wxString m_ColorTheme;
 
 int m_appSettingsSchemaVersion;
 
protected:
 
 virtual std::string getLegacyFrameName() const { return std::string(); }
 
 void migrateFindReplace( wxConfigBase* aCfg );
 
 bool migrateWindowConfig( wxConfigBase* aCfg, const std::string& aFrameName,
 const std::string& aJsonPath );
 
 void addParamsForWindow( WINDOW_SETTINGS* aWindow, const std::string& aJsonPath );
 
 bool migrateLibTreeWidth();
};
 
#endif