kicad_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 The 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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef _KICAD_SETTINGS_H
#define _KICAD_SETTINGS_H
 
#include <map>
#include <set>
#include <settings/app_settings.h>
#define PCM_DEFAULT_REPOSITORY_URL "https://repository.kicad.org/repository.json"
 

struct LIB_OVERRIDE
{
    bool disabled = false;
    bool hidden = false;
};
 
 
class KICOMMON_API KICAD_SETTINGS : public APP_SETTINGS_BASE
{
public:
    KICAD_SETTINGS();
 
    virtual ~KICAD_SETTINGS() {}
 
    virtual bool MigrateFromLegacy( wxConfigBase* aLegacyConfig ) override;
 
    int m_LeftWinWidth;
    bool m_ShowHistoryPanel;
    bool m_ShowGitCommitPanel;
 
 
    std::vector<wxString> m_OpenProjects;
 
    wxString m_lastDesignBlockLibDir;
 
    std::vector<std::pair<wxString, wxString>> m_PcmRepositories;
    wxString                                   m_PcmLastDownloadDir;
 
    // This controls background update check for PCM.
    // It is set according to m_updateCheck on first start.
    bool m_PcmUpdateCheck;
    // Auto add libs to global table
    bool m_PcmLibAutoAdd;
    // Auto remove libs
    bool m_PcmLibAutoRemove;
    // Generated library nickname prefix
    wxString m_PcmLibPrefix;
    // Last used repository (for pre-selection in dialog)
    wxString m_PcmLastSelectedRepoId;
 
    bool     m_KiCadUpdateCheck;
    wxString m_lastUpdateCheckTime;
    wxString m_lastReceivedUpdate;
 
    // Last position of the template window
    wxPoint m_TemplateWindowPos;
    // Last size of the template window
    wxSize m_TemplateWindowSize;
    // Last used project template path (for pre-selection in dialog)
    wxString m_LastUsedTemplate;
 
    std::vector<wxString> m_RecentTemplates;
    int                   m_TemplateFilterChoice = 0;
    // Most recently browsed external template directory (restored in the template selector
    // so users can keep using templates from arbitrary locations across sessions).
    wxString              m_BrowsedTemplatesPath;

    std::map<wxString, std::map<wxString, LIB_OVERRIDE>> m_LibOverrides;
 
protected:
    virtual std::string getLegacyFrameName() const override { return "KicadFrame"; }
};
 
#endif