<!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>SWLD 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>SWLD Class Reference</h1>the basis for all types of Lexicon and Dictionary modules (hence the 'LD').
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="swld_8h-source.html">swld.h</a>></code>
<p>
Inheritance diagram for SWLD:<p><center><img src="class_s_w_l_d__inherit__graph.png" border="0" usemap="#_s_w_l_d__inherit__map" alt="Inheritance graph"></center>
<map name="_s_w_l_d__inherit__map">
<area href="class_s_w_module.html" shape="rect" coords="14,15,89,34" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for SWLD:<p><center><img src="class_s_w_l_d__coll__graph.png" border="0" usemap="#_s_w_l_d__coll__map" alt="Collaboration graph"></center>
<map name="_s_w_l_d__coll__map">
<area href="class_s_w_module.html" shape="rect" coords="193,391,267,410" alt="">
<area href="class_list_key.html" shape="rect" coords="75,294,129,313" alt="">
<area href="class_s_w_key.html" shape="rect" coords="122,197,178,215" alt="">
<area href="class_s_w_object.html" shape="rect" coords="219,106,291,125" alt="">
<area href="class_s_w_display.html" shape="rect" coords="273,197,347,215" alt="">
<area href="class_s_w_class.html" shape="rect" coords="145,15,209,34" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_s_w_l_d-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> </td><td valign=bottom><a class="el" href="class_s_w_l_d.html#a0">SWLD</a> (const char *imodname=0, const char *imoddesc=0, <a class="el" href="class_s_w_display.html">SWDisplay</a> *idisp=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *ilang=0)</td></tr>
<tr><td> </td><td><font size=-1><em>Initializes data for instance of SWLD.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWLD::~SWLD"></a>
virtual </td><td valign=bottom><b>~SWLD</b> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_s_w_key.html">SWKey</a> * </td><td valign=bottom><a class="el" href="class_s_w_l_d.html#a2">CreateKey</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Allocates a key of specific type for module The different reimplementatiosn of <a class="el" href="class_s_w_module.html">SWModule</a> (e.g.</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_l_d.html#a3">KeyText</a> (const char *ikeytext)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets/gets module KeyText, getting from saved text if key is persistent.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="n0" doxytag="SWLD::entkeytxt"></a>
char * </td><td valign=bottom><b>entkeytxt</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
the basis for all types of Lexicon and Dictionary modules (hence the 'LD').
<p>
<p>
Definition at line <a class="el" href="swld_8h-source.html#l00034">34</a> of file <a class="el" href="swld_8h-source.html">swld.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="SWLD::SWLD"></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"> SWLD::SWLD </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>imodname</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>imoddesc</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="class_s_w_display.html">SWDisplay</a> * </td>
<td class="mdname" nowrap> <em>idisp</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>SWTextEncoding </td>
<td class="mdname" nowrap> <em>encoding</em> = ENC_UNKNOWN, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>SWTextDirection </td>
<td class="mdname" nowrap> <em>dir</em> = DIRECTION_LTR, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>SWTextMarkup </td>
<td class="mdname" nowrap> <em>markup</em> = FMT_UNKNOWN, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>ilang</em> = 0</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Initializes data for instance of SWLD.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>imodname</em> </td><td>
Internal name for module </td></tr>
<tr><td valign=top><em>imoddesc</em> </td><td>
Name to display to user for module </td></tr>
<tr><td valign=top><em>idisp</em> </td><td>
Display object to use for displaying </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="swld_8cpp-source.html#l00017">17</a> of file <a class="el" href="swld_8cpp-source.html">swld.cpp</a>.
<p>
References <a class="el" href="swld_8h-source.html#l00047">CreateKey</a>(), and <a class="el" href="swmodule_8h-source.html#l00077">SWModule::key</a>.
<p>
<div class="fragment"><pre>00017 : <a class="code" href="class_s_w_module.html#a0">SWModule</a>(imodname, imoddesc, idisp, <font class="stringliteral">"Lexicons / Dictionaries"</font>, enc, dir, mark, ilang)
00018 {
00019 <font class="keyword">delete</font> <a class="code" href="class_s_w_module.html#n6">key</a>;
00020 <a class="code" href="class_s_w_module.html#n6">key</a> = <a class="code" href="class_s_w_l_d.html#a2">CreateKey</a>();
00021 entkeytxt = <font class="keyword">new</font> <font class="keywordtype">char</font> [1];
00022 *entkeytxt = 0;
00023 }
</pre></div> </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a2" doxytag="SWLD::CreateKey"></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_key.html">SWKey</a>* SWLD::CreateKey </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> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Allocates a key of specific type for module The different reimplementatiosn of <a class="el" href="class_s_w_module.html">SWModule</a> (e.g.
<p>
<a class="el" href="class_s_w_text.html">SWText</a>) support <a class="el" href="class_s_w_key.html">SWKey</a> implementations, which support special. This functions returns a <a class="el" href="class_s_w_key.html">SWKey</a> object which works with the current implementation of <a class="el" href="class_s_w_module.html">SWModule</a>. For example for the <a class="el" href="class_s_w_text.html">SWText</a> class it returns a <a class="el" href="class_verse_key.html">VerseKey</a> object. <dl compact><dt><b>
See also: </b><dd>
<a class="el" href="class_verse_key.html">VerseKey</a>, <a class="el" href="class_list_key.html">ListKey</a>, <a class="el" href="class_s_w_text.html">SWText</a>, SWLD, <a class="el" href="class_s_w_com.html">SWCom</a> </dl><dl compact><dt><b>
Returns: </b><dd>
pointer to allocated key </dl>
<p>
Reimplemented from <a class="el" href="class_s_w_module.html#a26">SWModule</a>.
<p>
Definition at line <a class="el" href="swld_8h-source.html#l00047">47</a> of file <a class="el" href="swld_8h-source.html">swld.h</a>.
<p>
Referenced by <a class="el" href="swld_8cpp-source.html#l00017">SWLD</a>().
<p>
<div class="fragment"><pre>00048 {
00049 <font class="keywordflow">return</font> <font class="keyword">new</font> <a class="code" href="class_str_key.html">StrKey</a> ();
00050 }
</pre></div> </td>
</tr>
</table>
<a name="a3" doxytag="SWLD::KeyText"></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 * SWLD::KeyText </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>ikeytext</em> </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>
Sets/gets module KeyText, getting from saved text if key is persistent.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>ikeytext</em> </td><td>
value which to set keytext; [0] - only get </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
pointer to keytext </dl>
<p>
Reimplemented from <a class="el" href="class_s_w_module.html#a12">SWModule</a>.
<p>
Definition at line <a class="el" href="swld_8cpp-source.html#l00047">47</a> of file <a class="el" href="swld_8cpp-source.html">swld.cpp</a>.
<p>
References <a class="el" href="class_s_w_module.html#a28">SWModule::getRawEntry</a>(), <a class="el" href="swmodule_8h-source.html#l00077">SWModule::key</a>, <a class="el" href="swmodule_8cpp-source.html#l00303">SWModule::KeyText</a>(), and <a class="el" href="swkey_8cpp-source.html#l00068">SWKey::Persist</a>().
<p>
<div class="fragment"><pre>00048 {
00049 <font class="keywordflow">if</font> (<a class="code" href="class_s_w_module.html#n6">key</a>-><a class="code" href="class_s_w_key.html#a4">Persist</a>() && !ikeytext) {
00050 <a class="code" href="class_s_w_module.html#a28">getRawEntry</a>(); <font class="comment">// force module key to snap to entry</font>
00051 <font class="keywordflow">return</font> entkeytxt;
00052 }
00053 <font class="keywordflow">else</font> <font class="keywordflow">return</font> <a class="code" href="class_s_w_module.html#a12">SWModule::KeyText</a>(ikeytext);
00054 }
</pre></div> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="swld_8h-source.html">swld.h</a><li><a class="el" href="swld_8cpp-source.html">swld.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>
