git repos / PlatformFolders

blame: html/doxygen/3.2.0/namespacesago.html

normal view · raw

04ab3520 sago007 2018-05-27 13:05 1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
04ab3520 sago007 2018-05-27 13:05 2
<html xmlns="http://www.w3.org/1999/xhtml">
04ab3520 sago007 2018-05-27 13:05 3
<head>
04ab3520 sago007 2018-05-27 13:05 4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
04ab3520 sago007 2018-05-27 13:05 5
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
04ab3520 sago007 2018-05-27 13:05 6
<meta name="generator" content="Doxygen 1.8.13"/>
04ab3520 sago007 2018-05-27 13:05 7
<meta name="viewport" content="width=device-width, initial-scale=1"/>
04ab3520 sago007 2018-05-27 13:05 8
<title>Platform folders: sago Namespace Reference</title>
04ab3520 sago007 2018-05-27 13:05 9
<link href="tabs.css" rel="stylesheet" type="text/css"/>
04ab3520 sago007 2018-05-27 13:05 10
<script type="text/javascript" src="jquery.js"></script>
04ab3520 sago007 2018-05-27 13:05 11
<script type="text/javascript" src="dynsections.js"></script>
04ab3520 sago007 2018-05-27 13:05 12
<link href="search/search.css" rel="stylesheet" type="text/css"/>
04ab3520 sago007 2018-05-27 13:05 13
<script type="text/javascript" src="search/searchdata.js"></script>
04ab3520 sago007 2018-05-27 13:05 14
<script type="text/javascript" src="search/search.js"></script>
04ab3520 sago007 2018-05-27 13:05 15
<link href="doxygen.css" rel="stylesheet" type="text/css" />
04ab3520 sago007 2018-05-27 13:05 16
</head>
04ab3520 sago007 2018-05-27 13:05 17
<body>
04ab3520 sago007 2018-05-27 13:05 18
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
04ab3520 sago007 2018-05-27 13:05 19
<div id="titlearea">
04ab3520 sago007 2018-05-27 13:05 20
<table cellspacing="0" cellpadding="0">
04ab3520 sago007 2018-05-27 13:05 21
 <tbody>
04ab3520 sago007 2018-05-27 13:05 22
 <tr style="height: 56px;">
04ab3520 sago007 2018-05-27 13:05 23
  <td id="projectalign" style="padding-left: 0.5em;">
04ab3520 sago007 2018-05-27 13:05 24
   <div id="projectname">Platform folders
04ab3520 sago007 2018-05-27 13:05 25
   &#160;<span id="projectnumber">3.2.0</span>
04ab3520 sago007 2018-05-27 13:05 26
   </div>
04ab3520 sago007 2018-05-27 13:05 27
  </td>
04ab3520 sago007 2018-05-27 13:05 28
 </tr>
04ab3520 sago007 2018-05-27 13:05 29
 </tbody>
04ab3520 sago007 2018-05-27 13:05 30
</table>
04ab3520 sago007 2018-05-27 13:05 31
</div>
04ab3520 sago007 2018-05-27 13:05 32
<!-- end header part -->
04ab3520 sago007 2018-05-27 13:05 33
<!-- Generated by Doxygen 1.8.13 -->
04ab3520 sago007 2018-05-27 13:05 34
<script type="text/javascript">
04ab3520 sago007 2018-05-27 13:05 35
var searchBox = new SearchBox("searchBox", "search",false,'Search');
04ab3520 sago007 2018-05-27 13:05 36
</script>
04ab3520 sago007 2018-05-27 13:05 37
<script type="text/javascript" src="menudata.js"></script>
04ab3520 sago007 2018-05-27 13:05 38
<script type="text/javascript" src="menu.js"></script>
04ab3520 sago007 2018-05-27 13:05 39
<script type="text/javascript">
04ab3520 sago007 2018-05-27 13:05 40
$(function() {
04ab3520 sago007 2018-05-27 13:05 41
  initMenu('',true,false,'search.php','Search');
04ab3520 sago007 2018-05-27 13:05 42
  $(document).ready(function() { init_search(); });
04ab3520 sago007 2018-05-27 13:05 43
});
04ab3520 sago007 2018-05-27 13:05 44
</script>
04ab3520 sago007 2018-05-27 13:05 45
<div id="main-nav"></div>
04ab3520 sago007 2018-05-27 13:05 46
<!-- window showing the filter options -->
04ab3520 sago007 2018-05-27 13:05 47
<div id="MSearchSelectWindow"
04ab3520 sago007 2018-05-27 13:05 48
     onmouseover="return searchBox.OnSearchSelectShow()"
