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
23
class
wxWindow;
24
25
namespace
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
91
struct
PROXY_CONFIG
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
}
KIPLATFORM::ENV::IsNetworkPath
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 ...
Definition:
unix/environment.cpp:69
KIPLATFORM::ENV::Init
void Init()
Perform environment initialization tasks.
Definition:
unix/environment.cpp:28
KIPLATFORM::ENV::GetCommandLineStr
wxString GetCommandLineStr()
Definition:
unix/environment.cpp:144
KIPLATFORM::ENV::GetSystemProxyConfig
bool GetSystemProxyConfig(const wxString &aURL, PROXY_CONFIG &aCfg)
Retrieves platform level proxying requirements to reach the given url.
Definition:
unix/environment.cpp:120
KIPLATFORM::ENV::GetUserDataPath
wxString GetUserDataPath()
Retrieves the operating system specific path for a user's data store.
Definition:
unix/environment.cpp:102
KIPLATFORM::ENV::GetDocumentsPath
wxString GetDocumentsPath()
Retrieves the operating system specific path for a user's documents.
Definition:
unix/environment.cpp:76
KIPLATFORM::ENV::GetAppUserModelId
wxString GetAppUserModelId()
Retrieves the app user model id, a special string used for taskbar grouping on Windows 7 and later.
Definition:
unix/environment.cpp:132
KIPLATFORM::ENV::SetAppDetailsForWindow
void SetAppDetailsForWindow(wxWindow *aWindow, const wxString &aRelaunchCommand, const wxString &aRelaunchDisplayName)
Sets the relaunch command for taskbar pins, this is intended for Windows.
Definition:
unix/environment.cpp:138
KIPLATFORM::ENV::AddToRecentDocs
void AddToRecentDocs(const wxString &aPath)
Definition:
unix/environment.cpp:150
KIPLATFORM::ENV::MoveToTrash
bool MoveToTrash(const wxString &aPath, wxString &aError)
Move the specified file/directory to the trash bin/recycle bin.
Definition:
unix/environment.cpp:51
KIPLATFORM::ENV::GetUserLocalDataPath
wxString GetUserLocalDataPath()
Retrieves the operating system specific path for a user's local data store.
Definition:
unix/environment.cpp:108
KIPLATFORM::ENV::GetUserConfigPath
wxString GetUserConfigPath()
Retrieves the operating system specific path for a user's configuration store.
Definition:
unix/environment.cpp:96
KIPLATFORM::ENV::GetUserCachePath
wxString GetUserCachePath()
Retrieves the operating system specific path for user's application cache.
Definition:
unix/environment.cpp:114
KIPLATFORM::ENV::VerifyFileSignature
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:
unix/environment.cpp:126
KIPLATFORM
Definition:
app.h:28
KIPLATFORM::ENV::PROXY_CONFIG
Definition:
libs/kiplatform/include/kiplatform/environment.h:92
KIPLATFORM::ENV::PROXY_CONFIG::host
wxString host
Definition:
libs/kiplatform/include/kiplatform/environment.h:93
KIPLATFORM::ENV::PROXY_CONFIG::username
wxString username
Definition:
libs/kiplatform/include/kiplatform/environment.h:94
KIPLATFORM::ENV::PROXY_CONFIG::password
wxString password
Definition:
libs/kiplatform/include/kiplatform/environment.h:95
src
libs
kiplatform
include
kiplatform
environment.h
Generated on Tue Aug 12 2025 00:06:51 for KiCad PCB EDA Suite by
1.9.6