summaryrefslogtreecommitdiff
path: root/doc/api-documentation/html/class_strkey.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api-documentation/html/class_strkey.html')
-rw-r--r--doc/api-documentation/html/class_strkey.html89
1 files changed, 89 insertions, 0 deletions
diff --git a/doc/api-documentation/html/class_strkey.html b/doc/api-documentation/html/class_strkey.html
new file mode 100644
index 0000000..0e3f154
--- /dev/null
+++ b/doc/api-documentation/html/class_strkey.html
@@ -0,0 +1,89 @@
+<!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>StrKey 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> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </center>
+<hr><h1>StrKey Class Reference</h1>a standard string key class (used for modules that index on single strings (eg.
+<a href="#_details">More...</a>
+<p>
+<code>#include &lt;<a class="el" href="strkey_h-source.html">strkey.h</a>&gt;</code>
+<p>
+<p>Inheritance diagram for StrKey::
+<p><center><img src="class_strkey.gif" usemap="#StrKey_map" border="0"></center>
+<map name="StrKey_map">
+<area href="class_swkey.html" alt="SWKey" shape="rect" coords="0,56,68,80">
+<area href="class_swobject.html" alt="SWObject" shape="rect" coords="0,0,68,24">
+</map>
+<a href="class_strkey-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>&nbsp;</td><td valign=bottom><a class="el" href="class_strkey.html#a0">StrKey</a> (const char *ikey=0)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>initializes instance of StrKey.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top><a name="a1" doxytag="StrKey::~StrKey"></a>
+virtual&nbsp;</td><td valign=bottom><a class="el" href="class_strkey.html#a1">~StrKey</a> ()</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>cleans up instance of StrKey.</em></font><br><br></td></tr>
+<tr><td colspan=2><br><h2>Private Methods</h2></td></tr>
+<tr><td nowrap align=right valign=top><a name="c0" doxytag="StrKey::init"></a>
+void&nbsp;</td><td valign=bottom><b>init</b> ()</td></tr>
+<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr>
+<tr><td nowrap align=right valign=top><a name="r0" doxytag="StrKey::classdef"></a>
+<a class="el" href="class_swclass.html">SWClass</a>&nbsp;</td><td valign=bottom><b>classdef</b></td></tr>
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+a standard string key class (used for modules that index on single strings (eg.
+<p>
+cities, names, words, etc.)
+<p>
+
+<p>
+Definition at line <a class="el" href="strkey_h-source.html#l00035">35</a> of file <a class="el" href="strkey_h-source.html">strkey.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a name="a0" doxytag="StrKey::StrKey"></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>
+StrKey::StrKey (
+ </b></td>
+ <td valign="bottom"><b>
+const char * <em>ikey</em> = 0&nbsp;)
+ </b></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+initializes instance of StrKey.
+<p>
+<dl compact><dt>
+<b>Parameters: </b><dd>
+<table border=0 cellspacing=2 cellpadding=0>
+<tr><td valign=top><em>ikey</em>
+&nbsp;</td><td>
+text key (word, city, name, etc.) </td></tr>
+</table>
+</dl> </td>
+ </tr>
+</table>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li><a class="el" href="strkey_h-source.html">strkey.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>,
+ &copy;&nbsp;1997-2001</small></address>
+</body>
+</html>