html/doxygen/3.0/classsago_1_1PlatformFolders.html
browsing at commit = 4b4f1e3e4a33faac2e16861a71ef9240dc9e9da4
<!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: sago::PlatformFolders Class Reference</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">3.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="namespacesago.html">sago</a></li><li class="navelem"><a class="el" href="classsago_1_1PlatformFolders.html">PlatformFolders</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classsago_1_1PlatformFolders-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sago::PlatformFolders Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="platform__folders_8h_source.html">platform_folders.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6aca8cb29f7a2c48ca4f99438e3ed175"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classsago_1_1PlatformFolders.html#a6aca8cb29f7a2c48ca4f99438e3ed175">getDesktopFolder</a> () const</td></tr>
<tr class="separator:a6aca8cb29f7a2c48ca4f99438e3ed175"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa4c7f57a44e5cd6849c06ba6cfa5288e"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classsago_1_1PlatformFolders.html#aa4c7f57a44e5cd6849c06ba6cfa5288e">getDocumentsFolder</a> () const</td></tr>
<tr class="separator:aa4c7f57a44e5cd6849c06ba6cfa5288e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a573bcf35075a58e91012d902add73d91"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classsago_1_1PlatformFolders.html#a573bcf35075a58e91012d902add73d91">getPicturesFolder</a> () const</td></tr>
<tr class="separator:a573bcf35075a58e91012d902add73d91"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6142e940eb75c6eb0c13c5bc40401041"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classsago_1_1PlatformFolders.html#a6142e940eb75c6eb0c13c5bc40401041">getDownloadFolder1</a> () const</td></tr>
<tr class="separator:a6142e940eb75c6eb0c13c5bc40401041"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6bb0d7cc44a9f253610aba7af873b68a"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classsago_1_1PlatformFolders.html#a6bb0d7cc44a9f253610aba7af873b68a">getMusicFolder</a> () const</td></tr>
<tr class="separator:a6bb0d7cc44a9f253610aba7af873b68a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4aee4289ce9dea7a41a00f676dd2d800"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classsago_1_1PlatformFolders.html#a4aee4289ce9dea7a41a00f676dd2d800">getVideoFolder</a> () const</td></tr>
<tr class="separator:a4aee4289ce9dea7a41a00f676dd2d800"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1d62d1c68c143308f1703d1033265f6"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classsago_1_1PlatformFolders.html#ad1d62d1c68c143308f1703d1033265f6">getSaveGamesFolder1</a> () const</td></tr>
<tr class="separator:ad1d62d1c68c143308f1703d1033265f6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class contains methods for finding the system depended special folders. For Windows these folders are either by convention or given by CSIDL. For Linux XDG convention is used. The Linux version has very little error checking and assumes that the config is correct </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a6aca8cb29f7a2c48ca4f99438e3ed175"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6aca8cb29f7a2c48ca4f99438e3ed175">◆ </a></span>getDesktopFolder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::PlatformFolders::getDesktopFolder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<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>
</div>
</div>
<a id="aa4c7f57a44e5cd6849c06ba6cfa5288e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4c7f57a44e5cd6849c06ba6cfa5288e">◆ </a></span>getDocumentsFolder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::PlatformFolders::getDocumentsFolder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<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>
</div>
</div>
<a id="a6142e940eb75c6eb0c13c5bc40401041"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6142e940eb75c6eb0c13c5bc40401041">◆ </a></span>getDownloadFolder1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::PlatformFolders::getDownloadFolder1 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<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>
<dl class="section return"><dt>Returns</dt><dd>Absolute path to the folder where files are downloaded to. </dd></dl>
</div>
</div>
<a id="a6bb0d7cc44a9f253610aba7af873b68a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bb0d7cc44a9f253610aba7af873b68a">◆ </a></span>getMusicFolder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::PlatformFolders::getMusicFolder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>The folder where music is stored </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the music folder </dd></dl>
</div>
</div>
<a id="a573bcf35075a58e91012d902add73d91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a573bcf35075a58e91012d902add73d91">◆ </a></span>getPicturesFolder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::PlatformFolders::getPicturesFolder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<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>
</div>
</div>
<a id="ad1d62d1c68c143308f1703d1033265f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1d62d1c68c143308f1703d1033265f6">◆ </a></span>getSaveGamesFolder1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::PlatformFolders::getSaveGamesFolder1 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<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">PlatformFolders pf;</div><div class="line"><span class="keywordtype">string</span> saved_games_folder = pf.getSaveGamesFolder1()+<span class="stringliteral">"/My Program Name/"</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>
<dd>
Linux: XDF does not define a folder for saved games. This will just return the same as GetDataHome() </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The folder base folder for storring save games. </dd></dl>
</div>
</div>
<a id="a4aee4289ce9dea7a41a00f676dd2d800"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4aee4289ce9dea7a41a00f676dd2d800">◆ </a></span>getVideoFolder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::PlatformFolders::getVideoFolder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>The folder where video is stored </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the video folder </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="platform__folders_8h_source.html">platform_folders.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Apr 18 2018 20:58:02 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>