---

sword::TreeKey Class Reference

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

#include <treekey.h>

Inheritance diagram for sword::TreeKey:

[legend]Collaboration diagram for sword::TreeKey:

[legend]List of all members.

Public Member Functions
virtual const char *	getLocalName ()=0
virtual const char *	setLocalName (const char *)=0
virtual const char *	getUserData (int *size=0)=0
virtual void	setUserData (const char *userData, int size=0)=0
virtual const char *	getFullName () const=0
virtual void	root ()=0
virtual bool	parent ()=0
virtual bool	firstChild ()=0
virtual bool	nextSibling ()=0
virtual bool	previousSibling ()=0
virtual bool	hasChildren ()=0
virtual void	append ()=0
virtual void	appendChild ()=0
virtual void	insertBefore ()=0
virtual void	remove ()=0
virtual void	setOffset (unsigned long offset)=0
virtual unsigned long	getOffset () const=0
virtual void	setText (const char *ikey)=0
	Equates this SWKey to a character string.
virtual void	setPosition (SW_POSITION p)=0
virtual const char *	getText () const=0
	returns text key if (char *) cast is requested
virtual int	compare (const SWKey &ikey)=0
	Compares another VerseKey object.
virtual void	decrement (int steps=1)=0
	Decrements key a number of entries.
virtual void	increment (int steps=1)=0
	Increments key a number of entries.
virtual char	Traversable ()
virtual long	Index () const
	Use this function to get te current position withing a module.
virtual long	Index (long iindex)
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)
Private Member Functions
void	init ()
Static Private Attributes
SWClass	classdef

---

Detailed Description

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

---

Member Function Documentation

virtual int sword::TreeKey::compare (  const SWKey &    ikey )  [pure virtual]

Compares another VerseKey object. Parameters: ikey  key to compare with this one Returns: >0 if this key is greater than compare key; <0 if this key is smaller than compare key; 0 if the keys are the same Reimplemented from sword::SWKey. Implemented in sword::TreeKeyIdx.

virtual void sword::TreeKey::decrement (  int    steps = 1 )  [pure virtual]

Decrements key a number of entries. Parameters: steps  Number of entries to jump backward Returns: *this Reimplemented from sword::SWKey. Implemented in sword::TreeKeyIdx.

virtual void sword::TreeKey::increment (  int    steps = 1 )  [pure virtual]

Increments key a number of entries. Parameters: steps  Number of entries to jump forward Returns: *this Reimplemented from sword::SWKey. Implemented in sword::TreeKeyIdx.

virtual long sword::TreeKey::Index (    )  const [inline, virtual]

Use this function to get te current position withing a module. 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. const char* randomVerse() { VerseKey vk; SWMgr mgr; LocaleMgr::systemLocaleMgr.setDefaultLocaleName("de"); SWModule* module = mgr->Modules("GerLut"); srand( time(0) ); const double newIndex = (double(rand())/RAND_MAX)*(24108+8224); vk.Index(newIndex); module->setKey(vk); char* text; sprintf(text, "%s: %s",(const char*)vk ,module->StripText(&vk)); return text; Reimplemented from sword::SWKey.

virtual void sword::TreeKey::setText (  const char *    ikey )  [pure virtual]

Equates this SWKey to a character string. Parameters: ikey  string to set this key to Reimplemented from sword::SWKey. Implemented in sword::TreeKeyIdx.

---

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

• treekey.h
• treekey.cpp

---