KiCad PCB EDA Suite
libs/kiplatform/include/kiplatform/environment.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 Ian McInerney <Ian.S.McInerney at ieee.org>
5 * Copyright (C) 2020 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#include <wx/string.h>
22
23namespace KIPLATFORM
24{
25 namespace ENV
26 {
31 void Init();
32
41 bool MoveToTrash( const wxString& aPath, wxString& aError );
42
51 bool IsNetworkPath( const wxString& aPath );
52
53
59 wxString GetDocumentsPath();
60
66 wxString GetUserConfigPath();
67
73 wxString GetUserCachePath();
74
76 {
77 wxString host;
78 wxString username;
79 wxString password;
80 };
81
90 bool GetSystemProxyConfig( const wxString& aURL, PROXY_CONFIG& aCfg );
91
98 bool VerifyFileSignature( const wxString& aPath );
99 }
100}
bool IsNetworkPath(const wxString &aPath)
Determines if a given path is a network shared file apth On Windows for example, any form of path is ...
void Init()
Perform environment initialization tasks.
bool GetSystemProxyConfig(const wxString &aURL, PROXY_CONFIG &aCfg)
Retrieves platform level proxying requirements to reach the given url.
wxString GetDocumentsPath()
Retrieves the operating system specific path for a user's documents.
bool MoveToTrash(const wxString &aPath, wxString &aError)
Move the specified file/directory to the trash bin/recycle bin.
wxString GetUserConfigPath()
Retrieves the operating system specific path for a user's configuration store.
wxString GetUserCachePath()
Retrieves the operating system specific path for user's application cache.
bool VerifyFileSignature(const wxString &aPath)
Validates the code signing signature of a given file This is most likely only ever going to be applic...
Definition: app.h:28