sword::VerseTreeKey Class Reference

Class VerseKey The SWKey implementation used for verse based modules like Bibles or commentaries. More...

Inheritance diagram for sword::VerseTreeKey:

[legend]Collaboration diagram for sword::VerseTreeKey:


Public Member Functions
	VerseTreeKey (TreeKey treeKey, const char ikey=0)
	VerseKey Constructor - initializes Instance of VerseKey.
	VerseTreeKey (TreeKey treeKey, const SWKey ikey)
	VerseKey Constructor - initializes instance of VerseKey.
	VerseTreeKey (TreeKey treeKey, const char min, const char *max)
	VerseKey Constructor - initializes instance of VerseKey with boundariess - see also LowerBound() and UpperBound().
	VerseTreeKey (const VerseTreeKey &k)
	VerseKey Copy Constructor - will create a new VerseKey based on an existing one.
virtual	~VerseTreeKey ()
	VerseKey Destructor Cleans up an instance of VerseKey.
virtual SWKey *	clone () const
	Creates a new SWKey based on the current VerseKey see also the Copy Constructor.
virtual bool	isTraversable () const
	Whether or not this key can be ++ -- incremented.
virtual TreeKey *	getTreeKey ()
SWKey &	operator= (const char *ikey)
SWKey &	operator= (const SWKey &ikey)
SWKey &	operator= (SW_POSITION pos)
	operator const char * () const
bool	operator== (const SWKey &ikey)
bool	operator!= (const SWKey &ikey)
virtual bool	operator> (const SWKey &ikey)
virtual bool	operator< (const SWKey &ikey)
virtual bool	operator>= (const SWKey &ikey)
virtual bool	operator<= (const SWKey &ikey)
SWKey &	operator-= (int steps)
SWKey &	operator+= (int steps)
SWKey &	operator++ (int)
SWKey &	operator-- (int)
virtual SWKey &	operator= (const VerseKey &ikey)
Private Attributes
TreeKey *	treeKey
Static Private Attributes
static SWClass	classdef

Detailed Description

Class VerseKey The SWKey implementation used for verse based modules like Bibles or commentaries.

Definition at line 39 of file versetreekey.h.

sword::VerseTreeKey::VerseTreeKey	(	TreeKey *	treeKey,
		const char *	ikey = `0`
	)

VerseKey Constructor - initializes Instance of VerseKey.

Parameters:

ikey

text key (will take various forms of 'BOOK CH:VS'. See parse() for more detailed information)

sword::VerseTreeKey::VerseTreeKey	(	TreeKey *	treeKey,
		const SWKey *	ikey
	)

VerseKey Constructor - initializes instance of VerseKey.

Parameters:

ikey

base key (will take various forms of 'BOOK CH:VS'. See parse() for more detailed information)

sword::VerseTreeKey::VerseTreeKey	(	TreeKey *	treeKey,
		const char *	min,
		const char *	max
	)

VerseKey Constructor - initializes instance of VerseKey with boundariess - see also LowerBound() and UpperBound().

Parameters:

	min	the lower boundary of the new VerseKey
	max	the upper boundary of the new VerseKey

sword::VerseTreeKey::VerseTreeKey ( const VerseTreeKey & k )

VerseKey Copy Constructor - will create a new VerseKey based on an existing one.

Parameters:

the VerseKey to copy from

The documentation for this class was generated from the following file:

The SWORD Project; P. O. Box 2528; Tempe, AZ 85280-2528 USA