etk/namespace_etk__theme.html
2014-10-18 09:21:19 +02:00

125 lines
12 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<title>etk Library</title>
<link rel="stylesheet" href="base.css">
<link rel="stylesheet" href="menu.css">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="container">
<h1><a href="index.html">etk library</a></h1>
<h4><a href="http://github.com/heeroyui/etk/">&nbsp;&nbsp;&nbsp;[ sources ]</a></h4>
<h3>API:</h3> <div id="menu">
<ul class="niveau1">
<li class="sousmenu"><a href="namespace_etk.html">etk</a>
<ul class="niveau2">
<li><a href="namespace_etk__log.html">log</a>
</li>
<li><a href="namespace_etk__color.html">color</a>
</li>
<li><a href="namespace_etk__tool.html">tool</a>
</li>
<li><a href="namespace_etk__archive.html">archive</a>
</li>
<li><a href="namespace_etk__theme.html">theme</a>
</li>
</ul>
</li>
<li><a href="namespace_u32char.html">u32char</a>
</li>
<li><a href="namespace_utf8.html">utf8</a>
</li>
<li><a href="namespace_std.html">std</a>
</li>
</ul>
</div>
<br/><h3>Associate libraries:</h3><div id="menu">
<ul class="niveau1"><li><a href="../ewol/index.html">ewol</a></li>
</ul><ul class="niveau1"><li><a href="../ejson/index.html">ejson</a></li>
</ul><ul class="niveau1"><li><a href="../egami/index.html">egami</a></li>
</ul><ul class="niveau1"><li><a href="../ege/index.html">ege</a></li>
</ul><ul class="niveau1"><li><a href="../esvg/index.html">esvg</a></li>
</ul><ul class="niveau1"><li><a href="../exml/index.html">exml</a></li>
</ul></div>
<br/>
<br/>
<br/>
<br/>
<br/>
<br/>
</div>
</div>
<div class="container" id="content">
<h1>namespace: etk::theme</h1><hr/><h2>Description:</h2>
<br/><br/>
<h2>Synopsis:</h2>
<pre>
<span class="code-type" >void</span> <a class="code-function" href="#7063">setName</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_refName</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_folderName</span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#7066">setName</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/u32string/">std::u32string</a> & <span class="code-argument">_refName</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/u32string/">std::u32string</a> & <span class="code-argument">_folderName</span>);<br/> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <a class="code-function" href="#7069">getName</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_refName</span>);<br/> <a class="code-type" href="http://www.cplusplus.com/reference/string/u32string/">std::u32string</a> <a class="code-function" href="#7071">getName</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/u32string/">std::u32string</a> & <span class="code-argument">_refName</span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#7073">setNameDefault</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_refName</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_folderName</span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#7076">setNameDefault</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/u32string/">std::u32string</a> & <span class="code-argument">_refName</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/u32string/">std::u32string</a> & <span class="code-argument">_folderName</span>);<br/> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <a class="code-function" href="#7079">getNameDefault</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_refName</span>);<br/> <a class="code-type" href="http://www.cplusplus.com/reference/string/u32string/">std::u32string</a> <a class="code-function" href="#7081">getNameDefault</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/u32string/">std::u32string</a> & <span class="code-argument">_refName</span>);<br/> <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a>&lt;std::string&gt; <a class="code-function" href="#7083">list</a> ();<br/> <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a>&lt;std::u32string&gt; <a class="code-function" href="#7084">listU</a> ();<br/></pre>
<br/>
<h2>Detail:</h2>
<a id="7063"/><a id="7066"/><a id="7069"/><h3>setName</h3><pre>
<span class="code-type" >void</span> <span class="code-function">setName</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_refName</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_folderName</span>);<br/> <span class="code-type" >void</span> <span class="code-function">setName</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/u32string/">std::u32string</a> & <span class="code-argument">_refName</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/u32string/">std::u32string</a> & <span class="code-argument">_folderName</span>);<br/></pre>
Set the Folder of a subset of a theme ...<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_refName</span> </td><td> Theme cathegorie ex : "GUI" "SHADER" "DEFAULT" </td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_folderName</span> </td><td> The associated folder of the Theme (like "myTheme/folder/folder2/")</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="7071"/><a id="7073"/><h3>getName</h3><pre>
<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <span class="code-function">getName</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_refName</span>);<br/> <a class="code-type" href="http://www.cplusplus.com/reference/string/u32string/">std::u32string</a> <span class="code-function">getName</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/u32string/">std::u32string</a> & <span class="code-argument">_refName</span>);<br/></pre>
get the folder from a Reference theme<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_refName</span> </td><td> Theme cathegorie ex : "GUI" "SHADER" "DEFAULT" </td></tr>
<tr><td><b>Return: </b></td><td></td><td>the path of the theme</td></tr></table>
</ul>
<br/>
<hr/>
<a id="7076"/><a id="7079"/><h3>setNameDefault</h3><pre>
<span class="code-type" >void</span> <span class="code-function">setNameDefault</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_refName</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_folderName</span>);<br/> <span class="code-type" >void</span> <span class="code-function">setNameDefault</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/u32string/">std::u32string</a> & <span class="code-argument">_refName</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/u32string/">std::u32string</a> & <span class="code-argument">_folderName</span>);<br/></pre>
Set the default folder of a subset of a theme ...<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_refName</span> </td><td> Theme cathegorie ex : "GUI" "SHADER" "DEFAULT" </td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_folderName</span> </td><td> The associated default folder of the Theme (like "myTheme/color/default/")</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="7081"/><a id="7083"/><h3>getNameDefault</h3><pre>
<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <span class="code-function">getNameDefault</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_refName</span>);<br/> <a class="code-type" href="http://www.cplusplus.com/reference/string/u32string/">std::u32string</a> <span class="code-function">getNameDefault</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/u32string/">std::u32string</a> & <span class="code-argument">_refName</span>);<br/></pre>
get the default folder from a Reference theme <br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_refName</span> </td><td> Theme cathegorie ex : "GUI" "SHADER" "DEFAULT" </td></tr>
<tr><td><b>Return: </b></td><td></td><td>the path of the theme</td></tr></table>
</ul>
<br/>
<hr/>
<a id="7084"/><h3>list</h3><pre>
<a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a>&lt;std::string&gt; <span class="code-function">list</span> ();<br/> <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a>&lt;std::u32string&gt; <span class="code-function">listU</span> ();<br/></pre>
Get the list of all the theme folder availlable in the user Home/appl<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>The list of elements</td></tr></table>
</ul>
<br/>
<hr/>
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-46753803-1', 'heeroyui.github.io');
ga('send', 'pageview');
</script>
</body>
</html>