diff --git a/html/doxygen/3.2.0/annotated.html b/html/doxygen/3.2.0/annotated.html index 50ecbd2..7af7849 100644 --- a/html/doxygen/3.2.0/annotated.html +++ b/html/doxygen/3.2.0/annotated.html @@ -72,7 +72,7 @@ $(function() {
-Generated on Sun May 27 2018 15:02:28 for Platform folders by   +Generated on Sun May 27 2018 15:17:32 for Platform folders by   doxygen 1.8.13
diff --git a/html/doxygen/3.2.0/classes.html b/html/doxygen/3.2.0/classes.html index 69f3daf..b9f39dc 100644 --- a/html/doxygen/3.2.0/classes.html +++ b/html/doxygen/3.2.0/classes.html @@ -75,7 +75,7 @@ $(function() {
-Generated on Sun May 27 2018 15:02:28 for Platform folders by   +Generated on Sun May 27 2018 15:17:32 for Platform folders by   doxygen 1.8.13
diff --git a/html/doxygen/3.2.0/classsago_1_1PlatformFolders-members.html b/html/doxygen/3.2.0/classsago_1_1PlatformFolders-members.html index 1e491e6..da02b57 100644 --- a/html/doxygen/3.2.0/classsago_1_1PlatformFolders-members.html +++ b/html/doxygen/3.2.0/classsago_1_1PlatformFolders-members.html @@ -82,7 +82,7 @@ $(function() {
-Generated on Sun May 27 2018 15:02:28 for Platform folders by   +Generated on Sun May 27 2018 15:17:32 for Platform folders by   doxygen 1.8.13
diff --git a/html/doxygen/3.2.0/classsago_1_1PlatformFolders.html b/html/doxygen/3.2.0/classsago_1_1PlatformFolders.html index 0fe5e04..348b5e8 100644 --- a/html/doxygen/3.2.0/classsago_1_1PlatformFolders.html +++ b/html/doxygen/3.2.0/classsago_1_1PlatformFolders.html @@ -229,7 +229,7 @@ Linux: XDF does not define a folder for saved games. This will just return the s
-Generated on Sun May 27 2018 15:02:28 for Platform folders by   +Generated on Sun May 27 2018 15:17:32 for Platform folders by   doxygen 1.8.13
diff --git a/html/doxygen/3.2.0/dir_8e47b5f8672a00523ffcd0bfe6984bf7.html b/html/doxygen/3.2.0/dir_8e47b5f8672a00523ffcd0bfe6984bf7.html index bfeb1b3..d5c8d99 100644 --- a/html/doxygen/3.2.0/dir_8e47b5f8672a00523ffcd0bfe6984bf7.html +++ b/html/doxygen/3.2.0/dir_8e47b5f8672a00523ffcd0bfe6984bf7.html @@ -70,7 +70,7 @@ $(function() {
-Generated on Sun May 27 2018 15:02:28 for Platform folders by   +Generated on Sun May 27 2018 15:17:32 for Platform folders by   doxygen 1.8.13
diff --git a/html/doxygen/3.2.0/files.html b/html/doxygen/3.2.0/files.html index a2ba3f0..f1f12d7 100644 --- a/html/doxygen/3.2.0/files.html +++ b/html/doxygen/3.2.0/files.html @@ -71,7 +71,7 @@ $(function() {
-Generated on Sun May 27 2018 15:02:28 for Platform folders by   +Generated on Sun May 27 2018 15:17:32 for Platform folders by   doxygen 1.8.13
diff --git a/html/doxygen/3.2.0/functions.html b/html/doxygen/3.2.0/functions.html index e683759..4ddf87d 100644 --- a/html/doxygen/3.2.0/functions.html +++ b/html/doxygen/3.2.0/functions.html @@ -85,7 +85,7 @@ $(function() {
-Generated on Sun May 27 2018 15:02:28 for Platform folders by   +Generated on Sun May 27 2018 15:17:32 for Platform folders by   doxygen 1.8.13
diff --git a/html/doxygen/3.2.0/functions_func.html b/html/doxygen/3.2.0/functions_func.html index e1b451d..201d0fd 100644 --- a/html/doxygen/3.2.0/functions_func.html +++ b/html/doxygen/3.2.0/functions_func.html @@ -85,7 +85,7 @@ $(function() {
-Generated on Sun May 27 2018 15:02:28 for Platform folders by   +Generated on Sun May 27 2018 15:17:32 for Platform folders by   doxygen 1.8.13
diff --git a/html/doxygen/3.2.0/index.html b/html/doxygen/3.2.0/index.html index 0c0a5da..d260a85 100644 --- a/html/doxygen/3.2.0/index.html +++ b/html/doxygen/3.2.0/index.html @@ -66,7 +66,7 @@ $(function() {
-Generated on Sun May 27 2018 15:02:28 for Platform folders by   +Generated on Sun May 27 2018 15:17:32 for Platform folders by   doxygen 1.8.13
diff --git a/html/doxygen/3.2.0/namespacemembers.html b/html/doxygen/3.2.0/namespacemembers.html index 0a4dcae..1fc6cae 100644 --- a/html/doxygen/3.2.0/namespacemembers.html +++ b/html/doxygen/3.2.0/namespacemembers.html @@ -100,7 +100,7 @@ $(function() {
-Generated on Sun May 27 2018 15:02:28 for Platform folders by   +Generated on Sun May 27 2018 15:17:32 for Platform folders by   doxygen 1.8.13
diff --git a/html/doxygen/3.2.0/namespacemembers_func.html b/html/doxygen/3.2.0/namespacemembers_func.html index 462ded3..df8f780 100644 --- a/html/doxygen/3.2.0/namespacemembers_func.html +++ b/html/doxygen/3.2.0/namespacemembers_func.html @@ -100,7 +100,7 @@ $(function() {
-Generated on Sun May 27 2018 15:02:28 for Platform folders by   +Generated on Sun May 27 2018 15:17:32 for Platform folders by   doxygen 1.8.13
diff --git a/html/doxygen/3.2.0/namespaces.html b/html/doxygen/3.2.0/namespaces.html index 927019f..4d254a6 100644 --- a/html/doxygen/3.2.0/namespaces.html +++ b/html/doxygen/3.2.0/namespaces.html @@ -71,7 +71,7 @@ $(function() {
-Generated on Sun May 27 2018 15:02:28 for Platform folders by   +Generated on Sun May 27 2018 15:17:32 for Platform folders by   doxygen 1.8.13
diff --git a/html/doxygen/3.2.0/namespacesago.html b/html/doxygen/3.2.0/namespacesago.html index d28a733..7daf90c 100644 --- a/html/doxygen/3.2.0/namespacesago.html +++ b/html/doxygen/3.2.0/namespacesago.html @@ -309,7 +309,7 @@ Functions
-

The base folder for storring saved games. You must add the program name to it like this:

PlatformFolders pf;
string saved_games_folder = pf.getSaveGamesFolder1()+"/My Program Name/";
Note
Windows: This is an XP compatible version and returns the path to "My Games" in Documents. Vista and later has an official folder.
+

The base folder for storring saved games. You must add the program name to it like this:

string saved_games_folder = sago::getSaveGamesFolder1()+"/My Program Name/";
Note
Windows: This is an XP compatible version and returns the path to "My Games" in Documents. Vista and later has an official folder.
Linux: XDF does not define a folder for saved games. This will just return the same as GetDataHome()
Returns
The folder base folder for storring save games.
@@ -337,7 +337,7 @@ Linux: XDF does not define a folder for saved games. This will just return the s
-Generated on Sun May 27 2018 15:02:28 for Platform folders by   +Generated on Sun May 27 2018 15:17:32 for Platform folders by   doxygen 1.8.13
diff --git a/html/doxygen/3.2.0/platform__folders_8h_source.html b/html/doxygen/3.2.0/platform__folders_8h_source.html index 90bf9b8..b09be1e 100644 --- a/html/doxygen/3.2.0/platform__folders_8h_source.html +++ b/html/doxygen/3.2.0/platform__folders_8h_source.html @@ -67,7 +67,7 @@ $(function() {
platform_folders.h
-
1 /*
2 Its is under the MIT license, to encourage reuse by cut-and-paste.
3 
4 The original files are hosted here: https://github.com/sago007/PlatformFolders
5 
6 Copyright (c) 2015 Poul Sander
7 
8 Permission is hereby granted, free of charge, to any person
9 obtaining a copy of this software and associated documentation files
10 (the "Software"), to deal in the Software without restriction,
11 including without limitation the rights to use, copy, modify, merge,
12 publish, distribute, sublicense, and/or sell copies of the Software,
13 and to permit persons to whom the Software is furnished to do so,
14 subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be
17 included in all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
22 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
23 BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
24 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
25 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 SOFTWARE.
27 */
28 
29 #ifndef SAGO_PLATFORM_FOLDERS_H
30 #define SAGO_PLATFORM_FOLDERS_H
31 
32 #include <vector>
33 #include <string>
34 
38 namespace sago {
39 
50 std::string getDataHome();
51 
62 std::string getConfigHome();
63 
74 std::string getCacheDir();
75 
92 void appendAdditionalDataDirectories(std::vector<std::string>& homes);
93 
110 void appendAdditionalConfigDirectories(std::vector<std::string>& homes);
111 
117 std::string getDesktopFolder();
118 
123 std::string getDocumentsFolder();
124 
130 std::string getDownloadFolder1();
131 
136 std::string getPicturesFolder();
137 
142 std::string getMusicFolder();
143 
148 std::string getVideoFolder();
149 
161 std::string getSaveGamesFolder1();
162 
163 #ifndef DOXYGEN_SHOULD_SKIP_THIS
164 
171 class PlatformFolders {
172 public:
173  PlatformFolders();
174  ~PlatformFolders();
180  std::string getDesktopFolder() const;
185  std::string getDocumentsFolder() const;
190  std::string getPicturesFolder() const;
196  std::string getDownloadFolder1() const;
201  std::string getMusicFolder() const;
206  std::string getVideoFolder() const;
218  std::string getSaveGamesFolder1() const;
219 private:
220  PlatformFolders(const PlatformFolders&);
221  PlatformFolders& operator=(const PlatformFolders&);
222 #if defined(_WIN32)
223 #elif defined(__APPLE__)
224 #else
225  struct PlatformFoldersData;
226  PlatformFoldersData* data;
227 #endif
228 };
229 
230 #endif // skip doxygen
231 
232 
233 } //namespace sago
234 
235 #endif /* PLATFORM_FOLDERS_H */
sago
Definition: platform_folders.h:38
+
1 /*
2 Its is under the MIT license, to encourage reuse by cut-and-paste.
3 
4 The original files are hosted here: https://github.com/sago007/PlatformFolders
5 
6 Copyright (c) 2015 Poul Sander
7 
8 Permission is hereby granted, free of charge, to any person
9 obtaining a copy of this software and associated documentation files
10 (the "Software"), to deal in the Software without restriction,
11 including without limitation the rights to use, copy, modify, merge,
12 publish, distribute, sublicense, and/or sell copies of the Software,
13 and to permit persons to whom the Software is furnished to do so,
14 subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be
17 included in all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
22 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
23 BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
24 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
25 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 SOFTWARE.
27 */
28 
29 #ifndef SAGO_PLATFORM_FOLDERS_H
30 #define SAGO_PLATFORM_FOLDERS_H
31 
32 #include <vector>
33 #include <string>
34 
38 namespace sago {
39 
50 std::string getDataHome();
51 
62 std::string getConfigHome();
63 
74 std::string getCacheDir();
75 
92 void appendAdditionalDataDirectories(std::vector<std::string>& homes);
93 
110 void appendAdditionalConfigDirectories(std::vector<std::string>& homes);
111 
117 std::string getDesktopFolder();
118 
123 std::string getDocumentsFolder();
124 
130 std::string getDownloadFolder1();
131 
136 std::string getPicturesFolder();
137 
142 std::string getMusicFolder();
143 
148 std::string getVideoFolder();
149 
160 std::string getSaveGamesFolder1();
161 
162 #ifndef DOXYGEN_SHOULD_SKIP_THIS
163 
170 class PlatformFolders {
171 public:
172  PlatformFolders();
173  ~PlatformFolders();
179  std::string getDesktopFolder() const;
184  std::string getDocumentsFolder() const;
189  std::string getPicturesFolder() const;
195  std::string getDownloadFolder1() const;
200  std::string getMusicFolder() const;
205  std::string getVideoFolder() const;
217  std::string getSaveGamesFolder1() const;
218 private:
219  PlatformFolders(const PlatformFolders&);
220  PlatformFolders& operator=(const PlatformFolders&);
221 #if defined(_WIN32)
222 #elif defined(__APPLE__)
223 #else
224  struct PlatformFoldersData;
225  PlatformFoldersData* data;
226 #endif
227 };
228 
229 #endif // skip doxygen
230 
231 
232 } //namespace sago
233 
234 #endif /* PLATFORM_FOLDERS_H */
sago
Definition: platform_folders.h:38
sago::appendAdditionalConfigDirectories
void appendAdditionalConfigDirectories(std::vector< std::string > &homes)
sago::getDesktopFolder
std::string getDesktopFolder()
sago::getCacheDir
std::string getCacheDir()
@@ -77,7 +77,7 @@ $(function() {
sago::PlatformFolders::getVideoFolder
std::string getVideoFolder() const
sago::getDownloadFolder1
std::string getDownloadFolder1()
sago::PlatformFolders::getSaveGamesFolder1
std::string getSaveGamesFolder1() const
-
sago::PlatformFolders
Definition: platform_folders.h:171
+
sago::PlatformFolders
Definition: platform_folders.h:170
sago::getConfigHome
std::string getConfigHome()
sago::appendAdditionalDataDirectories
void appendAdditionalDataDirectories(std::vector< std::string > &homes)
sago::getMusicFolder
std::string getMusicFolder()
@@ -91,7 +91,7 @@ $(function() {
-Generated on Sun May 27 2018 15:02:28 for Platform folders by   +Generated on Sun May 27 2018 15:17:32 for Platform folders by   doxygen 1.8.13