04ab3520 sago007 2018-05-27 13:05 49
     onmouseout="return searchBox.OnSearchSelectHide()"
04ab3520 sago007 2018-05-27 13:05 50
     onkeydown="return searchBox.OnSearchSelectKey(event)">
04ab3520 sago007 2018-05-27 13:05 51
</div>
04ab3520 sago007 2018-05-27 13:05 52
04ab3520 sago007 2018-05-27 13:05 53
<!-- iframe showing the search results (closed by default) -->
04ab3520 sago007 2018-05-27 13:05 54
<div id="MSearchResultsWindow">
04ab3520 sago007 2018-05-27 13:05 55
<iframe src="javascript:void(0)" frameborder="0" 
04ab3520 sago007 2018-05-27 13:05 56
        name="MSearchResults" id="MSearchResults">
04ab3520 sago007 2018-05-27 13:05 57
</iframe>
04ab3520 sago007 2018-05-27 13:05 58
</div>
04ab3520 sago007 2018-05-27 13:05 59
04ab3520 sago007 2018-05-27 13:05 60
</div><!-- top -->
04ab3520 sago007 2018-05-27 13:05 61
<div class="header">
04ab3520 sago007 2018-05-27 13:05 62
  <div class="summary">
04ab3520 sago007 2018-05-27 13:05 63
<a href="#nested-classes">Classes</a> &#124;
04ab3520 sago007 2018-05-27 13:05 64
<a href="#func-members">Functions</a>  </div>
04ab3520 sago007 2018-05-27 13:05 65
  <div class="headertitle">
