diff options
Diffstat (limited to 'doc/api-documentation/html/class_s_w_l_d.html')
| -rw-r--r-- | doc/api-documentation/html/class_s_w_l_d.html | 235 |
1 files changed, 0 insertions, 235 deletions
diff --git a/doc/api-documentation/html/class_s_w_l_d.html b/doc/api-documentation/html/class_s_w_l_d.html deleted file mode 100644 index 5dc8086..0000000 --- a/doc/api-documentation/html/class_s_w_l_d.html +++ /dev/null @@ -1,235 +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>SWLD 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>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> -<p>Inheritance diagram for SWLD:: -<p><center><img src="class_s_w_l_d.gif" usemap="#SWLD_map" border="0"></center> -<map name="SWLD_map"> -<area href="class_s_w_module.html" alt="SWModule" shape="rect" coords="0,0,73,24"> -</map> -<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">( </td> - <td class="md">const char * </td> - <td class="mdname"> <em>imodname</em> = 0, </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>imoddesc</em> = 0, </td> - </tr> - <tr> - <td></td> - <td></td> - <td class="md"> <tr> - <td></td> - <td></td> - <td class="md"><a class="el" href="class_s_w_display.html">SWDisplay</a> * </td> - <td class="mdname"> <em>idisp</em> = 0, </td> - </tr> - <tr> - <td></td> - <td></td> - <td class="md"> <tr> - <td></td> - <td></td> - <td class="md">SWTextEncoding </td> - <td class="mdname"> <em>encoding</em> = ENC_UNKNOWN, </td> - </tr> - <tr> - <td></td> - <td></td> - <td class="md"> <tr> - <td></td> - <td></td> - <td class="md">SWTextDirection </td> - <td class="mdname"> <em>dir</em> = DIRECTION_LTR, </td> - </tr> - <tr> - <td></td> - <td></td> - <td class="md"> <tr> - <td></td> - <td></td> - <td class="md">SWTextMarkup </td> - <td class="mdname"> <em>markup</em> = FMT_UNKNOWN, </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>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> -Parameters: <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 class="md" nowrap valign="top"> -virtual <a class="el" href="class_s_w_key.html">SWKey</a>* SWLD::CreateKey - </td> - <td class="md">( </td> - <td class="mdname"> </td> - <td class="md">) </td> - <td class="md"><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#a23">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>. </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"> -virtual const char* SWLD::KeyText - </td> - <td class="md">( </td> - <td class="md">const char * </td> - <td class="mdname"> <em>ikeytext</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> -Sets/gets module KeyText, getting from saved text if key is persistent. -<p> -<dl compact><dt> -Parameters: <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#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_8h-source.html">swld.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> |