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 
23 namespace 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  }
75 }
wxString GetDocumentsPath()
Retrieves the operating system specific path for a user's documents.
wxString GetUserCachePath()
Retrieves the operating system specific path for user's application cache.
Definition: app.h:27
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 ...
bool MoveToTrash(const wxString &aPath, wxString &aError)
Move the specified file/directory to the trash bin/recycle bin.
void Init()
Perform environment initialization tasks.
wxString GetUserConfigPath()
Retrieves the operating system specific path for a user's configuration store.