04ab3520 sago007 2018-05-27 13:05 66
<div class="title">sago Namespace Reference</div>  </div>
04ab3520 sago007 2018-05-27 13:05 67
</div><!--header-->
04ab3520 sago007 2018-05-27 13:05 68
<div class="contents">
04ab3520 sago007 2018-05-27 13:05 69
<table class="memberdecls">
04ab3520 sago007 2018-05-27 13:05 70
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
04ab3520 sago007 2018-05-27 13:05 71
Classes</h2></td></tr>
04ab3520 sago007 2018-05-27 13:05 72
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsago_1_1PlatformFolders.html">PlatformFolders</a></td></tr>
04ab3520 sago007 2018-05-27 13:05 73
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
04ab3520 sago007 2018-05-27 13:05 74
</table><table class="memberdecls">
04ab3520 sago007 2018-05-27 13:05 75
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
04ab3520 sago007 2018-05-27 13:05 76
Functions</h2></td></tr>
04ab3520 sago007 2018-05-27 13:05 77
<tr class="memitem:a85c382a039426b76aa408961ac2149ee"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a85c382a039426b76aa408961ac2149ee">getDataHome</a> ()</td></tr>
04ab3520 sago007 2018-05-27 13:05 78
<tr class="separator:a85c382a039426b76aa408961ac2149ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
04ab3520 sago007 2018-05-27 13:05 79
<tr class="memitem:aa6c6da4e6fe460076ac069e176622f59"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#aa6c6da4e6fe460076ac069e176622f59">getConfigHome</a> ()</td></tr>
04ab3520 sago007 2018-05-27 13:05 80
<tr class="separator:aa6c6da4e6fe460076ac069e176622f59"><td class="memSeparator" colspan="2">&#160;</td></tr>
04ab3520 sago007 2018-05-27 13:05 81
<tr class="memitem:a426458c0e30383f23ecab17bdf55a407"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a426458c0e30383f23ecab17bdf55a407">getCacheDir</a> ()</td></tr>
04ab3520 sago007 2018-05-27 13:05 82
<tr class="separator:a426458c0e30383f23ecab17bdf55a407"><td class="memSeparator" colspan="2">&#160;</td></tr>
04ab3520 sago007 2018-05-27 13:05 83
<tr class="memitem:a2d3b0d91188997c4949f5f39a24dd8ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a2d3b0d91188997c4949f5f39a24dd8ab">appendAdditionalDataDirectories</a> (std::vector&lt; std::string &gt; &amp;homes)</td></tr>
04ab3520 sago007 2018-05-27 13:05 84
<tr class="separator:a2d3b0d91188997c4949f5f39a24dd8ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
04ab3520 sago007 2018-05-27 13:05 85
<tr class="memitem:a760a4d546d0bccc82dc939ed6e10304d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a760a4d546d0bccc82dc939ed6e10304d">appendAdditionalConfigDirectories</a> (std::vector&lt; std::string &gt; &amp;homes)</td></tr>
04ab3520 sago007 2018-05-27 13:05 86
<tr class="separator:a760a4d546d0bccc82dc939ed6e10304d"><td class="memSeparator" colspan="2">&#160;</td></tr>
04ab3520 sago007 2018-05-27 13:05 87
<tr class="memitem:ac9fc8e0a8f97b7066548223d43720ce8"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#ac9fc8e0a8f97b7066548223d43720ce8">getDesktopFolder</a> ()</td></tr>
04ab3520 sago007 2018-05-27 13:05 88
<tr class="separator:ac9fc8e0a8f97b7066548223d43720ce8"><td class="memSeparator" colspan="2">&#160;</td></tr>
04ab3520 sago007 2018-05-27 13:05 89
<tr class="memitem:aa44dc2057a9acdb38a10e41a60b7bb82"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#aa44dc2057a9acdb38a10e41a60b7bb82">getDocumentsFolder</a> ()</td></tr>
04ab3520 sago007 2018-05-27 13:05 90
<tr class="separator:aa44dc2057a9acdb38a10e41a60b7bb82"><td class="memSeparator" colspan="2">&#160;</td></tr>
04ab3520 sago007 2018-05-27 13:05 91
<tr class="memitem:a853ba2c62cd283e5b8836e9aa98610f3"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a853ba2c62cd283e5b8836e9aa98610f3">getDownloadFolder1</a> ()</td></tr>
04ab3520 sago007 2018-05-27 13:05 92
<tr class="separator:a853ba2c62cd283e5b8836e9aa98610f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
04ab3520 sago007 2018-05-27 13:05 93
<tr class="memitem:a45b407f0581bf3ac349682eb2481c630"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a45b407f0581bf3ac349682eb2481c630">getPicturesFolder</a> ()</td></tr>
04ab3520 sago007 2018-05-27 13:05 94
<tr class="separator:a45b407f0581bf3ac349682eb2481c630"><td class="memSeparator" colspan="2">&#160;</td></tr>
04ab3520 sago007 2018-05-27 13:05 95
<tr class="memitem:aef0ecc52b536a96e2f3096b43acbfcbe"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#aef0ecc52b536a96e2f3096b43acbfcbe">getMusicFolder</a> ()</td></tr>
04ab3520 sago007 2018-05-27 13:05 96
<tr class="separator:aef0ecc52b536a96e2f3096b43acbfcbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
04ab3520 sago007 2018-05-27 13:05 97
<tr class="memitem:a8eda16d34cba4c0f82a6e80077660780"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a8eda16d34cba4c0f82a6e80077660780">getVideoFolder</a> ()</td></tr>
04ab3520 sago007 2018-05-27 13:05 98
<tr class="separator:a8eda16d34cba4c0f82a6e80077660780"><td class="memSeparator" colspan="2">&#160;</td></tr>
04ab3520 sago007 2018-05-27 13:05 99
<tr class="memitem:ab568df2aa5ea8492975bbefb206a6145"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#ab568df2aa5ea8492975bbefb206a6145">getSaveGamesFolder1</a> ()</td></tr>
04ab3520 sago007 2018-05-27 13:05 100
<tr class="separator:ab568df2aa5ea8492975bbefb206a6145"><td class="memSeparator" colspan="2">&#160;</td></tr>
04ab3520 sago007 2018-05-27 13:05 101
</table>
04ab3520 sago007 2018-05-27 13:05 102
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
04ab3520 sago007 2018-05-27 13:05 103
<div class="textblock"><p>The namespace I use for common function. Nothing special about it. </p>
04ab3520 sago007 2018-05-27 13:05 104
</div><h2 class="groupheader">Function Documentation</h2>
04ab3520 sago007 2018-05-27 13:05 105
<a id="a760a4d546d0bccc82dc939ed6e10304d"></a>
04ab3520 sago007 2018-05-27 13:05 106
<h2 class="memtitle"><span class="permalink"><a href="#a760a4d546d0bccc82dc939ed6e10304d">&#9670;&nbsp;</a></span>appendAdditionalConfigDirectories()</h2>
04ab3520 sago007 2018-05-27 13:05 107
04ab3520 sago007 2018-05-27 13:05 108
<div class="memitem">
04ab3520 sago007 2018-05-27 13:05 109
<div class="memproto">
04ab3520 sago007 2018-05-27 13:05 110
      <table class="memname">
04ab3520 sago007 2018-05-27 13:05 111
        <tr>
04ab3520 sago007 2018-05-27 13:05 112
          <td class="memname">void sago::appendAdditionalConfigDirectories </td>
04ab3520 sago007 2018-05-27 13:05 113
          <td>(</td>
04ab3520 sago007 2018-05-27 13:05 114
          <td class="paramtype">std::vector&lt; std::string &gt; &amp;&#160;</td>
04ab3520 sago007 2018-05-27 13:05 115
          <td class="paramname"><em>homes</em></td><td>)</td>
