etranslate/namespaceetranslate.html
2016-10-23 22:05:17 +02:00

449 lines
22 KiB
HTML

<!-- HTML header for doxygen 1.8.8-->
<!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="X-UA-Compatible" content="IE=edge">
<!-- For Mobile Devices -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<title>E-translate: Ewol runtime translate tool: etranslate Namespace Reference</title>
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
<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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
<script type="text/javascript" src="doxy-boot.js"></script>
</head>
<body>
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand">E-translate: Ewol runtime translate tool 0.1.0</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="index.html">Main&nbsp;Page</a></li>
<li><a href="pages.html">Related&nbsp;Pages</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="annotated.html">Classes</a></li>
<li><a href="files.html">Files</a></li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
Link-libs<span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="http://HeeroYui.github.io/lutin">lutin</a></li>
<li><a href="http://atria-soft.github.io/ewol">ewol</a></li>
<li><a href="http://atria-soft.github.io/etk">etk</a></li>
<li><a href="http://atria-soft.github.io/ejson">ejson</a></li>
<li><a href="http://atria-soft.github.io/exml">exml</a></li>
<li><a href="http://atria-soft.github.io/esvg">esvg</a></li>
<li><a href="http://atria-soft.github.io/egami">egami</a></li>
<li><a href="http://atria-soft.github.io/gale">gale</a></li>
<li><a href="http://atria-soft.github.io/ege">ege</a></li>
<li><a href="http://atria-soft.github.io/elog">elog</a></li>
<li><a href="http://atria-soft.github.io/ememory">ememory</a></li>
<li><a href="http://atria-soft.github.io/enet">enet</a></li>
<li><a href="http://atria-soft.github.io/eproperty">eproperty</a></li>
<li><a href="http://atria-soft.github.io/esignal">esignal</a></li>
<li><a href="http://atria-soft.github.io/zeus">zeus</a></li>
<li><a href="http://atria-soft.github.io/audio-ess">audio-ess</a></li>
<li><a href="http://musicdsp.github.io/audio">audio</a></li>
<li><a href="http://musicdsp.github.io/audio-drain">audio-drain</a></li>
<li><a href="http://musicdsp.github.io/audio-orchestra">audio-orchestra</a></li>
<li><a href="http://musicdsp.github.io/audio-river">audio-river</a></li>
</ul>
</li>
</ul>
<div id="search-box" class="input-group">
<div class="input-group-btn">
<button aria-expanded="false" type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
<span class="glyphicon glyphicon-search"></span>
<span class="caret"></span>
</button>
<ul class="dropdown-menu">
<li><a href="#">All</a></li>
<li><a href="#">Classes</a></li>
<li><a href="#">Namespaces</a></li>
<li><a href="#">Files</a></li>
<li><a href="#">Functions</a></li>
<li><a href="#">Variables</a></li>
<li><a href="#">Typedefs</a></li>
<li><a href="#">Enumerations</a></li>
<li><a href="#">Enumerator</a></li>
<li><a href="#">Friends</a></li>
<li><a href="#">Macros</a></li>
<li><a href="#">Pages</a></li>
</ul>
</div>
<button id="search-close" type="button" class="close" aria-label="Close">
<span aria-hidden="true"></span>
</button>
<input id="search-field" class="form-control" accesskey="S" onkeydown="searchBox.OnSearchFieldChange(event);" placeholder="Search ..." type="text">
</div>
</div><!--/.nav-collapse -->
</div>
</nav>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="content" id="content">
<div class="container">
<div class="row">
<div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;">
<div style="margin-bottom: 15px;">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="namespaces.html"><span>Namespace&#160;List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace&#160;Members</span></a></li>
</ul>
</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">etranslate Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8096a4417b107f71616b38ef23725d38"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceetranslate.html#a8096a4417b107f71616b38ef23725d38">init</a> (int _argc, const char **_argv)</td></tr>
<tr class="separator:a8096a4417b107f71616b38ef23725d38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a8beb01c56feb672bb2776ee3c817b6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceetranslate.html#a3a8beb01c56feb672bb2776ee3c817b6">unInit</a> ()</td></tr>
<tr class="separator:a3a8beb01c56feb672bb2776ee3c817b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b56cc5ff3cd6277903b4a8d2d65a377"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceetranslate.html#a2b56cc5ff3cd6277903b4a8d2d65a377">addPath</a> (const std::string &amp;_lib, const std::string &amp;_path, bool _major=false)</td></tr>
<tr class="separator:a2b56cc5ff3cd6277903b4a8d2d65a377"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c5659c896b63ba9739456a57c1b8771"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceetranslate.html#a5c5659c896b63ba9739456a57c1b8771">getPaths</a> (const std::string &amp;_lib)</td></tr>
<tr class="separator:a5c5659c896b63ba9739456a57c1b8771"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3aa5d35110ae8f4bca1a667c5ba7a26"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceetranslate.html#ac3aa5d35110ae8f4bca1a667c5ba7a26">setLanguageDefault</a> (const std::string &amp;_lang)</td></tr>
<tr class="separator:ac3aa5d35110ae8f4bca1a667c5ba7a26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeca8fb90d7be643b5833f80f372e1ad6"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceetranslate.html#aeca8fb90d7be643b5833f80f372e1ad6">getLanguageDefault</a> ()</td></tr>
<tr class="separator:aeca8fb90d7be643b5833f80f372e1ad6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb72bd53973066c709f2effd4f61a259"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceetranslate.html#abb72bd53973066c709f2effd4f61a259">setLanguage</a> (const std::string &amp;_lang)</td></tr>
<tr class="separator:abb72bd53973066c709f2effd4f61a259"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a334a07a95757f466662c525548e0fe51"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceetranslate.html#a334a07a95757f466662c525548e0fe51">getLanguage</a> ()</td></tr>
<tr class="separator:a334a07a95757f466662c525548e0fe51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa72812299022f1f4e44fe4ff2135eeca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceetranslate.html#aa72812299022f1f4e44fe4ff2135eeca">autoDetectLanguage</a> ()</td></tr>
<tr class="separator:aa72812299022f1f4e44fe4ff2135eeca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1561f19816b7f65758e0b7e668b163d"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceetranslate.html#ac1561f19816b7f65758e0b7e668b163d">get</a> (const std::string &amp;_instance)</td></tr>
<tr class="separator:ac1561f19816b7f65758e0b7e668b163d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This is a simple interface to converte application display string in a generic current system language. </p>
<dl class="section note"><dt>Note</dt><dd>: The current name of language reprenent the file name, then if you want to get the machine language in an other than generic passed, juste add it. Generic langage char: (all translation might be done in UTF-8 this simplify interface) English : "EN" French : "FR" German : "DE" Spanish : "SP" Japanese : "JA" Italian : "IT" Korean : "KO" Russian : "RU" Portuguese, Brazilian : "PT" Chinese : "ZH" </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a2b56cc5ff3cd6277903b4a8d2d65a377"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void etranslate::addPath </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_lib</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>_major</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the path folder of the translation files. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_lib</td><td>Library name that the path depend </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">_path</td><td>ETK generic path (DATA:... or /xxx) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">_major</td><td>This path is the major path (The last loaded, the one which overload all) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa72812299022f1f4e44fe4ff2135eeca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void etranslate::autoDetectLanguage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Automatic detection of the system language. </p>
</div>
</div>
<a class="anchor" id="ac1561f19816b7f65758e0b7e668b163d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string etranslate::get </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_instance</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Translate a specific text (if not find, it will be retured the same text). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_instance</td><td>Text to translate. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The tranlated text. </dd></dl>
</div>
</div>
<a class="anchor" id="a334a07a95757f466662c525548e0fe51"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string&amp; etranslate::getLanguage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current language loaded. </p>
<dl class="section return"><dt>Returns</dt><dd>The 2/3 char defining the language </dd></dl>
</div>
</div>
<a class="anchor" id="aeca8fb90d7be643b5833f80f372e1ad6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string&amp; etranslate::getLanguageDefault </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current language selected. </p>
<dl class="section return"><dt>Returns</dt><dd>The 2/3 char defining the language </dd></dl>
</div>
</div>
<a class="anchor" id="a5c5659c896b63ba9739456a57c1b8771"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string&amp; etranslate::getPaths </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_lib</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current paths of the library. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_lib</td><td>Library name that the path depend </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Path name. </dd></dl>
</div>
</div>
<a class="anchor" id="a8096a4417b107f71616b38ef23725d38"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void etranslate::init </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>_argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char **&#160;</td>
<td class="paramname"><em>_argv</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize etranslate. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_argc</td><td>Number of argument list </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">_argv</td><td>List of arguments </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abb72bd53973066c709f2effd4f61a259"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void etranslate::setLanguage </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_lang</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the language to load data. when no data availlable, we get the default language. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_lang</td><td>Language to load : ("EN" for english, "FR" for french, "DE" for German, "SP" for spanish ...) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac3aa5d35110ae8f4bca1a667c5ba7a26"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void etranslate::setLanguageDefault </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_lang</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the default language to load data (the default language might contain all internal data for the basic application) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_lang</td><td>Language to load : ("EN" for english, "FR" for french, "DE" for German, "SP" for spanish ...) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3a8beb01c56feb672bb2776ee3c817b6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void etranslate::unInit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Un-Initialize etranslate. </p>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Sun Oct 23 2016 22:01:44 for E-translate: Ewol runtime translate tool by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>