diff options
Diffstat (limited to 'doc/api-documentation/html/class_locale_mgr.html')
| -rw-r--r-- | doc/api-documentation/html/class_locale_mgr.html | 302 |
1 files changed, 0 insertions, 302 deletions
diff --git a/doc/api-documentation/html/class_locale_mgr.html b/doc/api-documentation/html/class_locale_mgr.html deleted file mode 100644 index 64acb09..0000000 --- a/doc/api-documentation/html/class_locale_mgr.html +++ /dev/null @@ -1,302 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> -<title>LocaleMgr class Reference</title> -<link href="doxygen.css" rel="stylesheet" type="text/css"> -</head><body bgcolor="#ffffff"> -<!-- Generated by Doxygen 1.2.9.1 --> -<center> -<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> -<hr><h1>LocaleMgr Class Reference</h1>The LocaleMgr class handles all the different locales of Sword. -<a href="#_details">More...</a> -<p> -<code>#include <<a class="el" href="localemgr_8h-source.html">localemgr.h</a>></code> -<p> -<a href="class_locale_mgr-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> -<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> -<tr><td nowrap align=right valign=top><a name="a0" doxytag="LocaleMgr::LocaleMgr"></a> - </td><td valign=bottom><a class="el" href="class_locale_mgr.html#a0">LocaleMgr</a> (const char *iConfigPath=0)</td></tr> -<tr><td> </td><td><font size=-1><em>Default constructor of LocaleMgr You do normally not need this constructor, use <a class="el" href="class_locale_mgr.html#p0">LocaleMgr::systemLocaleMgr</a> instead.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a1" doxytag="LocaleMgr::~LocaleMgr"></a> -virtual </td><td valign=bottom><a class="el" href="class_locale_mgr.html#a1">~LocaleMgr</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>Default destructor of LocaleMgr.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_s_w_locale.html">SWLocale</a> * </td><td valign=bottom><a class="el" href="class_locale_mgr.html#a2">getLocale</a> (const char *name)</td></tr> -<tr><td> </td><td><font size=-1><em>Get the locale connected with the name "name".</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual list< string > </td><td valign=bottom><a class="el" href="class_locale_mgr.html#a3">getAvailableLocales</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>Get the list of available locales.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_locale_mgr.html#a4">translate</a> (const char *name, const char *text)</td></tr> -<tr><td> </td><td><font size=-1><em>Returns translated text.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_locale_mgr.html#a5">getDefaultLocaleName</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>Get the default locale name.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_locale_mgr.html#a6">setDefaultLocaleName</a> (const char *name)</td></tr> -<tr><td> </td><td><font size=-1><em>Set the new standard locale of Sword.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> -<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr> -<tr><td nowrap align=right valign=top>LocaleMgr </td><td valign=bottom><a class="el" href="class_locale_mgr.html#p0">systemLocaleMgr</a></td></tr> -<tr><td> </td><td><font size=-1><em>The LocaleMgr object used globally in the Sword world.</em> <a href="#p0">More...</a><em></em></font><br><br></td></tr> -<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> -<tr><td nowrap align=right valign=top><a name="b0" doxytag="LocaleMgr::loadConfigDir"></a> -virtual void </td><td valign=bottom><b>loadConfigDir</b> (const char *ipath)</td></tr> -<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> -<tr><td nowrap align=right valign=top><a name="n0" doxytag="LocaleMgr::locales"></a> -LocaleMap </td><td valign=bottom><b>locales</b></td></tr> -<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> -<tr><td nowrap align=right valign=top><a name="c0" doxytag="LocaleMgr::deleteLocales"></a> -void </td><td valign=bottom><b>deleteLocales</b> ()</td></tr> -<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> -<tr><td nowrap align=right valign=top><a name="o0" doxytag="LocaleMgr::defaultLocaleName"></a> -char * </td><td valign=bottom><b>defaultLocaleName</b></td></tr> -</table> -<hr><a name="_details"></a><h2>Detailed Description</h2> -The LocaleMgr class handles all the different locales of Sword. -<p> -It provides functions to get a list of all available locales, to get the default locale name and to get it. The other functions are not interesting for frontend programmers. -<p> -To get the default locale name use <dl compact><dt> -<b>See also: </b><dd> -<a class="el" href="class_locale_mgr.html#a5">getDefaultLocaleName</a> To set the default locale name use , <a class="el" href="class_locale_mgr.html#a6">setDefaultLocaleName</a> To get the locale for a language name use , <a class="el" href="class_locale_mgr.html#a2">getLocale</a> To get a list of availble locales use , <a class="el" href="class_locale_mgr.html#a3">getAvailableLocales</a> </dl> -<p> - -<p> -Definition at line <a class="el" href="localemgr_8h-source.html#l00049">49</a> of file <a class="el" href="localemgr_8h-source.html">localemgr.h</a>.<hr><h2>Member Function Documentation</h2> -<a name="a3" doxytag="LocaleMgr::getAvailableLocales"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> -virtual list< string > LocaleMgr::getAvailableLocales - </td> - <td class="md">( </td> - <td class="mdname"> </td> - <td class="md">) </td> - <td class="md"><code> [virtual]</code> </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Get the list of available locales. -<p> -@ret Returns a list of strings, which contains the names of the available locales. </td> - </tr> -</table> -<a name="a5" doxytag="LocaleMgr::getDefaultLocaleName"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> -virtual const char* LocaleMgr::getDefaultLocaleName - </td> - <td class="md">( </td> - <td class="mdname"> </td> - <td class="md">) </td> - <td class="md"><code> [virtual]</code> </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Get the default locale name. -<p> -To set it use <dl compact><dt> -<b>See also: </b><dd> -<a class="el" href="class_locale_mgr.html#a6">setDefaultLocaleName</a> -<p> -</dl>@ret Returns the default locale name </td> - </tr> -</table> -<a name="a2" doxytag="LocaleMgr::getLocale"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> -virtual <a class="el" href="class_s_w_locale.html">SWLocale</a>* LocaleMgr::getLocale - </td> - <td class="md">( </td> - <td class="md">const char * </td> - <td class="mdname"> <em>name</em> </td> - <td class="md">) </td> - <td class="md"><code> [virtual]</code> </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Get the locale connected with the name "name". -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>name -</em> </td><td> -The name of the locale you want to have. For example use getLocale("de") to get the locale for the German language. </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -Returns the locale object if the locale with the name given as parameter was found. If it wasn't found return NULL. </dl> </td> - </tr> -</table> -<a name="a6" doxytag="LocaleMgr::setDefaultLocaleName"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> -virtual void LocaleMgr::setDefaultLocaleName - </td> - <td class="md">( </td> - <td class="md">const char * </td> - <td class="mdname"> <em>name</em> </td> - <td class="md">) </td> - <td class="md"><code> [virtual]</code> </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Set the new standard locale of Sword. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>name -</em> </td><td> -The name of the new default locale </td></tr> -</table> -</dl> </td> - </tr> -</table> -<a name="a4" doxytag="LocaleMgr::translate"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> -virtual const char* LocaleMgr::translate - </td> - <td class="md">( </td> - <td class="md">const char * </td> - <td class="mdname"> <em>name</em>, </td> - </tr> - <tr> - <td></td> - <td></td> - <td class="md"> <tr> - <td></td> - <td></td> - <td class="md">const char * </td> - <td class="mdname"> <em>text</em> </td> - </tr> - <tr> - <td></td> - <td class="md">) </td> - <td class="md" colspan="2"><code> [virtual]</code> </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Returns translated text. -<p> -This function uses both parameters to return the translated version of the given text.<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>name -</em> </td><td> -The name of the locale Sword should use </td></tr> -</table> -</dl><dl compact><dt> -<b>an The text to translate into the language given by the first parameter.</b><dd> - </dl><dl compact><dt> -<b>Returns: </b><dd> -Returns the translated text. </dl> </td> - </tr> -</table> -<hr><h2>Member Data Documentation</h2> -<a name="p0" doxytag="LocaleMgr::systemLocaleMgr"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> -LocaleMgr LocaleMgr::systemLocaleMgr<code> [static]</code> - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -The LocaleMgr object used globally in the Sword world. -<p> -Do not create your own LocaleMgr, use this static object instead. -<p> -Definition at line <a class="el" href="localemgr_8h-source.html#l00107">107</a> of file <a class="el" href="localemgr_8h-source.html">localemgr.h</a>. </td> - </tr> -</table> -<hr>The documentation for this class was generated from the following file:<ul> -<li><a class="el" href="localemgr_8h-source.html">localemgr.h</a></ul> -<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by -<a href="http://www.doxygen.org/index.html"> -<img src="doxygen.gif" alt="doxygen" align="middle" border=0 -width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, - © 1997-2001</small></address> -</body> -</html> |