04ab3520 sago007 2018-05-27 13:05 116
          <td></td>
04ab3520 sago007 2018-05-27 13:05 117
        </tr>
04ab3520 sago007 2018-05-27 13:05 118
      </table>
04ab3520 sago007 2018-05-27 13:05 119
</div><div class="memdoc">
04ab3520 sago007 2018-05-27 13:05 120
<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&lt;std::string&gt; folders;</div><div class="line">folders.push_back(<a class="code" href="namespacesago.html#aa6c6da4e6fe460076ac069e176622f59">sago::getConfigHome</a>());</div><div class="line"><a class="code" href="namespacesago.html#a760a4d546d0bccc82dc939ed6e10304d">sago::appendAdditionalConfigDirectories</a>(folders);</div><div class="line"><span class="keywordflow">for</span> (std::string s&amp; : folders) {</div><div class="line">    s+=<span class="stringliteral">&quot;/My Program Name/&quot;</span>;</div><div class="line">}</div></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>
04ab3520 sago007 2018-05-27 13:05 121
  <table class="params">
04ab3520 sago007 2018-05-27 13:05 122
    <tr><td class="paramname">homes</td><td>A vector that extra folders will be appended to. </td></tr>
04ab3520 sago007 2018-05-27 13:05 123
  </table>
04ab3520 sago007 2018-05-27 13:05 124
  </dd>
04ab3520 sago007 2018-05-27 13:05 125
</dl>
04ab3520 sago007 2018-05-27 13:05 126
04ab3520 sago007 2018-05-27 13:05 127
</div>
04ab3520 sago007 2018-05-27 13:05 128
</div>
04ab3520 sago007 2018-05-27 13:05 129
<a id="a2d3b0d91188997c4949f5f39a24dd8ab"></a>
04ab3520 sago007 2018-05-27 13:05 130
<h2 class="memtitle"><span class="permalink"><a href="#a2d3b0d91188997c4949f5f39a24dd8ab">&#9670;&nbsp;</a></span>appendAdditionalDataDirectories()</h2>
04ab3520 sago007 2018-05-27 13:05 131
04ab3520 sago007 2018-05-27 13:05 132
<div class="memitem">
04ab3520 sago007 2018-05-27 13:05 133
<div class="memproto">
04ab3520 sago007 2018-05-27 13:05 134
      <table class="memname">
04ab3520 sago007 2018-05-27 13:05 135
        <tr>
04ab3520 sago007 2018-05-27 13:05 136
          <td class="memname">void sago::appendAdditionalDataDirectories </td>
04ab3520 sago007 2018-05-27 13:05 137
          <td>(</td>
04ab3520 sago007 2018-05-27 13:05 138
          <td class="paramtype">std::vector&lt; std::string &gt; &amp;&#160;</td>
04ab3520 sago007 2018-05-27 13:05 139
          <td class="paramname"><em>homes</em></td><td>)</td>
04ab3520 sago007 2018-05-27 13:05 140
          <td></td>
04ab3520 sago007 2018-05-27 13:05 141
        </tr>
04ab3520 sago007 2018-05-27 13:05 142
      </table>
04ab3520 sago007 2018-05-27 13:05 143
</div><div class="memdoc">
04ab3520 sago007 2018-05-27 13:05 144
<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&lt;string&gt; folders;</div><div class="line">folders.push_back(<a class="code" href="namespacesago.html#a85c382a039426b76aa408961ac2149ee">getDataHome</a>());</div><div class="line"><a class="code" href="namespacesago.html#a2d3b0d91188997c4949f5f39a24dd8ab">appendAdditionalDataDirectories</a>(folders);</div><div class="line"><span class="keywordflow">for</span> (<span class="keywordtype">string</span> s&amp; : folders) {</div><div class="line">    s+=<span class="stringliteral">&quot;/My Program Name/&quot;</span>;</div><div class="line">}</div></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>
04ab3520 sago007 2018-05-27 13:05 145
  <table class="params">
04ab3520 sago007 2018-05-27 13:05 146
    <tr><td class="paramname">homes</td><td>A vector that extra folders will be appended to. </td></tr>
04ab3520 sago007 2018-05-27 13:05 147
  </table>
04ab3520 sago007 2018-05-27 13:05 148
  </dd>
