<!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>SWLocale class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.15 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</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>SWLocale Class Reference</h1>SWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="swlocale_8h-source.html">swlocale.h</a>></code>
<p>
Collaboration diagram for SWLocale:<p><center><img src="class_s_w_locale__coll__graph.png" border="0" usemap="#_s_w_locale__coll__map" alt="Collaboration graph"></center>
<map name="_s_w_locale__coll__map">
<area href="class_s_w_config.html" shape="rect" coords="15,15,85,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_s_w_locale-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="SWLocale::SWLocale"></a>
</td><td valign=bottom><b>SWLocale</b> (const char *ifilename)</td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWLocale::~SWLocale"></a>
virtual </td><td valign=bottom><b>~SWLocale</b> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_s_w_locale.html#a2">getName</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>This function is used to get the name of the languages which this object is handling.</em> <a href="#a2">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_s_w_locale.html#a3">getDescription</a> ()</td></tr>
<tr><td nowrap align=right valign=top><a name="a4" doxytag="SWLocale::translate"></a>
virtual const char * </td><td valign=bottom><b>translate</b> (const char *text)</td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="SWLocale::operator+="></a>
virtual SWLocale & </td><td valign=bottom><b>operator+=</b> (SWLocale &addFrom)</td></tr>
<tr><td nowrap align=right valign=top><a name="a6" doxytag="SWLocale::getBookAbbrevs"></a>
virtual const struct abbrev * </td><td valign=bottom><b>getBookAbbrevs</b> ()</td></tr>
<tr><td nowrap align=right valign=top><a name="a7" doxytag="SWLocale::getBooks"></a>
virtual void </td><td valign=bottom><b>getBooks</b> (char **iBMAX, struct sbook ***ibooks)</td></tr>
<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="o0" doxytag="SWLocale::lookupTable"></a>
LookupMap </td><td valign=bottom><b>lookupTable</b></td></tr>
<tr><td nowrap align=right valign=top><a name="o1" doxytag="SWLocale::localeSource"></a>
<a class="el" href="class_s_w_config.html">SWConfig</a> * </td><td valign=bottom><b>localeSource</b></td></tr>
<tr><td nowrap align=right valign=top><a name="o2" doxytag="SWLocale::name"></a>
char * </td><td valign=bottom><b>name</b></td></tr>
<tr><td nowrap align=right valign=top><a name="o3" doxytag="SWLocale::description"></a>
char * </td><td valign=bottom><b>description</b></td></tr>
<tr><td nowrap align=right valign=top><a name="o4" doxytag="SWLocale::bookAbbrevs"></a>
abbrev * </td><td valign=bottom><b>bookAbbrevs</b></td></tr>
<tr><td nowrap align=right valign=top><a name="o5" doxytag="SWLocale::BMAX"></a>
char * </td><td valign=bottom><b>BMAX</b></td></tr>
<tr><td nowrap align=right valign=top><a name="o6" doxytag="SWLocale::books"></a>
sbook ** </td><td valign=bottom><b>books</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
SWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language.
<p>
Every language supported by Sword has one SWLocale object, get the name of the Language using <dl compact><dt><b>
See also: </b><dd>
getname of this class. Another functions useful for frontend developers is , <a class="el" href="class_s_w_locale.html#a3">getDescription</a>. </dl>
<p>
<p>
Definition at line <a class="el" href="swlocale_8h-source.html#l00044">44</a> of file <a class="el" href="swlocale_8h-source.html">swlocale.h</a>.<hr><h2>Member Function Documentation</h2>
<a name="a3" doxytag="SWLocale::getDescription"></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"> const char * SWLocale::getDescription </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>
Returns: </b><dd>
The description. A possible example is "German". </dl>
<p>
Definition at line <a class="el" href="swlocale_8cpp-source.html#l00091">91</a> of file <a class="el" href="swlocale_8cpp-source.html">swlocale.cpp</a>.
<p>
<div class="fragment"><pre>00091 {
00092 <font class="keywordflow">return</font> description;
00093 }
</pre></div> </td>
</tr>
</table>
<a name="a2" doxytag="SWLocale::getName"></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"> const char * SWLocale::getName </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
This function is used to get the name of the languages which this object is handling.
<p>
<dl compact><dt><b>
Returns: </b><dd>
The name of the managed language. A possible example is "de". </dl>
<p>
Definition at line <a class="el" href="swlocale_8cpp-source.html#l00086">86</a> of file <a class="el" href="swlocale_8cpp-source.html">swlocale.cpp</a>.
<p>
Referenced by <a class="el" href="localemgr_8cpp-source.html#l00103">LocaleMgr::loadConfigDir</a>().
<p>
<div class="fragment"><pre>00086 {
00087 <font class="keywordflow">return</font> name;
00088 }
</pre></div> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="swlocale_8h-source.html">swlocale.h</a><li><a class="el" href="swlocale_8cpp-source.html">swlocale.cpp</a></ul>
<hr><address align="right"><small>Generated on Thu Jun 20 22:13:03 2002 for The Sword Project by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.15 </small></address>
</body>
</html>
