| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
3 |
<head> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
5 |
<meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
6 |
<meta name="generator" content="Doxygen 1.8.17"/> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
7 |
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
8 |
<title>Platform folders: sago Namespace Reference</title> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
9 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
10 |
<script type="text/javascript" src="jquery.js"></script> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
11 |
<script type="text/javascript" src="dynsections.js"></script> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
12 |
<link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
13 |
<script type="text/javascript" src="search/searchdata.js"></script> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
14 |
<script type="text/javascript" src="search/search.js"></script> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
15 |
<link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
16 |
</head> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
17 |
<body> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
18 |
<div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
19 |
<div id="titlearea"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
20 |
<table cellspacing="0" cellpadding="0"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
21 |
<tbody> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
22 |
<tr style="height: 56px;"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
23 |
<td id="projectalign" style="padding-left: 0.5em;"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
24 |
<div id="projectname">Platform folders |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
25 |
 <span id="projectnumber">4.1.0</span> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
26 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
27 |
</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
28 |
</tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
29 |
</tbody> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
30 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
31 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
32 |
<!-- end header part --> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
33 |
<!-- Generated by Doxygen 1.8.17 --> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
34 |
<script type="text/javascript"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
35 |
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
36 |
var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
37 |
/* @license-end */ |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
38 |
</script> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
39 |
<script type="text/javascript" src="menudata.js"></script> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
40 |
<script type="text/javascript" src="menu.js"></script> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
41 |
<script type="text/javascript"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
42 |
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
43 |
$(function() { |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
44 |
initMenu('',true,false,'search.php','Search'); |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
45 |
$(document).ready(function() { init_search(); }); |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
46 |
}); |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
47 |
/* @license-end */</script> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
48 |
<div id="main-nav"></div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
49 |
<!-- window showing the filter options --> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
50 |
<div id="MSearchSelectWindow" |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
51 |
onmouseover="return searchBox.OnSearchSelectShow()" |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
52 |
onmouseout="return searchBox.OnSearchSelectHide()" |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
53 |
onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
54 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
55 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
56 |
<!-- iframe showing the search results (closed by default) --> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
57 |
<div id="MSearchResultsWindow"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
58 |
<iframe src="javascript:void(0)" frameborder="0" |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
59 |
name="MSearchResults" id="MSearchResults"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
60 |
</iframe> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
61 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
62 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
63 |
</div><!-- top --> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
64 |
<div class="header"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
65 |
<div class="summary"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
66 |
<a href="#func-members">Functions</a> </div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
67 |
<div class="headertitle"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
68 |
<div class="title">sago Namespace Reference</div> </div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
69 |
</div><!--header--> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
70 |
<div class="contents"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
71 |
<table class="memberdecls"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
72 |
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
73 |
Functions</h2></td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
74 |
<tr class="memitem:a85c382a039426b76aa408961ac2149ee"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a85c382a039426b76aa408961ac2149ee">getDataHome</a> ()</td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
75 |
<tr class="separator:a85c382a039426b76aa408961ac2149ee"><td class="memSeparator" colspan="2"> </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
76 |
<tr class="memitem:aa6c6da4e6fe460076ac069e176622f59"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#aa6c6da4e6fe460076ac069e176622f59">getConfigHome</a> ()</td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
77 |
<tr class="separator:aa6c6da4e6fe460076ac069e176622f59"><td class="memSeparator" colspan="2"> </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
78 |
<tr class="memitem:a426458c0e30383f23ecab17bdf55a407"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a426458c0e30383f23ecab17bdf55a407">getCacheDir</a> ()</td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
79 |
<tr class="separator:a426458c0e30383f23ecab17bdf55a407"><td class="memSeparator" colspan="2"> </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
80 |
<tr class="memitem:a2d3b0d91188997c4949f5f39a24dd8ab"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a2d3b0d91188997c4949f5f39a24dd8ab">appendAdditionalDataDirectories</a> (std::vector< std::string > &homes)</td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
81 |
<tr class="separator:a2d3b0d91188997c4949f5f39a24dd8ab"><td class="memSeparator" colspan="2"> </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
82 |
<tr class="memitem:a760a4d546d0bccc82dc939ed6e10304d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a760a4d546d0bccc82dc939ed6e10304d">appendAdditionalConfigDirectories</a> (std::vector< std::string > &homes)</td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
83 |
<tr class="separator:a760a4d546d0bccc82dc939ed6e10304d"><td class="memSeparator" colspan="2"> </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
84 |
<tr class="memitem:ac9fc8e0a8f97b7066548223d43720ce8"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#ac9fc8e0a8f97b7066548223d43720ce8">getDesktopFolder</a> ()</td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
85 |
<tr class="separator:ac9fc8e0a8f97b7066548223d43720ce8"><td class="memSeparator" colspan="2"> </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
86 |
<tr class="memitem:aa44dc2057a9acdb38a10e41a60b7bb82"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#aa44dc2057a9acdb38a10e41a60b7bb82">getDocumentsFolder</a> ()</td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
87 |
<tr class="separator:aa44dc2057a9acdb38a10e41a60b7bb82"><td class="memSeparator" colspan="2"> </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
88 |
<tr class="memitem:a650b888f2d54cadfbe3347f3c9c40059"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a650b888f2d54cadfbe3347f3c9c40059">getDownloadFolder</a> ()</td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
89 |
<tr class="separator:a650b888f2d54cadfbe3347f3c9c40059"><td class="memSeparator" colspan="2"> </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
90 |
<tr class="memitem:a853ba2c62cd283e5b8836e9aa98610f3"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a853ba2c62cd283e5b8836e9aa98610f3">getDownloadFolder1</a> ()</td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
91 |
<tr class="separator:a853ba2c62cd283e5b8836e9aa98610f3"><td class="memSeparator" colspan="2"> </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
92 |
<tr class="memitem:a45b407f0581bf3ac349682eb2481c630"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a45b407f0581bf3ac349682eb2481c630">getPicturesFolder</a> ()</td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
93 |
<tr class="separator:a45b407f0581bf3ac349682eb2481c630"><td class="memSeparator" colspan="2"> </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
94 |
<tr class="memitem:a4c436b1cbbdc85b012877bc80e769dbc"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a4c436b1cbbdc85b012877bc80e769dbc">getPublicFolder</a> ()</td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
95 |
<tr class="separator:a4c436b1cbbdc85b012877bc80e769dbc"><td class="memSeparator" colspan="2"> </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
96 |
<tr class="memitem:aef0ecc52b536a96e2f3096b43acbfcbe"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#aef0ecc52b536a96e2f3096b43acbfcbe">getMusicFolder</a> ()</td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
97 |
<tr class="separator:aef0ecc52b536a96e2f3096b43acbfcbe"><td class="memSeparator" colspan="2"> </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
98 |
<tr class="memitem:a8eda16d34cba4c0f82a6e80077660780"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a8eda16d34cba4c0f82a6e80077660780">getVideoFolder</a> ()</td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
99 |
<tr class="separator:a8eda16d34cba4c0f82a6e80077660780"><td class="memSeparator" colspan="2"> </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
100 |
<tr class="memitem:ab568df2aa5ea8492975bbefb206a6145"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#ab568df2aa5ea8492975bbefb206a6145">getSaveGamesFolder1</a> ()</td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
101 |
<tr class="separator:ab568df2aa5ea8492975bbefb206a6145"><td class="memSeparator" colspan="2"> </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
102 |
<tr class="memitem:afc7986187926c19b217427a73bdae16e"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#afc7986187926c19b217427a73bdae16e">getSaveGamesFolder2</a> ()</td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
103 |
<tr class="separator:afc7986187926c19b217427a73bdae16e"><td class="memSeparator" colspan="2"> </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
104 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
105 |
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
106 |
<div class="textblock"><p>The namespace I use for common function. Nothing special about it. </p> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
107 |
</div><h2 class="groupheader">Function Documentation</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
108 |
<a id="a760a4d546d0bccc82dc939ed6e10304d"></a> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
109 |
<h2 class="memtitle"><span class="permalink"><a href="#a760a4d546d0bccc82dc939ed6e10304d">◆ </a></span>appendAdditionalConfigDirectories()</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
110 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
111 |
<div class="memitem"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
112 |
<div class="memproto"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
113 |
<table class="memname"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
114 |
<tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
115 |
<td class="memname">void sago::appendAdditionalConfigDirectories </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
116 |
<td>(</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
117 |
<td class="paramtype">std::vector< std::string > & </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
118 |
<td class="paramname"><em>homes</em></td><td>)</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
119 |
<td></td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
120 |
</tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
121 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
122 |
</div><div class="memdoc"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
123 |
<p>This will append extra folders that your program should be looking for config files in. This does not normally include the path returned by GetConfigHome(). If you want all the folders you should do something like: </p><div class="fragment"><div class="line">std::vector<std::string> folders;</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
124 |
<div class="line">folders.push_back(<a class="code" href="namespacesago.html#aa6c6da4e6fe460076ac069e176622f59">sago::getConfigHome</a>());</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
125 |
<div class="line"><a class="code" href="namespacesago.html#a760a4d546d0bccc82dc939ed6e10304d">sago::appendAdditionalConfigDirectories</a>(folders);</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
126 |
<div class="line"><span class="keywordflow">for</span> (std::string s& : folders) {</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
127 |
<div class="line"> s+=<span class="stringliteral">"/My Program Name/"</span>;</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
128 |
<div class="line">}</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
129 |
</div><!-- fragment --><p> You must apply "/My Program Name/" to all the strings. The string at the lowest index has the highest priority. </p><dl class="params"><dt>Parameters</dt><dd> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
130 |
<table class="params"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
131 |
<tr><td class="paramname">homes</td><td>A vector that extra folders will be appended to. </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
132 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
133 |
</dd> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
134 |
</dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
135 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
136 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
137 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
138 |
<a id="a2d3b0d91188997c4949f5f39a24dd8ab"></a> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
139 |
<h2 class="memtitle"><span class="permalink"><a href="#a2d3b0d91188997c4949f5f39a24dd8ab">◆ </a></span>appendAdditionalDataDirectories()</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
140 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
141 |
<div class="memitem"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
142 |
<div class="memproto"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
143 |
<table class="memname"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
144 |
<tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
145 |
<td class="memname">void sago::appendAdditionalDataDirectories </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
146 |
<td>(</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
147 |
<td class="paramtype">std::vector< std::string > & </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
148 |
<td class="paramname"><em>homes</em></td><td>)</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
149 |
<td></td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
150 |
</tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
151 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
152 |
</div><div class="memdoc"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
153 |
<p>This will append extra folders that your program should be looking for data files in. This does not normally include the path returned by GetDataHome(). If you want all the folders you should do something like: </p><div class="fragment"><div class="line">vector<string> folders;</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
154 |
<div class="line">folders.push_back(<a class="code" href="namespacesago.html#a85c382a039426b76aa408961ac2149ee">getDataHome</a>());</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
155 |
<div class="line"><a class="code" href="namespacesago.html#a2d3b0d91188997c4949f5f39a24dd8ab">appendAdditionalDataDirectories</a>(folders);</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
156 |
<div class="line"><span class="keywordflow">for</span> (<span class="keywordtype">string</span> s& : folders) {</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
157 |
<div class="line"> s+=<span class="stringliteral">"/My Program Name/"</span>;</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
158 |
<div class="line">}</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
159 |
</div><!-- fragment --><p> You must apply "/My Program Name/" to all the strings. The string at the lowest index has the highest priority. </p><dl class="params"><dt>Parameters</dt><dd> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
160 |
<table class="params"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
161 |
<tr><td class="paramname">homes</td><td>A vector that extra folders will be appended to. </td></tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
162 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
163 |
</dd> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
164 |
</dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
165 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
166 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
167 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
168 |
<a id="a426458c0e30383f23ecab17bdf55a407"></a> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
169 |
<h2 class="memtitle"><span class="permalink"><a href="#a426458c0e30383f23ecab17bdf55a407">◆ </a></span>getCacheDir()</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
170 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
171 |
<div class="memitem"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
172 |
<div class="memproto"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
173 |
<table class="memname"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
174 |
<tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
175 |
<td class="memname">std::string sago::getCacheDir </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
176 |
<td>(</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
177 |
<td class="paramname"></td><td>)</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
178 |
<td></td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
179 |
</tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
180 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
181 |
</div><div class="memdoc"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
182 |
<p>Retrives the base folder for storing cache files. You must add the program name yourself like this: </p><div class="fragment"><div class="line"><span class="keywordtype">string</span> data_home = <a class="code" href="namespacesago.html#a426458c0e30383f23ecab17bdf55a407">getCacheDir</a>()+<span class="stringliteral">"/My Program Name/"</span>;</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
183 |
</div><!-- fragment --><p> On Windows this defaults to APPDATALOCAL% On Linux this defaults to ~/.cache but can be configured </p><dl class="section return"><dt>Returns</dt><dd>The base folder for storing data that do not need to be backed up. </dd></dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
184 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
185 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
186 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
187 |
<a id="aa6c6da4e6fe460076ac069e176622f59"></a> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
188 |
<h2 class="memtitle"><span class="permalink"><a href="#aa6c6da4e6fe460076ac069e176622f59">◆ </a></span>getConfigHome()</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
189 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
190 |
<div class="memitem"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
191 |
<div class="memproto"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
192 |
<table class="memname"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
193 |
<tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
194 |
<td class="memname">std::string sago::getConfigHome </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
195 |
<td>(</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
196 |
<td class="paramname"></td><td>)</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
197 |
<td></td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
198 |
</tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
199 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
200 |
</div><div class="memdoc"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
201 |
<p>Retrives the base folder for storing config files. You must add the program name yourself like this: </p><div class="fragment"><div class="line"><span class="keywordtype">string</span> data_home = <a class="code" href="namespacesago.html#aa6c6da4e6fe460076ac069e176622f59">getConfigHome</a>()+<span class="stringliteral">"/My Program Name/"</span>;</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
202 |
</div><!-- fragment --><p> On Windows this defaults to APPDATA% (Roaming profile) On Linux this defaults to ~/.config but can be configured </p><dl class="section return"><dt>Returns</dt><dd>The base folder for storing config data. </dd></dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
203 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
204 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
205 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
206 |
<a id="a85c382a039426b76aa408961ac2149ee"></a> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
207 |
<h2 class="memtitle"><span class="permalink"><a href="#a85c382a039426b76aa408961ac2149ee">◆ </a></span>getDataHome()</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
208 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
209 |
<div class="memitem"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
210 |
<div class="memproto"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
211 |
<table class="memname"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
212 |
<tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
213 |
<td class="memname">std::string sago::getDataHome </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
214 |
<td>(</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
215 |
<td class="paramname"></td><td>)</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
216 |
<td></td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
217 |
</tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
218 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
219 |
</div><div class="memdoc"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
220 |
<p>Retrives the base folder for storing data files. You must add the program name yourself like this: </p><div class="fragment"><div class="line"><span class="keywordtype">string</span> data_home = <a class="code" href="namespacesago.html#a85c382a039426b76aa408961ac2149ee">getDataHome</a>()+<span class="stringliteral">"/My Program Name/"</span>;</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
221 |
</div><!-- fragment --><p> On Windows this defaults to APPDATA% (Roaming profile) On Linux this defaults to ~/.local/share but can be configured </p><dl class="section return"><dt>Returns</dt><dd>The base folder for storing program data. </dd></dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
222 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
223 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
224 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
225 |
<a id="ac9fc8e0a8f97b7066548223d43720ce8"></a> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
226 |
<h2 class="memtitle"><span class="permalink"><a href="#ac9fc8e0a8f97b7066548223d43720ce8">◆ </a></span>getDesktopFolder()</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
227 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
228 |
<div class="memitem"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
229 |
<div class="memproto"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
230 |
<table class="memname"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
231 |
<tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
232 |
<td class="memname">std::string sago::getDesktopFolder </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
233 |
<td>(</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
234 |
<td class="paramname"></td><td>)</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
235 |
<td></td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
236 |
</tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
237 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
238 |
</div><div class="memdoc"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
239 |
<p>The folder that represents the desktop. Normally you should try not to use this folder. </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the user's desktop </dd></dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
240 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
241 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
242 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
243 |
<a id="aa44dc2057a9acdb38a10e41a60b7bb82"></a> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
244 |
<h2 class="memtitle"><span class="permalink"><a href="#aa44dc2057a9acdb38a10e41a60b7bb82">◆ </a></span>getDocumentsFolder()</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
245 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
246 |
<div class="memitem"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
247 |
<div class="memproto"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
248 |
<table class="memname"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
249 |
<tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
250 |
<td class="memname">std::string sago::getDocumentsFolder </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
251 |
<td>(</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
252 |
<td class="paramname"></td><td>)</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
253 |
<td></td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
254 |
</tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
255 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
256 |
</div><div class="memdoc"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
257 |
<p>The folder to store user documents to </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the "Documents" folder </dd></dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
258 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
259 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
260 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
261 |
<a id="a650b888f2d54cadfbe3347f3c9c40059"></a> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
262 |
<h2 class="memtitle"><span class="permalink"><a href="#a650b888f2d54cadfbe3347f3c9c40059">◆ </a></span>getDownloadFolder()</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
263 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
264 |
<div class="memitem"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
265 |
<div class="memproto"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
266 |
<table class="memname"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
267 |
<tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
268 |
<td class="memname">std::string sago::getDownloadFolder </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
269 |
<td>(</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
270 |
<td class="paramname"></td><td>)</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
271 |
<td></td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
272 |
</tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
273 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
274 |
</div><div class="memdoc"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
275 |
<p>The folder where files are downloaded. </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the folder where files are downloaded to. </dd></dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
276 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
277 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
278 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
279 |
<a id="a853ba2c62cd283e5b8836e9aa98610f3"></a> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
280 |
<h2 class="memtitle"><span class="permalink"><a href="#a853ba2c62cd283e5b8836e9aa98610f3">◆ </a></span>getDownloadFolder1()</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
281 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
282 |
<div class="memitem"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
283 |
<div class="memproto"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
284 |
<table class="memname"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
285 |
<tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
286 |
<td class="memname">std::string sago::getDownloadFolder1 </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
287 |
<td>(</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
288 |
<td class="paramname"></td><td>)</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
289 |
<td></td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
290 |
</tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
291 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
292 |
</div><div class="memdoc"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
293 |
<p>The folder where files are downloaded. </p><dl class="section note"><dt>Note</dt><dd>This is provided for backward compatibility. Use getDownloadFolder instead. </dd></dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
294 |
<dl class="section return"><dt>Returns</dt><dd>Absolute path to the folder where files are downloaded to. </dd></dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
295 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
296 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
297 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
298 |
<a id="aef0ecc52b536a96e2f3096b43acbfcbe"></a> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
299 |
<h2 class="memtitle"><span class="permalink"><a href="#aef0ecc52b536a96e2f3096b43acbfcbe">◆ </a></span>getMusicFolder()</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
300 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
301 |
<div class="memitem"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
302 |
<div class="memproto"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
303 |
<table class="memname"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
304 |
<tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
305 |
<td class="memname">std::string sago::getMusicFolder </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
306 |
<td>(</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
307 |
<td class="paramname"></td><td>)</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
308 |
<td></td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
309 |
</tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
310 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
311 |
</div><div class="memdoc"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
312 |
<p>The folder where music is stored </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the music folder </dd></dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
313 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
314 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
315 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
316 |
<a id="a45b407f0581bf3ac349682eb2481c630"></a> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
317 |
<h2 class="memtitle"><span class="permalink"><a href="#a45b407f0581bf3ac349682eb2481c630">◆ </a></span>getPicturesFolder()</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
318 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
319 |
<div class="memitem"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
320 |
<div class="memproto"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
321 |
<table class="memname"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
322 |
<tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
323 |
<td class="memname">std::string sago::getPicturesFolder </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
324 |
<td>(</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
325 |
<td class="paramname"></td><td>)</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
326 |
<td></td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
327 |
</tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
328 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
329 |
</div><div class="memdoc"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
330 |
<p>The folder for storing the user's pictures. </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the "Picture" folder </dd></dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
331 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
332 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
333 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
334 |
<a id="a4c436b1cbbdc85b012877bc80e769dbc"></a> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
335 |
<h2 class="memtitle"><span class="permalink"><a href="#a4c436b1cbbdc85b012877bc80e769dbc">◆ </a></span>getPublicFolder()</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
336 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
337 |
<div class="memitem"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
338 |
<div class="memproto"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
339 |
<table class="memname"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
340 |
<tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
341 |
<td class="memname">std::string sago::getPublicFolder </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
342 |
<td>(</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
343 |
<td class="paramname"></td><td>)</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
344 |
<td></td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
345 |
</tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
346 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
347 |
</div><div class="memdoc"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
348 |
<p>This returns the folder that can be used for sharing files with other users on the same system. </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the "Public" folder </dd></dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
349 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
350 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
351 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
352 |
<a id="ab568df2aa5ea8492975bbefb206a6145"></a> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
353 |
<h2 class="memtitle"><span class="permalink"><a href="#ab568df2aa5ea8492975bbefb206a6145">◆ </a></span>getSaveGamesFolder1()</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
354 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
355 |
<div class="memitem"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
356 |
<div class="memproto"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
357 |
<table class="memname"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
358 |
<tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
359 |
<td class="memname">std::string sago::getSaveGamesFolder1 </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
360 |
<td>(</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
361 |
<td class="paramname"></td><td>)</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
362 |
<td></td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
363 |
</tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
364 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
365 |
</div><div class="memdoc"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
366 |
<p>A base folder for storing saved games. You must add the program name to it like this: </p><div class="fragment"><div class="line"><span class="keywordtype">string</span> saved_games_folder = <a class="code" href="namespacesago.html#ab568df2aa5ea8492975bbefb206a6145">sago::getSaveGamesFolder1</a>()+<span class="stringliteral">"/My Program Name/"</span>;</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
367 |
</div><!-- fragment --> <dl class="section note"><dt>Note</dt><dd>Windows: This is an XP compatible version and returns the path to "My Games" in Documents. Vista and later has an official folder. </dd> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
368 |
<dd> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
369 |
Linux: XDF does not define a folder for saved games. This will just return the same as GetDataHome() </dd></dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
370 |
<dl class="section return"><dt>Returns</dt><dd>The folder base folder for storing save games. </dd></dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
371 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
372 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
373 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
374 |
<a id="afc7986187926c19b217427a73bdae16e"></a> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
375 |
<h2 class="memtitle"><span class="permalink"><a href="#afc7986187926c19b217427a73bdae16e">◆ </a></span>getSaveGamesFolder2()</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
376 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
377 |
<div class="memitem"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
378 |
<div class="memproto"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
379 |
<table class="memname"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
380 |
<tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
381 |
<td class="memname">std::string sago::getSaveGamesFolder2 </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
382 |
<td>(</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
383 |
<td class="paramname"></td><td>)</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
384 |
<td></td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
385 |
</tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
386 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
387 |
</div><div class="memdoc"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
388 |
<p>A base folder for storing saved games. You must add the program name to it like this: </p><div class="fragment"><div class="line"><span class="keywordtype">string</span> saved_games_folder = <a class="code" href="namespacesago.html#afc7986187926c19b217427a73bdae16e">sago::getSaveGamesFolder2</a>()+<span class="stringliteral">"/My Program Name/"</span>;</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
389 |
</div><!-- fragment --> <dl class="section note"><dt>Note</dt><dd>PlatformFolders provide different folders to for saved games as not all operating systems has support for Saved Games yet. It is recommended to pick the highest number (currently getSaveGamesFolder2) at the time your product enters production and stick with it </dd> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
390 |
<dd> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
391 |
Windows: This returns the "Saved Games" folder. This folder exist in Vista and later </dd> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
392 |
<dd> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
393 |
Linux: XDF does not define a folder for saved games. This will just return the same as GetDataHome() </dd></dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
394 |
<dl class="section return"><dt>Returns</dt><dd>The folder base folder for storing save games. </dd></dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
395 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
396 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
397 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
398 |
<a id="a8eda16d34cba4c0f82a6e80077660780"></a> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
399 |
<h2 class="memtitle"><span class="permalink"><a href="#a8eda16d34cba4c0f82a6e80077660780">◆ </a></span>getVideoFolder()</h2> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
400 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
401 |
<div class="memitem"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
402 |
<div class="memproto"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
403 |
<table class="memname"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
404 |
<tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
405 |
<td class="memname">std::string sago::getVideoFolder </td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
406 |
<td>(</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
407 |
<td class="paramname"></td><td>)</td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
408 |
<td></td> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
409 |
</tr> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
410 |
</table> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
411 |
</div><div class="memdoc"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
412 |
<p>The folder where video is stored </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the video folder </dd></dl> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
413 |
|
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
414 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
415 |
</div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
416 |
</div><!-- contents --> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
417 |
<div class="ttc" id="anamespacesago_html_ab568df2aa5ea8492975bbefb206a6145"><div class="ttname"><a href="namespacesago.html#ab568df2aa5ea8492975bbefb206a6145">sago::getSaveGamesFolder1</a></div><div class="ttdeci">std::string getSaveGamesFolder1()</div></div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
418 |
<div class="ttc" id="anamespacesago_html_a85c382a039426b76aa408961ac2149ee"><div class="ttname"><a href="namespacesago.html#a85c382a039426b76aa408961ac2149ee">sago::getDataHome</a></div><div class="ttdeci">std::string getDataHome()</div></div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
419 |
<div class="ttc" id="anamespacesago_html_a426458c0e30383f23ecab17bdf55a407"><div class="ttname"><a href="namespacesago.html#a426458c0e30383f23ecab17bdf55a407">sago::getCacheDir</a></div><div class="ttdeci">std::string getCacheDir()</div></div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
420 |
<div class="ttc" id="anamespacesago_html_afc7986187926c19b217427a73bdae16e"><div class="ttname"><a href="namespacesago.html#afc7986187926c19b217427a73bdae16e">sago::getSaveGamesFolder2</a></div><div class="ttdeci">std::string getSaveGamesFolder2()</div></div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
421 |
<div class="ttc" id="anamespacesago_html_a2d3b0d91188997c4949f5f39a24dd8ab"><div class="ttname"><a href="namespacesago.html#a2d3b0d91188997c4949f5f39a24dd8ab">sago::appendAdditionalDataDirectories</a></div><div class="ttdeci">void appendAdditionalDataDirectories(std::vector< std::string > &homes)</div></div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
422 |
<div class="ttc" id="anamespacesago_html_aa6c6da4e6fe460076ac069e176622f59"><div class="ttname"><a href="namespacesago.html#aa6c6da4e6fe460076ac069e176622f59">sago::getConfigHome</a></div><div class="ttdeci">std::string getConfigHome()</div></div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
423 |
<div class="ttc" id="anamespacesago_html_a760a4d546d0bccc82dc939ed6e10304d"><div class="ttname"><a href="namespacesago.html#a760a4d546d0bccc82dc939ed6e10304d">sago::appendAdditionalConfigDirectories</a></div><div class="ttdeci">void appendAdditionalConfigDirectories(std::vector< std::string > &homes)</div></div> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
424 |
<!-- start footer part --> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
425 |
<hr class="footer"/><address class="footer"><small> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
426 |
Generated on Sun Aug 8 2021 17:40:43 for Platform folders by  <a href="http://www.doxygen.org/index.html"> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
427 |
<img class="footer" src="doxygen.png" alt="doxygen"/> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
428 |
</a> 1.8.17 |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
429 |
</small></address> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
430 |
</body> |
| 9e6bb466 |
Poul Sander |
2021-08-08 15:42 |
431 |
</html> |
|
|
1970-01-01 00:00 |
432 |
|