04ab3520 sago007 2018-05-27 13:05 149
</dl>
04ab3520 sago007 2018-05-27 13:05 150
04ab3520 sago007 2018-05-27 13:05 151
</div>
04ab3520 sago007 2018-05-27 13:05 152
</div>
04ab3520 sago007 2018-05-27 13:05 153
<a id="a426458c0e30383f23ecab17bdf55a407"></a>
04ab3520 sago007 2018-05-27 13:05 154
<h2 class="memtitle"><span class="permalink"><a href="#a426458c0e30383f23ecab17bdf55a407">&#9670;&nbsp;</a></span>getCacheDir()</h2>
04ab3520 sago007 2018-05-27 13:05 155
04ab3520 sago007 2018-05-27 13:05 156
<div class="memitem">
04ab3520 sago007 2018-05-27 13:05 157
<div class="memproto">
04ab3520 sago007 2018-05-27 13:05 158
      <table class="memname">
04ab3520 sago007 2018-05-27 13:05 159
        <tr>
04ab3520 sago007 2018-05-27 13:05 160
          <td class="memname">std::string sago::getCacheDir </td>
04ab3520 sago007 2018-05-27 13:05 161
          <td>(</td>
04ab3520 sago007 2018-05-27 13:05 162
          <td class="paramname"></td><td>)</td>
04ab3520 sago007 2018-05-27 13:05 163
          <td></td>
04ab3520 sago007 2018-05-27 13:05 164
        </tr>
04ab3520 sago007 2018-05-27 13:05 165
      </table>
04ab3520 sago007 2018-05-27 13:05 166
</div><div class="memdoc">
04ab3520 sago007 2018-05-27 13:05 167
<p>Retrives the base folder for storring 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">&quot;/My Program Name/&quot;</span>;</div></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 storring data that do not need to be backed up. </dd></dl>
04ab3520 sago007 2018-05-27 13:05 168
04ab3520 sago007 2018-05-27 13:05 169
</div>
04ab3520 sago007 2018-05-27 13:05 170
</div>
04ab3520 sago007 2018-05-27 13:05 171
<a id="aa6c6da4e6fe460076ac069e176622f59"></a>
04ab3520 sago007 2018-05-27 13:05 172
<h2 class="memtitle"><span class="permalink"><a href="#aa6c6da4e6fe460076ac069e176622f59">&#9670;&nbsp;</a></span>getConfigHome()</h2>
04ab3520 sago007 2018-05-27 13:05 173
04ab3520 sago007 2018-05-27 13:05 174
<div class="memitem">
04ab3520 sago007 2018-05-27 13:05 175
<div class="memproto">
04ab3520 sago007 2018-05-27 13:05 176
      <table class="memname">
04ab3520 sago007 2018-05-27 13:05 177
        <tr>
04ab3520 sago007 2018-05-27 13:05 178
          <td class="memname">std::string sago::getConfigHome </td>
04ab3520 sago007 2018-05-27 13:05 179
          <td>(</td>
04ab3520 sago007 2018-05-27 13:05 180
          <td class="paramname"></td><td>)</td>
04ab3520 sago007 2018-05-27 13:05 181
          <td></td>
04ab3520 sago007 2018-05-27 13:05 182
        </tr>
04ab3520 sago007 2018-05-27 13:05 183
      </table>
04ab3520 sago007 2018-05-27 13:05 184
</div><div class="memdoc">
04ab3520 sago007 2018-05-27 13:05 185
<p>Retrives the base folder for storring 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">&quot;/My Program Name/&quot;</span>;</div></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 storring config data. </dd></dl>
04ab3520 sago007 2018-05-27 13:05 186
04ab3520 sago007 2018-05-27 13:05 187
</div>
04ab3520 sago007 2018-05-27 13:05 188
</div>
04ab3520 sago007 2018-05-27 13:05 189
<a id="a85c382a039426b76aa408961ac2149ee"></a>
04ab3520 sago007 2018-05-27 13:05 190
<h2 class="memtitle"><span class="permalink"><a href="#a85c382a039426b76aa408961ac2149ee">&#9670;&nbsp;</a></span>getDataHome()</h2>
04ab3520 sago007 2018-05-27 13:05 191
04ab3520 sago007 2018-05-27 13:05 192
<div class="memitem">
04ab3520 sago007 2018-05-27 13:05 193
<div class="memproto">
04ab3520 sago007 2018-05-27 13:05 194
      <table class="memname">
04ab3520 sago007 2018-05-27 13:05 195
        <tr>
04ab3520 sago007 2018-05-27 13:05 196
          <td class="memname">std::string sago::getDataHome </td>
04ab3520 sago007 2018-05-27 13:05 197
          <td>(</td>
04ab3520 sago007 2018-05-27 13:05 198
          <td class="paramname"></td><td>)</td>
04ab3520 sago007 2018-05-27 13:05 199
          <td></td>
04ab3520 sago007 2018-05-27 13:05 200
        </tr>
