libs/kiplatform/include/kiplatform/environment.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 Ian McInerney <Ian.S.McInerney at ieee.org>
 * 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/>.
 */
 
#pragma once
 
#include <wx/string.h>
 
class wxWindow;
 
namespace KIPLATFORM
{
    namespace ENV
    {
        void Init();

        bool MoveToTrash( const wxString& aPath, wxString& aError );

        bool IsNetworkPath( const wxString& aPath );

        bool IsRemovablePath( const wxString& aPath );
 

        wxString GetDocumentsPath();

        wxString GetUserConfigPath();

        wxString GetUserDataPath();

        wxString GetUserLocalDataPath();

        wxString GetUserCachePath();
 
        struct PROXY_CONFIG
        {
            wxString host;
            wxString username;
            wxString password;
        };

        bool GetSystemProxyConfig( const wxString& aURL, PROXY_CONFIG& aCfg );

        bool VerifyFileSignature( const wxString& aPath );

        wxString GetAppUserModelId();

        void SetAppDetailsForWindow( wxWindow* aWindow, const wxString& aRelaunchCommand, const wxString& aRelaunchDisplayName );

        wxString GetCommandLineStr();
 
        void AddToRecentDocs( const wxString &aPath );
    }
}