summaryrefslogtreecommitdiff
path: root/doc/api-documentation/html/class_swkey.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api-documentation/html/class_swkey.html')
-rw-r--r--doc/api-documentation/html/class_swkey.html620
1 files changed, 0 insertions, 620 deletions
diff --git a/doc/api-documentation/html/class_swkey.html b/doc/api-documentation/html/class_swkey.html
deleted file mode 100644
index f3b5359..0000000
--- a/doc/api-documentation/html/class_swkey.html
+++ /dev/null
@@ -1,620 +0,0 @@
-<!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>SWKey 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>SWKey Class Reference</h1>SWKey is the basis for all types of keys for indexing into modules (e.g.
-<a href="#_details">More...</a>
-<p>
-<code>#include &lt;<a class="el" href="swkey_h-source.html">swkey.h</a>&gt;</code>
-<p>
-<p>Inheritance diagram for SWKey::
-<p><center><img src="class_swkey.gif" usemap="#SWKey_map" border="0"></center>
-<map name="SWKey_map">
-<area href="class_swobject.html" alt="SWObject" shape="rect" coords="78,0,146,24">
-<area href="class_listkey.html" alt="ListKey" shape="rect" coords="0,112,68,136">
-<area href="class_strkey.html" alt="StrKey" shape="rect" coords="78,112,146,136">
-<area href="class_versekey.html" alt="VerseKey" shape="rect" coords="156,112,224,136">
-</map>
-<a href="class_swkey-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_swkey.html#a0">SWKey</a> (const char *ikey=0)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>initializes instance of SWKey.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_swkey.html#a1">SWKey</a> (SWKey const &amp;k)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Copy Constructor.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top><a name="a2" doxytag="SWKey::~SWKey"></a>
-virtual&nbsp;</td><td valign=bottom><a class="el" href="class_swkey.html#a2">~SWKey</a> ()</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Destructor, cleans up this instance of SWKey.</em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>virtual SWKey*&nbsp;</td><td valign=bottom><a class="el" href="class_swkey.html#a3">clone</a> () const</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Returns a copy of this SWKey object.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="class_swkey.html#a4">Persist</a> () const</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Gets whether this object itself persists within a module that it was used to SetKey or just a copy.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="class_swkey.html#a5">Persist</a> (char ikey)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Set/gets whether this object itself persists within a module that it was used to SetKey or just a copy.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>virtual char&nbsp;</td><td valign=bottom><a class="el" href="class_swkey.html#a6">Error</a> ()</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Gets and clears error status.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="class_swkey.html#a7">setText</a> (const char *ikey)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Equates this SWKey to a character string.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="class_swkey.html#a8">copyFrom</a> (const SWKey &amp;ikey)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Equates this SWKey to another SWKey object.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top><a name="a9" doxytag="SWKey::getText"></a>
-virtual const char*&nbsp;</td><td valign=bottom><a class="el" href="class_swkey.html#a9">getText</a> () const</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>returns text key if (char *) cast is requested.</em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>virtual int&nbsp;</td><td valign=bottom><a class="el" href="class_swkey.html#a10">compare</a> (const SWKey &amp;ikey)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Compares another <a class="el" href="class_versekey.html">VerseKey</a> object.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="class_swkey.html#a11">equals</a> (const SWKey &amp;ikey)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Compares another <a class="el" href="class_versekey.html">VerseKey</a> object.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top><a name="a12" doxytag="SWKey::setPosition"></a>
-virtual void&nbsp;</td><td valign=bottom><b>setPosition</b> (SW_POSITION)</td></tr>
-<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="class_swkey.html#a13">decrement</a> (int steps=1)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Decrements key a number of entries.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="class_swkey.html#a14">increment</a> (int steps=1)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Increments key a number of entries.</em> <a href="#a14">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top><a name="a15" doxytag="SWKey::Traversable"></a>
-virtual char&nbsp;</td><td valign=bottom><b>Traversable</b> ()</td></tr>
-<tr><td nowrap align=right valign=top>virtual long&nbsp;</td><td valign=bottom><a class="el" href="class_swkey.html#a16">Index</a> () const</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Use this function to get te current position withing a module.</em> <a href="#a16">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top><a name="a17" doxytag="SWKey::Index"></a>
-virtual long&nbsp;</td><td valign=bottom><b>Index</b> (long iindex)</td></tr>
-<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
-<tr><td nowrap align=right valign=top><a name="n0" doxytag="SWKey::keytext"></a>
-char*&nbsp;</td><td valign=bottom><b>keytext</b></td></tr>
-<tr><td nowrap align=right valign=top><a name="n1" doxytag="SWKey::persist"></a>
-char&nbsp;</td><td valign=bottom><b>persist</b></td></tr>
-<tr><td nowrap align=right valign=top><a name="n2" doxytag="SWKey::error"></a>
-char&nbsp;</td><td valign=bottom><b>error</b></td></tr>
-<tr><td colspan=2><br><h2>Private Methods</h2></td></tr>
-<tr><td nowrap align=right valign=top><a name="c0" doxytag="SWKey::init"></a>
-void&nbsp;</td><td valign=bottom><b>init</b> ()</td></tr>
-<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
-<tr><td nowrap align=right valign=top><a name="o0" doxytag="SWKey::index"></a>
-long&nbsp;</td><td valign=bottom><b>index</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="SWKey::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>
-SWKey is the basis for all types of keys for indexing into modules (e.g.
-<p>
-verse, word, place, etc.)
-<p>
-
-<p>
-Definition at line <a class="el" href="swkey_h-source.html#l00076">76</a> of file <a class="el" href="swkey_h-source.html">swkey.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
-<a name="a0" doxytag="SWKey::SWKey"></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>
-SWKey::SWKey (
- </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 SWKey.
-<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 </td></tr>
-</table>
-</dl> </td>
- </tr>
-</table>
-<a name="a1" doxytag="SWKey::SWKey"></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>
-SWKey::SWKey (
- </b></td>
- <td valign="bottom"><b>
-SWKey const &amp; <em>k</em>&nbsp;)
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Copy Constructor.
-<p>
-<dl compact><dt>
-<b>Parameters: </b><dd>
-<table border=0 cellspacing=2 cellpadding=0>
-<tr><td valign=top><em>The</em>
-&nbsp;</td><td>
-SWKey object to copy. </td></tr>
-</table>
-</dl> </td>
- </tr>
-</table>
-<hr><h2>Member Function Documentation</h2>
-<a name="a6" doxytag="SWKey::Error"></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>
-char SWKey::Error (
- </b></td>
- <td valign="bottom"><b>
-)<code> [virtual]</code>
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Gets and clears error status.
-<p>
-<dl compact><dt>
-<b>Returns: </b><dd>
-error status </dl> </td>
- </tr>
-</table>
-<a name="a16" doxytag="SWKey::Index"></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>
-long SWKey::Index (
- </b></td>
- <td valign="bottom"><b>
-) const<code> [inline, virtual]</code>
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Use this function to get te current position withing a module.
-<p>
-Here's a small example how to use this function and Index(long). This function uses the GerLut module and chooses a random verse from the Bible and returns it. <div class="fragment"><pre> <font class="keyword">const</font> <font class="keywordtype">char</font>* randomVerse()<font class="keyword"> </font>{
- <a class="code" href="class_versekey.html">VerseKey</a> vk;
- <a class="code" href="class_swmgr.html">SWMgr</a> mgr;
- LocaleMgr::systemLocaleMgr.<a class="code" href="class_localemgr.html#a6">setDefaultLocaleName</a>(<font class="stringliteral">"de"</font>);
-
- <a class="code" href="class_swmodule.html">SWModule</a>* module = mgr-&gt;<a class="code" href="class_swmgr.html#m2">Modules</a>(<font class="stringliteral">"GerLut"</font>);
- srand( time(0) );
- <font class="keyword">const</font> <font class="keywordtype">double</font> newIndex = (double(rand())/RAND_MAX)*(24108+8224);
- vk.<a class="code" href="class_versekey.html#a31">Index</a>(newIndex);
- module-&gt;<a class="code" href="class_swmodule.html#a5">SetKey</a>(vk);
-
- <font class="keywordtype">char</font>* text;
- sprintf(text, <font class="stringliteral">"%s: %s"</font>,(<font class="keyword">const</font> <font class="keywordtype">char</font>*)vk ,module-&gt;<a class="code" href="class_swmodule.html#a43">StripText</a>(&amp;vk));
- <font class="keywordflow">return</font> text;</pre></div>
-<p>
-Reimplemented in <a class="el" href="class_listkey.html#a17">ListKey</a>, and <a class="el" href="class_versekey.html#a31">VerseKey</a>.
-<p>
-Definition at line <a class="el" href="swkey_h-source.html#l00204">204</a> of file <a class="el" href="swkey_h-source.html">swkey.h</a>.
-<p>
-Referenced by <a class="el" href="listkey_h-source.html#l00112">ListKey::Index</a>(). </td>
- </tr>
-</table>
-<a name="a5" doxytag="SWKey::Persist"></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>
-char SWKey::Persist (
- </b></td>
- <td valign="bottom"><b>
-char <em>ikey</em>&nbsp;)
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Set/gets whether this object itself persists within a module that it was used to SetKey or just a copy.
-<p>
-(1 - persists in module; 0 - a copy is attempted<dl compact><dt>
-<b>Parameters: </b><dd>
-<table border=0 cellspacing=2 cellpadding=0>
-<tr><td valign=top><em>ipersist</em>
-&nbsp;</td><td>
-value which to set persist; [-1] - only get </td></tr>
-</table>
-</dl><dl compact><dt>
-<b>Returns: </b><dd>
-value of persist </dl> </td>
- </tr>
-</table>
-<a name="a4" doxytag="SWKey::Persist"></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>
-char SWKey::Persist (
- </b></td>
- <td valign="bottom"><b>
-) const
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Gets whether this object itself persists within a module that it was used to SetKey or just a copy.
-<p>
-(1 - persists in module; 0 - a copy is attempted
-<p>
-<dl compact><dt>
-<b>Returns: </b><dd>
-value of persist </dl> </td>
- </tr>
-</table>
-<a name="a3" doxytag="SWKey::clone"></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>
-SWKey * SWKey::clone (
- </b></td>
- <td valign="bottom"><b>
-) const<code> [virtual]</code>
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Returns a copy of this SWKey object.
-<p>
-This is useful to get a 1:1 copy of an SWKey based object. <dl compact><dt>
-<b>Returns: </b><dd>
-SWKey </dl>
-<p>
-Reimplemented in <a class="el" href="class_listkey.html#a3">ListKey</a>, and <a class="el" href="class_versekey.html#a10">VerseKey</a>. </td>
- </tr>
-</table>
-<a name="a10" doxytag="SWKey::compare"></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>
-int SWKey::compare (
- </b></td>
- <td valign="bottom"><b>
-const SWKey &amp; <em>ikey</em>&nbsp;)<code> [virtual]</code>
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Compares another <a class="el" href="class_versekey.html">VerseKey</a> object.
-<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>
-key to compare with this one </td></tr>
-</table>
-</dl><dl compact><dt>
-<b>Returns: </b><dd>
-&gt;0 if this key is greater than compare key; &lt;0 if this key is smaller than compare key; 0 if the keys are the same </dl>
-<p>
-Reimplemented in <a class="el" href="class_versekey.html#a34">VerseKey</a>.
-<p>
-Referenced by <a class="el" href="swkey_h-source.html#l00163">equals</a>(). </td>
- </tr>
-</table>
-<a name="a8" doxytag="SWKey::copyFrom"></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>
-void SWKey::copyFrom (
- </b></td>
- <td valign="bottom"><b>
-const SWKey &amp; <em>ikey</em>&nbsp;)<code> [virtual]</code>
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Equates this SWKey to another SWKey object.
-<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>
-other swkey object </td></tr>
-</table>
-</dl>
-<p>
-Reimplemented in <a class="el" href="class_listkey.html#a12">ListKey</a>, and <a class="el" href="class_versekey.html#a13">VerseKey</a>.
-<p>
-Referenced by <a class="el" href="listkey_h-source.html#l00090">ListKey::copyFrom</a>(). </td>
- </tr>
-</table>
-<a name="a13" doxytag="SWKey::decrement"></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>
-void SWKey::decrement (
- </b></td>
- <td valign="bottom"><b>
-int <em>step</em> = 1&nbsp;)<code> [virtual]</code>
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Decrements key a number of entries.
-<p>
-<dl compact><dt>
-<b>Parameters: </b><dd>
-<table border=0 cellspacing=2 cellpadding=0>
-<tr><td valign=top><em>steps</em>
-&nbsp;</td><td>
-Number of entries to jump backward </td></tr>
-</table>
-</dl><dl compact><dt>
-<b>Returns: </b><dd>
-*this </dl>
-<p>
-Reimplemented in <a class="el" href="class_listkey.html#a14">ListKey</a>, and <a class="el" href="class_versekey.html#a16">VerseKey</a>. </td>
- </tr>
-</table>
-<a name="a11" doxytag="SWKey::equals"></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>
-bool SWKey::equals (
- </b></td>
- <td valign="bottom"><b>
-const SWKey &amp; <em>ikey</em>&nbsp;)<code> [inline, virtual]</code>
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Compares another <a class="el" href="class_versekey.html">VerseKey</a> object.
-<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>
-key to compare with this one </td></tr>
-</table>
-</dl><dl compact><dt>
-<b>Returns: </b><dd>
-true if the keys are the same </dl>
-<p>
-Definition at line <a class="el" href="swkey_h-source.html#l00163">163</a> of file <a class="el" href="swkey_h-source.html">swkey.h</a>. </td>
- </tr>
-</table>
-<a name="a14" doxytag="SWKey::increment"></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>
-void SWKey::increment (
- </b></td>
- <td valign="bottom"><b>
-int <em>step</em> = 1&nbsp;)<code> [virtual]</code>
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Increments key a number of entries.
-<p>
-<dl compact><dt>
-<b>Parameters: </b><dd>
-<table border=0 cellspacing=2 cellpadding=0>
-<tr><td valign=top><em>increment</em>
-&nbsp;</td><td>
-Number of entries to jump forward </td></tr>
-</table>
-</dl><dl compact><dt>
-<b>Returns: </b><dd>
-*this </dl>
-<p>
-Reimplemented in <a class="el" href="class_listkey.html#a15">ListKey</a>, and <a class="el" href="class_versekey.html#a17">VerseKey</a>. </td>
- </tr>
-</table>
-<a name="a7" doxytag="SWKey::setText"></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>
-void SWKey::setText (
- </b></td>
- <td valign="bottom"><b>
-const char * <em>ikey</em>&nbsp;)<code> [virtual]</code>
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Equates this SWKey to a character string.
-<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>
-string to set this key to </td></tr>
-</table>
-</dl>
-<p>
-Reimplemented in <a class="el" href="class_versekey.html#a12">VerseKey</a>.
-<p>
-Referenced by <a class="el" href="versekey_h-source.html#l00228">VerseKey::setText</a>(). </td>
- </tr>
-</table>
-<hr>The documentation for this class was generated from the following file:<ul>
-<li><a class="el" href="swkey_h-source.html">swkey.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>