html/doxygen/4.0.0/platform__folders_8h_source.html
browsing at commit = fc539b3fe09b2fd56775ee7beeb69556a7811e2e
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Platform folders: platform_folders.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Platform folders
 <span id="projectnumber">4.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_8e47b5f8672a00523ffcd0bfe6984bf7.html">sago</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">platform_folders.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">Its is under the MIT license, to encourage reuse by cut-and-paste.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">The original files are hosted here: https://github.com/sago007/PlatformFolders</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">Copyright (c) 2015 Poul Sander</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">Permission is hereby granted, free of charge, to any person</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">obtaining a copy of this software and associated documentation files</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">(the "Software"), to deal in the Software without restriction,</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">including without limitation the rights to use, copy, modify, merge,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">publish, distribute, sublicense, and/or sell copies of the Software,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">and to permit persons to whom the Software is furnished to do so,</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">subject to the following conditions:</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">The above copyright notice and this permission notice shall be</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">included in all copies or substantial portions of the Software.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">SOFTWARE.</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">*/</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#ifndef SAGO_PLATFORM_FOLDERS_H</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#define SAGO_PLATFORM_FOLDERS_H</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="namespacesago.html"> 38</a></span> <span class="keyword">namespace </span><a class="code" href="namespacesago.html">sago</a> {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> std::string <a class="code" href="namespacesago.html#a85c382a039426b76aa408961ac2149ee">getDataHome</a>();</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> std::string <a class="code" href="namespacesago.html#aa6c6da4e6fe460076ac069e176622f59">getConfigHome</a>();</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> std::string <a class="code" href="namespacesago.html#a426458c0e30383f23ecab17bdf55a407">getCacheDir</a>();</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keywordtype">void</span> <a class="code" href="namespacesago.html#a2d3b0d91188997c4949f5f39a24dd8ab">appendAdditionalDataDirectories</a>(std::vector<std::string>& homes);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keywordtype">void</span> <a class="code" href="namespacesago.html#a760a4d546d0bccc82dc939ed6e10304d">appendAdditionalConfigDirectories</a>(std::vector<std::string>& homes);</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> std::string <a class="code" href="namespacesago.html#ac9fc8e0a8f97b7066548223d43720ce8">getDesktopFolder</a>();</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> std::string <a class="code" href="namespacesago.html#aa44dc2057a9acdb38a10e41a60b7bb82">getDocumentsFolder</a>();</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> std::string <a class="code" href="namespacesago.html#a650b888f2d54cadfbe3347f3c9c40059">getDownloadFolder</a>();</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> std::string <a class="code" href="namespacesago.html#a853ba2c62cd283e5b8836e9aa98610f3">getDownloadFolder1</a>();</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> std::string <a class="code" href="namespacesago.html#a45b407f0581bf3ac349682eb2481c630">getPicturesFolder</a>();</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> std::string <a class="code" href="namespacesago.html#a4c436b1cbbdc85b012877bc80e769dbc">getPublicFolder</a>();</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> std::string <a class="code" href="namespacesago.html#aef0ecc52b536a96e2f3096b43acbfcbe">getMusicFolder</a>();</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> std::string <a class="code" href="namespacesago.html#a8eda16d34cba4c0f82a6e80077660780">getVideoFolder</a>();</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> std::string <a class="code" href="namespacesago.html#ab568df2aa5ea8492975bbefb206a6145">getSaveGamesFolder1</a>();</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> std::string <a class="code" href="namespacesago.html#afc7986187926c19b217427a73bdae16e">getSaveGamesFolder2</a>();</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="keyword">class </span>PlatformFolders {</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  PlatformFolders();</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  ~PlatformFolders();</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  std::string <a class="code" href="namespacesago.html#ac9fc8e0a8f97b7066548223d43720ce8">getDesktopFolder</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  std::string <a class="code" href="namespacesago.html#aa44dc2057a9acdb38a10e41a60b7bb82">getDocumentsFolder</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  std::string <a class="code" href="namespacesago.html#a45b407f0581bf3ac349682eb2481c630">getPicturesFolder</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  std::string <a class="code" href="namespacesago.html#a4c436b1cbbdc85b012877bc80e769dbc">getPublicFolder</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  std::string <a class="code" href="namespacesago.html#a853ba2c62cd283e5b8836e9aa98610f3">getDownloadFolder1</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  std::string <a class="code" href="namespacesago.html#aef0ecc52b536a96e2f3096b43acbfcbe">getMusicFolder</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  std::string <a class="code" href="namespacesago.html#a8eda16d34cba4c0f82a6e80077660780">getVideoFolder</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  std::string <a class="code" href="namespacesago.html#ab568df2aa5ea8492975bbefb206a6145">getSaveGamesFolder1</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  PlatformFolders(<span class="keyword">const</span> PlatformFolders&);</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  PlatformFolders& operator=(<span class="keyword">const</span> PlatformFolders&);</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="preprocessor">#if !defined(_WIN32) && !defined(__APPLE__)</span></div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  <span class="keyword">struct </span>PlatformFoldersData;</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  PlatformFoldersData* data;</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> };</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> </div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="preprocessor">#endif // skip doxygen</span></div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> </div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> </div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> } <span class="comment">//namespace sago</span></div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> </div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="preprocessor">#endif </span><span class="comment">/* PLATFORM_FOLDERS_H */</span><span class="preprocessor"></span></div><div class="ttc" id="namespacesago_html_a650b888f2d54cadfbe3347f3c9c40059"><div class="ttname"><a href="namespacesago.html#a650b888f2d54cadfbe3347f3c9c40059">sago::getDownloadFolder</a></div><div class="ttdeci">std::string getDownloadFolder()</div></div>
