#include <versekey.h>
Inheritance diagram for VerseKey::

Public Methods | |
| VerseKey (const char *ikey=0) | |
| VerseKey Constructor - initializes Instance of VerseKey. More... | |
| VerseKey (const SWKey *ikey) | |
| VerseKey Constructor - initializes instance of VerseKey. More... | |
| VerseKey (const char *min, const char *max) | |
| VerseKey Constructor - initializes instance of VerseKey with boundariess - see also LowerBound and UpperBound. More... | |
| VerseKey (VerseKey const &k) | |
| VerseKey Copy Constructor - will create a new VerseKey based on an existing one. More... | |
| virtual | ~VerseKey () |
| VerseKey Destructor Cleans up an instance of VerseKey. | |
| VerseKey& | LowerBound (const char *lb) |
| sets the lower boundary for this VerseKey and returns the new boundary. More... | |
| VerseKey& | UpperBound (const char *ub) |
| sets the upper boundary for this VerseKey and returns the new boundary. More... | |
| VerseKey& | LowerBound () const |
| gets the lower boundary of this VerseKey. More... | |
| VerseKey& | UpperBound () const |
| gets the upper boundary of this VerseKey. More... | |
| void | ClearBounds () |
| clears the boundaries of this VerseKey. | |
| virtual SWKey* | clone () const |
| Creates a new SWKey based on the current VerseKey see also the Copy Constructor. | |
| virtual const char* | getText () const |
| refreshes keytext before returning if cast to a (char *) is requested. | |
| virtual void | setText (const char *ikey) |
| Equates this SWKey to a character string. More... | |
| virtual void | copyFrom (const SWKey &ikey) |
| Equates this SWKey to another SWKey object. More... | |
| virtual void | copyFrom (const VerseKey &ikey) |
| Equates this VerseKey to another VerseKey. | |
| virtual void | setPosition (SW_POSITION) |
| Positions this key. More... | |
| virtual void | decrement (int step) |
| Decrements key a number of verses. More... | |
| virtual void | increment (int step) |
| Increments key a number of verses. More... | |
| virtual char | Traversable () |
| virtual char | Testament () const |
| Gets testament. More... | |
| virtual char | Book () const |
| Gets book. More... | |
| virtual int | Chapter () const |
| Gets chapter. More... | |
| virtual int | Verse () const |
| Gets verse. More... | |
| virtual char | Testament (char itestament) |
| Sets/gets testament. More... | |
| virtual char | Book (char ibook) |
| Sets/gets book. More... | |
| virtual int | Chapter (int ichapter) |
| Sets/gets chapter. More... | |
| virtual int | Verse (int iverse) |
| Sets/gets verse. More... | |
| virtual void | Normalize (char autocheck=0) |
| checks limits and normalizes if necessary (e.g. More... | |
| virtual char | AutoNormalize (char iautonorm=MAXPOS(char)) |
| Sets/gets flag that tells VerseKey to automatically normalize itself when modified. More... | |
| virtual char | Headings (char iheadings=MAXPOS(char)) |
| Sets/gets flag that tells VerseKey to include chapter/book/testament/module headings. More... | |
| virtual long | NewIndex () const |
| virtual long | Index () const |
| Gets index based upon current verse. More... | |
| virtual long | Index (long iindex) |
| Sets index based upon current verse. More... | |
| virtual ListKey | ParseVerseList (const char *buf, const char *defaultKey="Genesis 1:1", bool expandRange=false) |
| virtual int | compare (const SWKey &ikey) |
| Compares another SWKey object. More... | |
| virtual int | _compare (const VerseKey &ikey) |
| Compares another VerseKey object. More... | |
| virtual void | setBookAbbrevs (const struct abbrev *bookAbbrevs, unsigned int size=0) |
| virtual void | setBooks (const char *iBMAX, struct sbook **ibooks) |
| virtual void | setLocale (const char *name) |
| virtual SWKEY_OPERATORS SWKey& | operator= (const VerseKey &ikey) |
Public Attributes | |
| const char* | BMAX |
| struct sbook** | books |
Static Public Attributes | |
| const char | builtin_BMAX [2] |
| struct sbook* | builtin_books [2] |
| const struct abbrev | builtin_abbrevs [] |
Private Methods | |
| int | getBookAbbrev (char *abbr) |
| void | initBounds () const |
| void | initstatics () |
| initialize and allocate books array. | |
| void | init () |
| initializes this VerseKey(). | |
| void | freshtext () const |
| Refresh keytext based on testament|book|chapter|verse default auto normalization to true default display headings option is false. | |
| virtual char | parse () |
| Parse a character array into testament|book|chapter|verse. | |
| int | findindex (long *array, int size, long value) |
| Binary search to find the index closest, but less than the given value. More... | |
Private Attributes | |
| ListKey | internalListKey |
| const struct abbrev* | abbrevs |
| int | abbrevsCnt |
| char | testament |
| The Testament: 0 - Old; 1 - New. | |
| char | book |
| int | chapter |
| int | verse |
| char | autonorm |
| flag for auto normalization. | |
| char | headings |
| flag for headings on/off. | |
| VerseKey* | lowerBound |
| VerseKey * | upperBound |
Static Private Attributes | |
| SWClass | classdef |
| long* | offsets [2][2] |
| int | offsize [2][2] |
| int | instance |
| number of instantiated VerseKey objects or derivitives. | |
| struct sbook | otbooks [] |
| struct sbook | ntbooks [] |
| long | otbks [] |
| long | otcps [] |
| long | ntbks [] |
| long | ntcps [] |
| int | vm [] |
| LocaleCache | localeCache |
Definition at line 66 of file versekey.h.
|
|
VerseKey Constructor - initializes Instance of VerseKey.
|
|
|
VerseKey Constructor - initializes instance of VerseKey.
|
|
|
VerseKey Constructor - initializes instance of VerseKey with boundariess - see also LowerBound and UpperBound.
|
|
|
VerseKey Copy Constructor - will create a new VerseKey based on an existing one.
|
|
|
Sets/gets flag that tells VerseKey to automatically normalize itself when modified.
|
|
|
Sets/gets book.
|
|
|
Gets book.
|
|
|
Sets/gets chapter.
|
|
|
Gets chapter.
|
|
|
Sets/gets flag that tells VerseKey to include chapter/book/testament/module headings.
|
|
|
Sets index based upon current verse.
Reimplemented from SWKey. |
|
|
Gets index based upon current verse.
Reimplemented from SWKey. |
|
|
gets the lower boundary of this VerseKey.
|
|
|
sets the lower boundary for this VerseKey and returns the new boundary.
|
|
|
checks limits and normalizes if necessary (e.g. Matthew 29:47 = Mark 2:2). If last verse is exceeded, key is set to last Book CH:VS
|
|
|
Sets/gets testament.
|
|
|
Gets testament.
|
|
|
gets the upper boundary of this VerseKey.
|
|
|
sets the upper boundary for this VerseKey and returns the new boundary.
|
|
|
Sets/gets verse.
|
|
|
Gets verse.
|
|
|
Compares another VerseKey object.
|
|
|
Compares another SWKey object.
Reimplemented from SWKey. |
|
|
Equates this SWKey to another SWKey object.
Reimplemented from SWKey. |
|
|
Decrements key a number of verses.
Reimplemented from SWKey. |
|
|
Binary search to find the index closest, but less than the given value.
|
|
|
Increments key a number of verses.
Reimplemented from SWKey. |
|
|
Positions this key.
Reimplemented from SWKey. |
|
|
Equates this SWKey to a character string.
Reimplemented from SWKey. Definition at line 228 of file versekey.h. |
1.2.6 written by Dimitri van Heesch,
© 1997-2001