1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<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 bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.6 -->
<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>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_h-source.html">swld.h</a>></code>
<p>
<p>Inheritance diagram for SWLD::
<p><center><img src="class_swld.gif" usemap="#SWLD_map" border="0"></center>
<map name="SWLD_map">
<area href="class_swmodule.html" alt="SWModule" shape="rect" coords="0,0,73,24">
</map>
<a href="class_swld-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_swld.html#a0">SWLD</a> (const char *imodname=0, const char *imoddesc=0, <a class="el" href="class_swdisplay.html">SWDisplay</a> *idisp=0, bool unicode=false)</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_swkey.html">SWKey</a>* </td><td valign=bottom><a class="el" href="class_swld.html#a2">CreateKey</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Allocates a key of specific type for module.</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_swld.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_h-source.html#l00034">34</a> of file <a class="el" href="swld_h-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 nowrap valign="top"><b>
SWLD::SWLD (
</b></td>
<td valign="bottom"><b>
const char * <em>imodname</em> = 0,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const char * <em>imoddesc</em> = 0,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="class_swdisplay.html">SWDisplay</a> * <em>idisp</em> = 0,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>unicode</em> = false )
</b></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> </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 nowrap valign="top"><b>
<a class="el" href="class_swkey.html">SWKey</a> * SWLD::CreateKey (
</b></td>
<td valign="bottom"><b>
)<code> [inline, virtual]</code>
</b></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.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
pointer to allocated key </dl>
<p>
Reimplemented from <a class="el" href="class_swmodule.html#a19">SWModule</a>.
<p>
Definition at line <a class="el" href="swld_h-source.html#l00047">47</a> of file <a class="el" href="swld_h-source.html">swld.h</a>. </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 nowrap valign="top"><b>
const char * SWLD::KeyText (
</b></td>
<td valign="bottom"><b>
const char * <em>ikeytext</em> )<code> [virtual]</code>
</b></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_swmodule.html#a9">SWModule</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="swld_h-source.html">swld.h</a></ul>
<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 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.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2001</small></address>
</body>
</html>
|