04ab3520 sago007 2018-05-27 13:05 201
      </table>
04ab3520 sago007 2018-05-27 13:05 202
</div><div class="memdoc">
04ab3520 sago007 2018-05-27 13:05 203
<p>Retrives the base folder for storring 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">&quot;/My Program Name/&quot;</span>;</div></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 storring program data. </dd></dl>
04ab3520 sago007 2018-05-27 13:05 204
04ab3520 sago007 2018-05-27 13:05 205
</div>
04ab3520 sago007 2018-05-27 13:05 206
</div>
04ab3520 sago007 2018-05-27 13:05 207
<a id="ac9fc8e0a8f97b7066548223d43720ce8"></a>
04ab3520 sago007 2018-05-27 13:05 208
<h2 class="memtitle"><span class="permalink"><a href="#ac9fc8e0a8f97b7066548223d43720ce8">&#9670;&nbsp;</a></span>getDesktopFolder()</h2>
04ab3520 sago007 2018-05-27 13:05 209
04ab3520 sago007 2018-05-27 13:05 210
<div class="memitem">
04ab3520 sago007 2018-05-27 13:05 211
<div class="memproto">
04ab3520 sago007 2018-05-27 13:05 212
      <table class="memname">
04ab3520 sago007 2018-05-27 13:05 213
        <tr>
04ab3520 sago007 2018-05-27 13:05 214
          <td class="memname">std::string sago::getDesktopFolder </td>
04ab3520 sago007 2018-05-27 13:05 215
          <td>(</td>
04ab3520 sago007 2018-05-27 13:05 216
          <td class="paramname"></td><td>)</td>
04ab3520 sago007 2018-05-27 13:05 217
          <td></td>
04ab3520 sago007 2018-05-27 13:05 218
        </tr>
04ab3520 sago007 2018-05-27 13:05 219
      </table>
04ab3520 sago007 2018-05-27 13:05 220
</div><div class="memdoc">
04ab3520 sago007 2018-05-27 13:05 221
<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>
04ab3520 sago007 2018-05-27 13:05 222
04ab3520 sago007 2018-05-27 13:05 223
</div>
04ab3520 sago007 2018-05-27 13:05 224
</div>
04ab3520 sago007 2018-05-27 13:05 225
<a id="aa44dc2057a9acdb38a10e41a60b7bb82"></a>
04ab3520 sago007 2018-05-27 13:05 226
<h2 class="memtitle"><span class="permalink"><a href="#aa44dc2057a9acdb38a10e41a60b7bb82">&#9670;&nbsp;</a></span>getDocumentsFolder()</h2>
04ab3520 sago007 2018-05-27 13:05 227
04ab3520 sago007 2018-05-27 13:05 228
<div class="memitem">
04ab3520 sago007 2018-05-27 13:05 229
<div class="memproto">
04ab3520 sago007 2018-05-27 13:05 230
      <table class="memname">
04ab3520 sago007 2018-05-27 13:05 231
        <tr>
04ab3520 sago007 2018-05-27 13:05 232
          <td class="memname">std::string sago::getDocumentsFolder </td>
04ab3520 sago007 2018-05-27 13:05 233
          <td>(</td>
04ab3520 sago007 2018-05-27 13:05 234
          <td class="paramname"></td><td>)</td>
04ab3520 sago007 2018-05-27 13:05 235
          <td></td>
04ab3520 sago007 2018-05-27 13:05 236
        </tr>
04ab3520 sago007 2018-05-27 13:05 237
      </table>
04ab3520 sago007 2018-05-27 13:05 238
</div><div class="memdoc">
04ab3520 sago007 2018-05-27 13:05 239
<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>
04ab3520 sago007 2018-05-27 13:05 240
04ab3520 sago007 2018-05-27 13:05 241
</div>
04ab3520 sago007 2018-05-27 13:05 242
</div>
04ab3520 sago007 2018-05-27 13:05 243
<a id="a853ba2c62cd283e5b8836e9aa98610f3"></a>
04ab3520 sago007 2018-05-27 13:05 244
<h2 class="memtitle"><span class="permalink"><a href="#a853ba2c62cd283e5b8836e9aa98610f3">&#9670;&nbsp;</a></span>getDownloadFolder1()</h2>
04ab3520 sago007 2018-05-27 13:05 245
04ab3520 sago007 2018-05-27 13:05 246
<div class="memitem">
04ab3520 sago007 2018-05-27 13:05 247
<div class="memproto">
04ab3520 sago007 2018-05-27 13:05 248
      <table class="memname">
04ab3520 sago007 2018-05-27 13:05 249
        <tr>
