KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 The 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
23class wxWindow;
24
25namespace KIPLATFORM
26{
27 namespace ENV
28 {
33 void Init();
34
43 bool MoveToTrash( const wxString& aPath, wxString& aError );
44
53 bool IsNetworkPath( const wxString& aPath );
54
55
61 wxString GetDocumentsPath();
62
68 wxString GetUserConfigPath();
69
75 wxString GetUserDataPath();
76
82 wxString GetUserLocalDataPath();
83
89 wxString GetUserCachePath();
90
92 {
93 wxString host;
94 wxString username;
95 wxString password;
96 };
97
106 bool GetSystemProxyConfig( const wxString& aURL, PROXY_CONFIG& aCfg );
107
114 bool VerifyFileSignature( const wxString& aPath );
115
122 wxString GetAppUserModelId();
123
127 void SetAppDetailsForWindow( wxWindow* aWindow, const wxString& aRelaunchCommand, const wxString& aRelaunchDisplayName );
128
132 wxString GetCommandLineStr();
133
134 void AddToRecentDocs( const wxString &aPath );
135 }
136}
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.
wxString GetCommandLineStr()
bool GetSystemProxyConfig(const wxString &aURL, PROXY_CONFIG &aCfg)
Retrieves platform level proxying requirements to reach the given url.
wxString GetUserDataPath()
Retrieves the operating system specific path for a user's data store.
wxString GetDocumentsPath()
Retrieves the operating system specific path for a user's documents.
wxString GetAppUserModelId()
Retrieves the app user model id, a special string used for taskbar grouping on Windows 7 and later.
void SetAppDetailsForWindow(wxWindow *aWindow, const wxString &aRelaunchCommand, const wxString &aRelaunchDisplayName)
Sets the relaunch command for taskbar pins, this is intended for Windows.
void AddToRecentDocs(const wxString &aPath)
bool MoveToTrash(const wxString &aPath, wxString &aError)
Move the specified file/directory to the trash bin/recycle bin.
wxString GetUserLocalDataPath()
Retrieves the operating system specific path for a user's local data store.
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