diff options
Diffstat (limited to 'doc/api-documentation/html/class_verse_key.html')
| -rw-r--r-- | doc/api-documentation/html/class_verse_key.html | 1411 |
1 files changed, 0 insertions, 1411 deletions
diff --git a/doc/api-documentation/html/class_verse_key.html b/doc/api-documentation/html/class_verse_key.html deleted file mode 100644 index dbca3bf..0000000 --- a/doc/api-documentation/html/class_verse_key.html +++ /dev/null @@ -1,1411 +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>VerseKey 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>VerseKey Class Reference</h1>Class VerseKey The <a class="el" href="class_s_w_key.html">SWKey</a> implementation used for verse based modules like Bibles or commentaries. -<a href="#_details">More...</a> -<p> -<code>#include <<a class="el" href="versekey_8h-source.html">versekey.h</a>></code> -<p> -<p>Inheritance diagram for VerseKey:: -<p><center><img src="class_verse_key.gif" usemap="#VerseKey_map" border="0"></center> -<map name="VerseKey_map"> -<area href="class_s_w_key.html" alt="SWKey" shape="rect" coords="0,56,68,80"> -<area href="class_s_w_object.html" alt="SWObject" shape="rect" coords="0,0,68,24"> -</map> -<a href="class_verse_key-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_verse_key.html#a0">VerseKey</a> (const char *ikey=0)</td></tr> -<tr><td> </td><td><font size=-1><em>VerseKey Constructor - initializes Instance of VerseKey.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_verse_key.html#a1">VerseKey</a> (const <a class="el" href="class_s_w_key.html">SWKey</a> *ikey)</td></tr> -<tr><td> </td><td><font size=-1><em>VerseKey Constructor - initializes instance of VerseKey.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_verse_key.html#a2">VerseKey</a> (const char *min, const char *max)</td></tr> -<tr><td> </td><td><font size=-1><em>VerseKey Constructor - initializes instance of VerseKey with boundariess - see also <a class="el" href="class_verse_key.html#a5">LowerBound</a> and <a class="el" href="class_verse_key.html#a6">UpperBound</a>.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_verse_key.html#a3">VerseKey</a> (VerseKey const &k)</td></tr> -<tr><td> </td><td><font size=-1><em>VerseKey Copy Constructor - will create a new VerseKey based on an existing one.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a4" doxytag="VerseKey::~VerseKey"></a> -virtual </td><td valign=bottom><a class="el" href="class_verse_key.html#a4">~VerseKey</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>VerseKey Destructor Cleans up an instance of VerseKey.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>VerseKey & </td><td valign=bottom><a class="el" href="class_verse_key.html#a5">LowerBound</a> (const char *lb)</td></tr> -<tr><td> </td><td><font size=-1><em>sets the lower boundary for this VerseKey and returns the new boundary.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>VerseKey & </td><td valign=bottom><a class="el" href="class_verse_key.html#a6">UpperBound</a> (const char *ub)</td></tr> -<tr><td> </td><td><font size=-1><em>sets the upper boundary for this VerseKey and returns the new boundary.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>VerseKey & </td><td valign=bottom><a class="el" href="class_verse_key.html#a7">LowerBound</a> () const</td></tr> -<tr><td> </td><td><font size=-1><em>gets the lower boundary of this VerseKey.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>VerseKey & </td><td valign=bottom><a class="el" href="class_verse_key.html#a8">UpperBound</a> () const</td></tr> -<tr><td> </td><td><font size=-1><em>gets the upper boundary of this VerseKey.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a9" doxytag="VerseKey::ClearBounds"></a> -void </td><td valign=bottom><a class="el" href="class_verse_key.html#a9">ClearBounds</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>clears the boundaries of this VerseKey.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a10" doxytag="VerseKey::clone"></a> -virtual <a class="el" href="class_s_w_key.html">SWKey</a> * </td><td valign=bottom><a class="el" href="class_verse_key.html#a10">clone</a> () const</td></tr> -<tr><td> </td><td><font size=-1><em>Creates a new <a class="el" href="class_s_w_key.html">SWKey</a> based on the current VerseKey see also the Copy Constructor.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a11" doxytag="VerseKey::getText"></a> -virtual const char * </td><td valign=bottom><a class="el" href="class_verse_key.html#a11">getText</a> () const</td></tr> -<tr><td> </td><td><font size=-1><em>refreshes keytext before returning if cast to a (char *) is requested.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_verse_key.html#a12">setText</a> (const char *ikey)</td></tr> -<tr><td> </td><td><font size=-1><em>Equates this <a class="el" href="class_s_w_key.html">SWKey</a> to a character string.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_verse_key.html#a13">copyFrom</a> (const <a class="el" href="class_s_w_key.html">SWKey</a> &ikey)</td></tr> -<tr><td> </td><td><font size=-1><em>Equates this <a class="el" href="class_s_w_key.html">SWKey</a> to another <a class="el" href="class_s_w_key.html">SWKey</a> object.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a14" doxytag="VerseKey::copyFrom"></a> -virtual void </td><td valign=bottom><a class="el" href="class_verse_key.html#a14">copyFrom</a> (const VerseKey &ikey)</td></tr> -<tr><td> </td><td><font size=-1><em>Equates this VerseKey to another VerseKey.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_verse_key.html#a15">setPosition</a> (SW_POSITION)</td></tr> -<tr><td> </td><td><font size=-1><em>Positions this key.</em> <a href="#a15">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_verse_key.html#a16">decrement</a> (int step)</td></tr> -<tr><td> </td><td><font size=-1><em>Decrements key a number of verses.</em> <a href="#a16">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_verse_key.html#a17">increment</a> (int step)</td></tr> -<tr><td> </td><td><font size=-1><em>Increments key a number of verses.</em> <a href="#a17">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a18" doxytag="VerseKey::Traversable"></a> -virtual char </td><td valign=bottom><b>Traversable</b> ()</td></tr> -<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_verse_key.html#a19">Testament</a> () const</td></tr> -<tr><td> </td><td><font size=-1><em>Gets testament.</em> <a href="#a19">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_verse_key.html#a20">Book</a> () const</td></tr> -<tr><td> </td><td><font size=-1><em>Gets book.</em> <a href="#a20">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_verse_key.html#a21">Chapter</a> () const</td></tr> -<tr><td> </td><td><font size=-1><em>Gets chapter.</em> <a href="#a21">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_verse_key.html#a22">Verse</a> () const</td></tr> -<tr><td> </td><td><font size=-1><em>Gets verse.</em> <a href="#a22">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_verse_key.html#a23">Testament</a> (char itestament)</td></tr> -<tr><td> </td><td><font size=-1><em>Sets/gets testament.</em> <a href="#a23">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_verse_key.html#a24">Book</a> (char ibook)</td></tr> -<tr><td> </td><td><font size=-1><em>Sets/gets book.</em> <a href="#a24">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_verse_key.html#a25">Chapter</a> (int ichapter)</td></tr> -<tr><td> </td><td><font size=-1><em>Sets/gets chapter.</em> <a href="#a25">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_verse_key.html#a26">Verse</a> (int iverse)</td></tr> -<tr><td> </td><td><font size=-1><em>Sets/gets verse.</em> <a href="#a26">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_verse_key.html#a27">Normalize</a> (char autocheck=0)</td></tr> -<tr><td> </td><td><font size=-1><em>checks limits and normalizes if necessary (e.g.</em> <a href="#a27">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_verse_key.html#a28">AutoNormalize</a> (char iautonorm=MAXPOS(char))</td></tr> -<tr><td> </td><td><font size=-1><em>Sets/gets flag that tells VerseKey to automatically normalize itself when modified.</em> <a href="#a28">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_verse_key.html#a29">Headings</a> (char iheadings=MAXPOS(char))</td></tr> -<tr><td> </td><td><font size=-1><em>Sets/gets flag that tells VerseKey to include chapter/book/testament/module headings.</em> <a href="#a29">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a30" doxytag="VerseKey::NewIndex"></a> -virtual long </td><td valign=bottom><b>NewIndex</b> () const</td></tr> -<tr><td nowrap align=right valign=top>virtual long </td><td valign=bottom><a class="el" href="class_verse_key.html#a31">Index</a> () const</td></tr> -<tr><td> </td><td><font size=-1><em>Gets index based upon current verse.</em> <a href="#a31">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual long </td><td valign=bottom><a class="el" href="class_verse_key.html#a32">Index</a> (long iindex)</td></tr> -<tr><td> </td><td><font size=-1><em>Sets index based upon current verse.</em> <a href="#a32">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a33" doxytag="VerseKey::ParseVerseList"></a> -virtual <a class="el" href="class_list_key.html">ListKey</a> </td><td valign=bottom><b>ParseVerseList</b> (const char *buf, const char *defaultKey="Genesis 1:1", bool expandRange=false)</td></tr> -<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_verse_key.html#a34">compare</a> (const <a class="el" href="class_s_w_key.html">SWKey</a> &ikey)</td></tr> -<tr><td> </td><td><font size=-1><em>Compares another <a class="el" href="class_s_w_key.html">SWKey</a> object.</em> <a href="#a34">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_verse_key.html#a35">_compare</a> (const VerseKey &ikey)</td></tr> -<tr><td> </td><td><font size=-1><em>Compares another VerseKey object.</em> <a href="#a35">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a36" doxytag="VerseKey::setBookAbbrevs"></a> -virtual void </td><td valign=bottom><b>setBookAbbrevs</b> (const struct abbrev *bookAbbrevs, unsigned int size=0)</td></tr> -<tr><td nowrap align=right valign=top><a name="a37" doxytag="VerseKey::setBooks"></a> -virtual void </td><td valign=bottom><b>setBooks</b> (const char *iBMAX, struct sbook **ibooks)</td></tr> -<tr><td nowrap align=right valign=top><a name="a38" doxytag="VerseKey::setLocale"></a> -virtual void </td><td valign=bottom><b>setLocale</b> (const char *name)</td></tr> -<tr><td nowrap align=right valign=top><a name="a39" doxytag="VerseKey::operator="></a> -virtual SWKEY_OPERATORS <a class="el" href="class_s_w_key.html">SWKey</a> & </td><td valign=bottom><b>operator=</b> (const VerseKey &ikey)</td></tr> -<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> -<tr><td nowrap align=right valign=top><a name="m0" doxytag="VerseKey::BMAX"></a> -const char * </td><td valign=bottom><b>BMAX</b></td></tr> -<tr><td nowrap align=right valign=top><a name="m1" doxytag="VerseKey::books"></a> -sbook ** </td><td valign=bottom><b>books</b></td></tr> -<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr> -<tr><td nowrap align=right valign=top><a name="p0" doxytag="VerseKey::builtin_BMAX"></a> -const char </td><td valign=bottom><b>builtin_BMAX</b> [2]</td></tr> -<tr><td nowrap align=right valign=top><a name="p1" doxytag="VerseKey::builtin_books"></a> -sbook * </td><td valign=bottom><b>builtin_books</b> [2]</td></tr> -<tr><td nowrap align=right valign=top><a name="p2" doxytag="VerseKey::builtin_abbrevs"></a> -const struct abbrev </td><td valign=bottom><b>builtin_abbrevs</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="VerseKey::getBookAbbrev"></a> -int </td><td valign=bottom><b>getBookAbbrev</b> (const char *abbr)</td></tr> -<tr><td nowrap align=right valign=top><a name="c1" doxytag="VerseKey::initBounds"></a> -void </td><td valign=bottom><b>initBounds</b> () const</td></tr> -<tr><td nowrap align=right valign=top><a name="c2" doxytag="VerseKey::initstatics"></a> -void </td><td valign=bottom><a class="el" href="class_verse_key.html#c2">initstatics</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>initialize and allocate books array.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="c3" doxytag="VerseKey::init"></a> -void </td><td valign=bottom><a class="el" href="class_verse_key.html#c3">init</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>initializes this <a class="el" href="class_verse_key.html#a0">VerseKey</a>().</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="c4" doxytag="VerseKey::freshtext"></a> -void </td><td valign=bottom><a class="el" href="class_verse_key.html#c4">freshtext</a> () const</td></tr> -<tr><td> </td><td><font size=-1><em>Refresh keytext based on testament|book|chapter|verse default auto normalization to true default display headings option is false.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="c5" doxytag="VerseKey::parse"></a> -virtual char </td><td valign=bottom><a class="el" href="class_verse_key.html#c5">parse</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>Parse a character array into testament|book|chapter|verse.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="class_verse_key.html#c6">findindex</a> (long *array, int size, long value)</td></tr> -<tr><td> </td><td><font size=-1><em>Binary search to find the index closest, but less than the given value.</em> <a href="#c6">More...</a><em></em></font><br><br></td></tr> -<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> -<tr><td nowrap align=right valign=top><a name="o0" doxytag="VerseKey::internalListKey"></a> -<a class="el" href="class_list_key.html">ListKey</a> </td><td valign=bottom><b>internalListKey</b></td></tr> -<tr><td nowrap align=right valign=top><a name="o1" doxytag="VerseKey::abbrevs"></a> -const struct abbrev * </td><td valign=bottom><b>abbrevs</b></td></tr> -<tr><td nowrap align=right valign=top><a name="o2" doxytag="VerseKey::abbrevsCnt"></a> -int </td><td valign=bottom><b>abbrevsCnt</b></td></tr> -<tr><td nowrap align=right valign=top><a name="o3" doxytag="VerseKey::testament"></a> -char </td><td valign=bottom><a class="el" href="class_verse_key.html#o3">testament</a></td></tr> -<tr><td> </td><td><font size=-1><em>The Testament: 0 - Old; 1 - New.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="o4" doxytag="VerseKey::book"></a> -char </td><td valign=bottom><b>book</b></td></tr> -<tr><td nowrap align=right valign=top><a name="o5" doxytag="VerseKey::chapter"></a> -int </td><td valign=bottom><b>chapter</b></td></tr> -<tr><td nowrap align=right valign=top><a name="o6" doxytag="VerseKey::verse"></a> -int </td><td valign=bottom><b>verse</b></td></tr> -<tr><td nowrap align=right valign=top><a name="o7" doxytag="VerseKey::autonorm"></a> -char </td><td valign=bottom><a class="el" href="class_verse_key.html#o7">autonorm</a></td></tr> -<tr><td> </td><td><font size=-1><em>flag for auto normalization.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="o8" doxytag="VerseKey::headings"></a> -char </td><td valign=bottom><a class="el" href="class_verse_key.html#o8">headings</a></td></tr> -<tr><td> </td><td><font size=-1><em>flag for headings on/off.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="o9" doxytag="VerseKey::lowerBound"></a> -VerseKey * </td><td valign=bottom><b>lowerBound</b></td></tr> -<tr><td nowrap align=right valign=top><a name="o10" doxytag="VerseKey::upperBound"></a> -VerseKey * </td><td valign=bottom><b>upperBound</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="VerseKey::classdef"></a> -<a class="el" href="class_s_w_class.html">SWClass</a> </td><td valign=bottom><b>classdef</b></td></tr> -<tr><td nowrap align=right valign=top><a name="r1" doxytag="VerseKey::offsets"></a> -long * </td><td valign=bottom><b>offsets</b> [2][2]</td></tr> -<tr><td nowrap align=right valign=top><a name="r2" doxytag="VerseKey::offsize"></a> -int </td><td valign=bottom><b>offsize</b> [2][2]</td></tr> -<tr><td nowrap align=right valign=top><a name="r3" doxytag="VerseKey::instance"></a> -int </td><td valign=bottom><a class="el" href="class_verse_key.html#r3">instance</a></td></tr> -<tr><td> </td><td><font size=-1><em>number of instantiated VerseKey objects or derivitives.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="r4" doxytag="VerseKey::otbooks"></a> -sbook </td><td valign=bottom><b>otbooks</b> []</td></tr> -<tr><td nowrap align=right valign=top><a name="r5" doxytag="VerseKey::ntbooks"></a> -sbook </td><td valign=bottom><b>ntbooks</b> []</td></tr> -<tr><td nowrap align=right valign=top><a name="r6" doxytag="VerseKey::otbks"></a> -long </td><td valign=bottom><b>otbks</b> []</td></tr> -<tr><td nowrap align=right valign=top><a name="r7" doxytag="VerseKey::otcps"></a> -long </td><td valign=bottom><b>otcps</b> []</td></tr> -<tr><td nowrap align=right valign=top><a name="r8" doxytag="VerseKey::ntbks"></a> -long </td><td valign=bottom><b>ntbks</b> []</td></tr> -<tr><td nowrap align=right valign=top><a name="r9" doxytag="VerseKey::ntcps"></a> -long </td><td valign=bottom><b>ntcps</b> []</td></tr> -<tr><td nowrap align=right valign=top><a name="r10" doxytag="VerseKey::vm"></a> -int </td><td valign=bottom><b>vm</b> []</td></tr> -<tr><td nowrap align=right valign=top><a name="r11" doxytag="VerseKey::localeCache"></a> -LocaleCache </td><td valign=bottom><b>localeCache</b></td></tr> -</table> -<hr><a name="_details"></a><h2>Detailed Description</h2> -Class VerseKey The <a class="el" href="class_s_w_key.html">SWKey</a> implementation used for verse based modules like Bibles or commentaries. -<p> - -<p> -Definition at line <a class="el" href="versekey_8h-source.html#l00067">67</a> of file <a class="el" href="versekey_8h-source.html">versekey.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> -<a name="a0" doxytag="VerseKey::VerseKey"></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"> -VerseKey::VerseKey - </td> - <td class="md">( </td> - <td class="md">const char * </td> - <td class="mdname"> <em>ikey</em> = 0 </td> - <td class="md">) </td> - <td class="md"> </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -VerseKey Constructor - initializes Instance of VerseKey. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>ikey -</em> </td><td> -text key (will take various forms of 'BOOK CH:VS'. See <a class="el" href="class_verse_key.html#c5">parse</a> for more detailed information) </td></tr> -</table> -</dl> </td> - </tr> -</table> -<a name="a1" doxytag="VerseKey::VerseKey"></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"> -VerseKey::VerseKey - </td> - <td class="md">( </td> - <td class="md">const <a class="el" href="class_s_w_key.html">SWKey</a> * </td> - <td class="mdname"> <em>ikey</em> </td> - <td class="md">) </td> - <td class="md"> </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -VerseKey Constructor - initializes instance of VerseKey. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>ikey -</em> </td><td> -base key (will take various forms of 'BOOK CH:VS'. See <a class="el" href="class_verse_key.html#c5">parse</a> for more detailed information) </td></tr> -</table> -</dl> </td> - </tr> -</table> -<a name="a2" doxytag="VerseKey::VerseKey"></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"> -VerseKey::VerseKey - </td> - <td class="md">( </td> - <td class="md">const char * </td> - <td class="mdname"> <em>min</em>, </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>max</em> </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> -VerseKey Constructor - initializes instance of VerseKey with boundariess - see also <a class="el" href="class_verse_key.html#a5">LowerBound</a> and <a class="el" href="class_verse_key.html#a6">UpperBound</a>. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>min -</em> </td><td> -the lower boundary of the new VerseKey </td></tr> -<tr><td valign=top><em>max -</em> </td><td> -the upper boundary of the new VerseKey </td></tr> -</table> -</dl> </td> - </tr> -</table> -<a name="a3" doxytag="VerseKey::VerseKey"></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"> -VerseKey::VerseKey - </td> - <td class="md">( </td> - <td class="md">VerseKey const & </td> - <td class="mdname"> <em>k</em> </td> - <td class="md">) </td> - <td class="md"> </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -VerseKey Copy Constructor - will create a new VerseKey based on an existing one. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>k -</em> </td><td> -the VerseKey to copy from </td></tr> -</table> -</dl> </td> - </tr> -</table> -<hr><h2>Member Function Documentation</h2> -<a name="a28" doxytag="VerseKey::AutoNormalize"></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 char VerseKey::AutoNormalize - </td> - <td class="md">( </td> - <td class="md">char </td> - <td class="mdname"> <em>iautonorm</em> = MAXPOS (char) </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 flag that tells VerseKey to automatically normalize itself when modified. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>iautonorm -</em> </td><td> -value which to set autonorm [MAXPOS(char)] - only get </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -if unchanged -> value of autonorm, if changed -> previous value of autonorm </dl> </td> - </tr> -</table> -<a name="a24" doxytag="VerseKey::Book"></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 char VerseKey::Book - </td> - <td class="md">( </td> - <td class="md">char </td> - <td class="mdname"> <em>ibook</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 book. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>ibook -</em> </td><td> -value which to set book [MAXPOS(char)] - only get </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -if unchanged -> value of book, if changed -> previous value of book </dl> </td> - </tr> -</table> -<a name="a20" doxytag="VerseKey::Book"></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 char VerseKey::Book - </td> - <td class="md">( </td> - <td class="mdname"> </td> - <td class="md">) </td> - <td class="md"> const<code> [virtual]</code> </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Gets book. -<p> -<dl compact><dt> -<b>Returns: </b><dd> -value of book </dl> </td> - </tr> -</table> -<a name="a25" doxytag="VerseKey::Chapter"></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 int VerseKey::Chapter - </td> - <td class="md">( </td> - <td class="md">int </td> - <td class="mdname"> <em>ichapter</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 chapter. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>ichapter -</em> </td><td> -value which to set chapter [MAXPOS(int)] - only get </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -if unchanged -> value of chapter, if changed -> previous value of chapter </dl> </td> - </tr> -</table> -<a name="a21" doxytag="VerseKey::Chapter"></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 int VerseKey::Chapter - </td> - <td class="md">( </td> - <td class="mdname"> </td> - <td class="md">) </td> - <td class="md"> const<code> [virtual]</code> </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Gets chapter. -<p> -<dl compact><dt> -<b>Returns: </b><dd> -value of chapter </dl> </td> - </tr> -</table> -<a name="a29" doxytag="VerseKey::Headings"></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 char VerseKey::Headings - </td> - <td class="md">( </td> - <td class="md">char </td> - <td class="mdname"> <em>iheadings</em> = MAXPOS (char) </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 flag that tells VerseKey to include chapter/book/testament/module headings. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>iheadings -</em> </td><td> -value which to set headings [MAXPOS(char)] - only get </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -if unchanged -> value of headings, if changed -> previous value of headings </dl> </td> - </tr> -</table> -<a name="a32" doxytag="VerseKey::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 class="md" nowrap valign="top"> -virtual long VerseKey::Index - </td> - <td class="md">( </td> - <td class="md">long </td> - <td class="mdname"> <em>index</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 index based upon current verse. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>iindex -</em> </td><td> -value to set index to </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -offset </dl> -<p> -Reimplemented from <a class="el" href="class_s_w_key.html">SWKey</a>. </td> - </tr> -</table> -<a name="a31" doxytag="VerseKey::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 class="md" nowrap valign="top"> -virtual long VerseKey::Index - </td> - <td class="md">( </td> - <td class="mdname"> </td> - <td class="md">) </td> - <td class="md"> const<code> [virtual]</code> </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Gets index based upon current verse. -<p> -<dl compact><dt> -<b>Returns: </b><dd> -offset </dl> -<p> -Reimplemented from <a class="el" href="class_s_w_key.html#a16">SWKey</a>. </td> - </tr> -</table> -<a name="a7" doxytag="VerseKey::LowerBound"></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"> -VerseKey& VerseKey::LowerBound - </td> - <td class="md">( </td> - <td class="mdname"> </td> - <td class="md">) </td> - <td class="md"> const </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -gets the lower boundary of this VerseKey. -<p> -<dl compact><dt> -<b>Returns: </b><dd> -the lower boundary of this VerseKey </dl> </td> - </tr> -</table> -<a name="a5" doxytag="VerseKey::LowerBound"></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"> -VerseKey& VerseKey::LowerBound - </td> - <td class="md">( </td> - <td class="md">const char * </td> - <td class="mdname"> <em>lb</em> </td> - <td class="md">) </td> - <td class="md"> </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -sets the lower boundary for this VerseKey and returns the new boundary. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>lb -</em> </td><td> -the new lower boundary for this VerseKey </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -the lower boundary the key was set to </dl> </td> - </tr> -</table> -<a name="a27" doxytag="VerseKey::Normalize"></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 void VerseKey::Normalize - </td> - <td class="md">( </td> - <td class="md">char </td> - <td class="mdname"> <em>autocheck</em> = 0 </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> -checks limits and normalizes if necessary (e.g. -<p> -Matthew 29:47 = Mark 2:2). If last verse is exceeded, key is set to last Book CH:VS -<p> -<dl compact><dt> -<b>Returns: </b><dd> -*this </dl> </td> - </tr> -</table> -<a name="a23" doxytag="VerseKey::Testament"></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 char VerseKey::Testament - </td> - <td class="md">( </td> - <td class="md">char </td> - <td class="mdname"> <em>itestament</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 testament. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>itestament -</em> </td><td> -value which to set testament [MAXPOS(char)] - only get </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -if unchanged -> value of testament, if changed -> previous value of testament </dl> </td> - </tr> -</table> -<a name="a19" doxytag="VerseKey::Testament"></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 char VerseKey::Testament - </td> - <td class="md">( </td> - <td class="mdname"> </td> - <td class="md">) </td> - <td class="md"> const<code> [virtual]</code> </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Gets testament. -<p> -<dl compact><dt> -<b>Returns: </b><dd> -value of testament </dl> </td> - </tr> -</table> -<a name="a8" doxytag="VerseKey::UpperBound"></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"> -VerseKey& VerseKey::UpperBound - </td> - <td class="md">( </td> - <td class="mdname"> </td> - <td class="md">) </td> - <td class="md"> const </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -gets the upper boundary of this VerseKey. -<p> -<dl compact><dt> -<b>Returns: </b><dd> -the upper boundary of this VerseKey </dl> </td> - </tr> -</table> -<a name="a6" doxytag="VerseKey::UpperBound"></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"> -VerseKey& VerseKey::UpperBound - </td> - <td class="md">( </td> - <td class="md">const char * </td> - <td class="mdname"> <em>ub</em> </td> - <td class="md">) </td> - <td class="md"> </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -sets the upper boundary for this VerseKey and returns the new boundary. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>lb -</em> </td><td> -the new upper boundary for this VerseKey </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -the upper boundary the key was set to </dl> </td> - </tr> -</table> -<a name="a26" doxytag="VerseKey::Verse"></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 int VerseKey::Verse - </td> - <td class="md">( </td> - <td class="md">int </td> - <td class="mdname"> <em>iverse</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 verse. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>iverse -</em> </td><td> -value which to set verse [MAXPOS(int)] - only get </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -if unchanged -> value of verse, if changed -> previous value of verse </dl> </td> - </tr> -</table> -<a name="a22" doxytag="VerseKey::Verse"></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 int VerseKey::Verse - </td> - <td class="md">( </td> - <td class="mdname"> </td> - <td class="md">) </td> - <td class="md"> const<code> [virtual]</code> </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Gets verse. -<p> -<dl compact><dt> -<b>Returns: </b><dd> -value of verse </dl> </td> - </tr> -</table> -<a name="a35" doxytag="VerseKey::_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 class="md" nowrap valign="top"> -virtual int VerseKey::_compare - </td> - <td class="md">( </td> - <td class="md">const VerseKey & </td> - <td class="mdname"> <em>ikey</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> -Compares another VerseKey object. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>ikey -</em> </td><td> -key to compare with this one </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> ->0 if this VerseKey is greater than compare VerseKey, <0 if this VerseKey is smaller than compare VerseKey, 0 if the keys are the same </dl> </td> - </tr> -</table> -<a name="a34" doxytag="VerseKey::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 class="md" nowrap valign="top"> -virtual int VerseKey::compare - </td> - <td class="md">( </td> - <td class="md">const <a class="el" href="class_s_w_key.html">SWKey</a> & </td> - <td class="mdname"> <em>ikey</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> -Compares another <a class="el" href="class_s_w_key.html">SWKey</a> object. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>ikey -</em> </td><td> -key to compare with this one </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> ->0 if this VerseKey is greater than compare <a class="el" href="class_s_w_key.html">SWKey</a>, <0 if this VerseKey is smaller than compare <a class="el" href="class_s_w_key.html">SWKey</a>, 0 if the keys are the same </dl> -<p> -Reimplemented from <a class="el" href="class_s_w_key.html#a10">SWKey</a>. </td> - </tr> -</table> -<a name="a13" doxytag="VerseKey::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 class="md" nowrap valign="top"> -virtual void VerseKey::copyFrom - </td> - <td class="md">( </td> - <td class="md">const <a class="el" href="class_s_w_key.html">SWKey</a> & </td> - <td class="mdname"> <em>ikey</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> -Equates this <a class="el" href="class_s_w_key.html">SWKey</a> to another <a class="el" href="class_s_w_key.html">SWKey</a> object. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>ikey -</em> </td><td> -other swkey object </td></tr> -</table> -</dl> -<p> -Reimplemented from <a class="el" href="class_s_w_key.html#a8">SWKey</a>. </td> - </tr> -</table> -<a name="a16" doxytag="VerseKey::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 class="md" nowrap valign="top"> -virtual void VerseKey::decrement - </td> - <td class="md">( </td> - <td class="md">int </td> - <td class="mdname"> <em>step</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> -Decrements key a number of verses. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>decrement -</em> </td><td> -Number of verses to jump backward </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -*this </dl> -<p> -Reimplemented from <a class="el" href="class_s_w_key.html#a13">SWKey</a>. </td> - </tr> -</table> -<a name="c6" doxytag="VerseKey::findindex"></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"> -int VerseKey::findindex - </td> - <td class="md">( </td> - <td class="md">long * </td> - <td class="mdname"> <em>array</em>, </td> - </tr> - <tr> - <td></td> - <td></td> - <td class="md"> <tr> - <td></td> - <td></td> - <td class="md">int </td> - <td class="mdname"> <em>size</em>, </td> - </tr> - <tr> - <td></td> - <td></td> - <td class="md"> <tr> - <td></td> - <td></td> - <td class="md">long </td> - <td class="mdname"> <em>value</em> </td> - </tr> - <tr> - <td></td> - <td class="md">) </td> - <td class="md" colspan="2"><code> [private]</code> </td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Binary search to find the index closest, but less than the given value. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>array -</em> </td><td> -long * to array to search </td></tr> -<tr><td valign=top><em>size -</em> </td><td> -number of elements in the array </td></tr> -<tr><td valign=top><em>value -</em> </td><td> -value to find </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -the index into the array that is less than but closest to value </dl> </td> - </tr> -</table> -<a name="a17" doxytag="VerseKey::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 class="md" nowrap valign="top"> -virtual void VerseKey::increment - </td> - <td class="md">( </td> - <td class="md">int </td> - <td class="mdname"> <em>step</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> -Increments key a number of verses. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>increment -</em> </td><td> -Number of verses to jump forward </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -*this </dl> -<p> -Reimplemented from <a class="el" href="class_s_w_key.html#a14">SWKey</a>. </td> - </tr> -</table> -<a name="a15" doxytag="VerseKey::setPosition"></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 void VerseKey::setPosition - </td> - <td class="md">( </td> - <td class="md">SW_POSITION </td> - <td class="mdname"> </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> -Positions this key. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>p -</em> </td><td> -position </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -*this </dl> -<p> -Reimplemented from <a class="el" href="class_s_w_key.html">SWKey</a>. </td> - </tr> -</table> -<a name="a12" doxytag="VerseKey::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 class="md" nowrap valign="top"> -virtual void VerseKey::setText - </td> - <td class="md">( </td> - <td class="md">const char * </td> - <td class="mdname"> <em>ikey</em> </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> -Equates this <a class="el" href="class_s_w_key.html">SWKey</a> to a character string. -<p> -<dl compact><dt> -Parameters: <dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>ikey -</em> </td><td> -string to set this key to </td></tr> -</table> -</dl> -<p> -Reimplemented from <a class="el" href="class_s_w_key.html#a7">SWKey</a>. -<p> -Definition at line <a class="el" href="versekey_8h-source.html#l00229">229</a> of file <a class="el" href="versekey_8h-source.html">versekey.h</a>. </td> - </tr> -</table> -<hr>The documentation for this class was generated from the following file:<ul> -<li><a class="el" href="versekey_8h-source.html">versekey.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> |