04ab3520 sago007 2018-05-27 13:05 250
          <td class="memname">std::string sago::getDownloadFolder1 </td>
04ab3520 sago007 2018-05-27 13:05 251
          <td>(</td>
04ab3520 sago007 2018-05-27 13:05 252
          <td class="paramname"></td><td>)</td>
04ab3520 sago007 2018-05-27 13:05 253
          <td></td>
04ab3520 sago007 2018-05-27 13:05 254
        </tr>
04ab3520 sago007 2018-05-27 13:05 255
      </table>
04ab3520 sago007 2018-05-27 13:05 256
</div><div class="memdoc">
04ab3520 sago007 2018-05-27 13:05 257
<p>The folder where files are downloaded. </p><dl class="section note"><dt>Note</dt><dd>Windows: This version is XP compatible and returns the Desktop. Vista and later has a dedicated folder. </dd></dl>
04ab3520 sago007 2018-05-27 13:05 258
<dl class="section return"><dt>Returns</dt><dd>Absolute path to the folder where files are downloaded to. </dd></dl>
04ab3520 sago007 2018-05-27 13:05 259
04ab3520 sago007 2018-05-27 13:05 260
</div>
04ab3520 sago007 2018-05-27 13:05 261
</div>
04ab3520 sago007 2018-05-27 13:05 262
<a id="aef0ecc52b536a96e2f3096b43acbfcbe"></a>
04ab3520 sago007 2018-05-27 13:05 263
<h2 class="memtitle"><span class="permalink"><a href="#aef0ecc52b536a96e2f3096b43acbfcbe">&#9670;&nbsp;</a></span>getMusicFolder()</h2>
04ab3520 sago007 2018-05-27 13:05 264
04ab3520 sago007 2018-05-27 13:05 265
<div class="memitem">
04ab3520 sago007 2018-05-27 13:05 266
<div class="memproto">
04ab3520 sago007 2018-05-27 13:05 267
      <table class="memname">
04ab3520 sago007 2018-05-27 13:05 268
        <tr>
04ab3520 sago007 2018-05-27 13:05 269
          <td class="memname">std::string sago::getMusicFolder </td>
04ab3520 sago007 2018-05-27 13:05 270
          <td>(</td>
04ab3520 sago007 2018-05-27 13:05 271
          <td class="paramname"></td><td>)</td>
04ab3520 sago007 2018-05-27 13:05 272
          <td></td>
04ab3520 sago007 2018-05-27 13:05 273
        </tr>
04ab3520 sago007 2018-05-27 13:05 274
      </table>
04ab3520 sago007 2018-05-27 13:05 275
</div><div class="memdoc">
04ab3520 sago007 2018-05-27 13:05 276
<p>The folder where music is stored </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the music folder </dd></dl>
04ab3520 sago007 2018-05-27 13:05 277
04ab3520 sago007 2018-05-27 13:05 278
</div>
04ab3520 sago007 2018-05-27 13:05 279
</div>
04ab3520 sago007 2018-05-27 13:05 280
<a id="a45b407f0581bf3ac349682eb2481c630"></a>
04ab3520 sago007 2018-05-27 13:05 281
<h2 class="memtitle"><span class="permalink"><a href="#a45b407f0581bf3ac349682eb2481c630">&#9670;&nbsp;</a></span>getPicturesFolder()</h2>
04ab3520 sago007 2018-05-27 13:05 282
04ab3520 sago007 2018-05-27 13:05 283
<div class="memitem">
04ab3520 sago007 2018-05-27 13:05 284
<div class="memproto">
04ab3520 sago007 2018-05-27 13:05 285
      <table class="memname">
04ab3520 sago007 2018-05-27 13:05 286
        <tr>
04ab3520 sago007 2018-05-27 13:05 287
          <td class="memname">std::string sago::getPicturesFolder </td>
04ab3520 sago007 2018-05-27 13:05 288
          <td>(</td>
04ab3520 sago007 2018-05-27 13:05 289
          <td class="paramname"></td><td>)</td>
04ab3520 sago007 2018-05-27 13:05 290
          <td></td>
04ab3520 sago007 2018-05-27 13:05 291
        </tr>
04ab3520 sago007 2018-05-27 13:05 292
      </table>