<div class="ttc" id="namespacesago_html"><div class="ttname"><a href="namespacesago.html">sago</a></div><div class="ttdef"><b>Definition:</b> platform_folders.h:38</div></div>
<div class="ttc" id="namespacesago_html_a4c436b1cbbdc85b012877bc80e769dbc"><div class="ttname"><a href="namespacesago.html#a4c436b1cbbdc85b012877bc80e769dbc">sago::getPublicFolder</a></div><div class="ttdeci">std::string getPublicFolder()</div></div>
<div class="ttc" id="namespacesago_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>
<div class="ttc" id="namespacesago_html_ac9fc8e0a8f97b7066548223d43720ce8"><div class="ttname"><a href="namespacesago.html#ac9fc8e0a8f97b7066548223d43720ce8">sago::getDesktopFolder</a></div><div class="ttdeci">std::string getDesktopFolder()</div></div>
<div class="ttc" id="namespacesago_html_a426458c0e30383f23ecab17bdf55a407"><div class="ttname"><a href="namespacesago.html#a426458c0e30383f23ecab17bdf55a407">sago::getCacheDir</a></div><div class="ttdeci">std::string getCacheDir()</div></div>
<div class="ttc" id="namespacesago_html_aa44dc2057a9acdb38a10e41a60b7bb82"><div class="ttname"><a href="namespacesago.html#aa44dc2057a9acdb38a10e41a60b7bb82">sago::getDocumentsFolder</a></div><div class="ttdeci">std::string getDocumentsFolder()</div></div>
<div class="ttc" id="namespacesago_html_a853ba2c62cd283e5b8836e9aa98610f3"><div class="ttname"><a href="namespacesago.html#a853ba2c62cd283e5b8836e9aa98610f3">sago::getDownloadFolder1</a></div><div class="ttdeci">std::string getDownloadFolder1()</div></div>
<div class="ttc" id="namespacesago_html_aa6c6da4e6fe460076ac069e176622f59"><div class="ttname"><a href="namespacesago.html#aa6c6da4e6fe460076ac069e176622f59">sago::getConfigHome</a></div><div class="ttdeci">std::string getConfigHome()</div></div>
<div class="ttc" id="namespacesago_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>
<div class="ttc" id="namespacesago_html_aef0ecc52b536a96e2f3096b43acbfcbe"><div class="ttname"><a href="namespacesago.html#aef0ecc52b536a96e2f3096b43acbfcbe">sago::getMusicFolder</a></div><div class="ttdeci">std::string getMusicFolder()</div></div>
<div class="ttc" id="namespacesago_html_afc7986187926c19b217427a73bdae16e"><div class="ttname"><a href="namespacesago.html#afc7986187926c19b217427a73bdae16e">sago::getSaveGamesFolder2</a></div><div class="ttdeci">std::string getSaveGamesFolder2()</div></div>
<div class="ttc" id="namespacesago_html_a45b407f0581bf3ac349682eb2481c630"><div class="ttname"><a href="namespacesago.html#a45b407f0581bf3ac349682eb2481c630">sago::getPicturesFolder</a></div><div class="ttdeci">std::string getPicturesFolder()</div></div>
<div class="ttc" id="namespacesago_html_a8eda16d34cba4c0f82a6e80077660780"><div class="ttname"><a href="namespacesago.html#a8eda16d34cba4c0f82a6e80077660780">sago::getVideoFolder</a></div><div class="ttdeci">std::string getVideoFolder()</div></div>
<div class="ttc" id="namespacesago_html_ab568df2aa5ea8492975bbefb206a6145"><div class="ttname"><a href="namespacesago.html#ab568df2aa5ea8492975bbefb206a6145">sago::getSaveGamesFolder1</a></div><div class="ttdeci">std::string getSaveGamesFolder1()</div></div>
<div class="ttc" id="namespacesago_html_a85c382a039426b76aa408961ac2149ee"><div class="ttname"><a href="namespacesago.html#a85c382a039426b76aa408961ac2149ee">sago::getDataHome</a></div><div class="ttdeci">std::string getDataHome()</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jun 24 2018 16:42:25 for Platform folders by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>