04ab3520 sago007 2018-05-27 13:05 293
</div><div class="memdoc">
04ab3520 sago007 2018-05-27 13:05 294
<p>The folder for storring the user's pictures. </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the "Picture" folder </dd></dl>
04ab3520 sago007 2018-05-27 13:05 295
04ab3520 sago007 2018-05-27 13:05 296
</div>
04ab3520 sago007 2018-05-27 13:05 297
</div>
04ab3520 sago007 2018-05-27 13:05 298
<a id="ab568df2aa5ea8492975bbefb206a6145"></a>
04ab3520 sago007 2018-05-27 13:05 299
<h2 class="memtitle"><span class="permalink"><a href="#ab568df2aa5ea8492975bbefb206a6145">&#9670;&nbsp;</a></span>getSaveGamesFolder1()</h2>
04ab3520 sago007 2018-05-27 13:05 300
04ab3520 sago007 2018-05-27 13:05 301
<div class="memitem">
04ab3520 sago007 2018-05-27 13:05 302
<div class="memproto">
04ab3520 sago007 2018-05-27 13:05 303
      <table class="memname">
04ab3520 sago007 2018-05-27 13:05 304
        <tr>
04ab3520 sago007 2018-05-27 13:05 305
          <td class="memname">std::string sago::getSaveGamesFolder1 </td>
04ab3520 sago007 2018-05-27 13:05 306
          <td>(</td>
04ab3520 sago007 2018-05-27 13:05 307
          <td class="paramname"></td><td>)</td>
04ab3520 sago007 2018-05-27 13:05 308
          <td></td>
04ab3520 sago007 2018-05-27 13:05 309
        </tr>
04ab3520 sago007 2018-05-27 13:05 310
      </table>
04ab3520 sago007 2018-05-27 13:05 311
</div><div class="memdoc">
71963b54 sago007 2018-05-27 13:18 312
<p>The base folder for storring 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">&quot;/My Program Name/&quot;</span>;</div></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>
04ab3520 sago007 2018-05-27 13:05 313
<dd>
04ab3520 sago007 2018-05-27 13:05 314
Linux: XDF does not define a folder for saved games. This will just return the same as GetDataHome() </dd></dl>
04ab3520 sago007 2018-05-27 13:05 315
<dl class="section return"><dt>Returns</dt><dd>The folder base folder for storring save games. </dd></dl>
04ab3520 sago007 2018-05-27 13:05 316
04ab3520 sago007 2018-05-27 13:05 317
</div>
04ab3520 sago007 2018-05-27 13:05 318
</div>
04ab3520 sago007 2018-05-27 13:05 319
<a id="a8eda16d34cba4c0f82a6e80077660780"></a>
04ab3520 sago007 2018-05-27 13:05 320
<h2 class="memtitle"><span class="permalink"><a href="#a8eda16d34cba4c0f82a6e80077660780">&#9670;&nbsp;</a></span>getVideoFolder()</h2>
04ab3520 sago007 2018-05-27 13:05 321
04ab3520 sago007 2018-05-27 13:05 322
<div class="memitem">
04ab3520 sago007 2018-05-27 13:05 323
<div class="memproto">
04ab3520 sago007 2018-05-27 13:05 324
      <table class="memname">
04ab3520 sago007 2018-05-27 13:05 325
        <tr>
04ab3520 sago007 2018-05-27 13:05 326
          <td class="memname">std::string sago::getVideoFolder </td>
04ab3520 sago007 2018-05-27 13:05 327
          <td>(</td>
04ab3520 sago007 2018-05-27 13:05 328
          <td class="paramname"></td><td>)</td>
04ab3520 sago007 2018-05-27 13:05 329
          <td></td>
04ab3520 sago007 2018-05-27 13:05 330
        </tr>
04ab3520 sago007 2018-05-27 13:05 331
      </table>
04ab3520 sago007 2018-05-27 13:05 332
</div><div class="memdoc">
04ab3520 sago007 2018-05-27 13:05 333
<p>The folder where video is stored </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the video folder </dd></dl>
04ab3520 sago007 2018-05-27 13:05 334
04ab3520 sago007 2018-05-27 13:05 335
</div>
04ab3520 sago007 2018-05-27 13:05 336
</div>
04ab3520 sago007 2018-05-27 13:05 337
</div><!-- contents -->
04ab3520 sago007 2018-05-27 13:05 338
<!-- start footer part -->
04ab3520 sago007 2018-05-27 13:05 339
<hr class="footer"/><address class="footer"><small>
71963b54 sago007 2018-05-27 13:18 340
Generated on Sun May 27 2018 15:17:32 for Platform folders by &#160;<a href="http://www.doxygen.org/index.html">
04ab3520 sago007 2018-05-27 13:05 341
<img class="footer" src="doxygen.png" alt="doxygen"/>
04ab3520 sago007 2018-05-27 13:05 342
</a> 1.8.13
04ab3520 sago007 2018-05-27 13:05 343
</small></address>
04ab3520 sago007 2018-05-27 13:05 344
</body>
04ab3520 sago007 2018-05-27 13:05 345
</html>
1970-01-01 00:00 346