.TH "SWKey" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SWKey \- SWKey is the basis for all types of keys for indexing into modules (e.g. 
.SH SYNOPSIS
.br
.PP
\fC#include <swkey.h>\fR
.PP
Inherits \fBSWObject\fR.
.PP
Inherited by \fBListKey\fR, \fBStrKey\fR, and \fBVerseKey\fR.
.PP
.SS Public Methods

.in +1c
.ti -1c
.RI "\fBSWKey\fR (const char *ikey=0)"
.br
.RI "\fIinitializes instance of SWKey.\fR"
.ti -1c
.RI "\fBSWKey\fR (SWKey const &k)"
.br
.RI "\fICopy Constructor.\fR"
.ti -1c
.RI "virtual \fB~SWKey\fR ()"
.br
.RI "\fIDestructor, cleans up this instance of SWKey.\fR"
.ti -1c
.RI "virtual SWKey* \fBclone\fR () const"
.br
.RI "\fIReturns a copy of this SWKey object.\fR"
.ti -1c
.RI "char \fBPersist\fR () const"
.br
.RI "\fIGets whether this object itself persists within a module that it was used to SetKey or just a copy.\fR"
.ti -1c
.RI "char \fBPersist\fR (char ikey)"
.br
.RI "\fISet/gets whether this object itself persists within a module that it was used to SetKey or just a copy.\fR"
.ti -1c
.RI "virtual char \fBError\fR ()"
.br
.RI "\fIGets and clears error status.\fR"
.ti -1c
.RI "virtual void \fBsetText\fR (const char *ikey)"
.br
.RI "\fIEquates this SWKey to a character string.\fR"
.ti -1c
.RI "virtual void \fBcopyFrom\fR (const SWKey &ikey)"
.br
.RI "\fIEquates this SWKey to another SWKey object.\fR"
.ti -1c
.RI "virtual const char* \fBgetText\fR () const"
.br
.RI "\fIreturns text key if (char *) cast is requested.\fR"
.ti -1c
.RI "virtual int \fBcompare\fR (const SWKey &ikey)"
.br
.RI "\fICompares another \fBVerseKey\fR object.\fR"
.ti -1c
.RI "virtual bool \fBequals\fR (const SWKey &ikey)"
.br
.RI "\fICompares another \fBVerseKey\fR object.\fR"
.ti -1c
.RI "virtual void \fBsetPosition\fR (SW_POSITION)"
.br
.ti -1c
.RI "virtual void \fBdecrement\fR (int steps=1)"
.br
.RI "\fIDecrements key a number of entries.\fR"
.ti -1c
.RI "virtual void \fBincrement\fR (int steps=1)"
.br
.RI "\fIIncrements key a number of entries.\fR"
.ti -1c
.RI "virtual char \fBTraversable\fR ()"
.br
.ti -1c
.RI "virtual long \fBIndex\fR () const"
.br
.RI "\fIUse this function to get te current position withing a module.\fR"
.ti -1c
.RI "virtual long \fBIndex\fR (long iindex)"
.br
.in -1c
.SS Protected Attributes

.in +1c
.ti -1c
.RI "char* \fBkeytext\fR"
.br
.ti -1c
.RI "char \fBpersist\fR"
.br
.ti -1c
.RI "char \fBerror\fR"
.br
.in -1c
.SS Private Methods

.in +1c
.ti -1c
.RI "void \fBinit\fR ()"
.br
.in -1c
.SS Private Attributes

.in +1c
.ti -1c
.RI "long \fBindex\fR"
.br
.in -1c
.SS Static Private Attributes

.in +1c
.ti -1c
.RI "\fBSWClass\fR \fBclassdef\fR"
.br
.in -1c
.SH DETAILED DESCRIPTION
.PP 
SWKey is the basis for all types of keys for indexing into modules (e.g.
.PP
verse, word, place, etc.) 
.PP
Definition at line 76 of file swkey.h.
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP 
.SS SWKey::SWKey (const char * ikey = 0)
.PP
initializes instance of SWKey.
.PP
\fBParameters: \fR
.in +1c
.TP
\fB\fIikey\fR\fR
text key 
.SS SWKey::SWKey (SWKey const & k)
.PP
Copy Constructor.
.PP
\fBParameters: \fR
.in +1c
.TP
\fB\fIThe\fR\fR
SWKey object to copy. 
.SH MEMBER FUNCTION DOCUMENTATION
.PP 
.SS char SWKey::Error ()\fC [virtual]\fR
.PP
Gets and clears error status.
.PP
\fBReturns: \fR
.in +1c
error status 
.SS long SWKey::Index () const\fC [inline, virtual]\fR
.PP
Use this function to get te current position withing a module.
.PP
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. 
.PP
.nf
 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;
.fi
 
.PP
Reimplemented in \fBListKey\fR, and \fBVerseKey\fR.
.PP
Definition at line 204 of file swkey.h.
.PP
Referenced by ListKey::Index().
.SS char SWKey::Persist (char ikey)
.PP
Set/gets whether this object itself persists within a module that it was used to SetKey or just a copy.
.PP
(1 - persists in module; 0 - a copy is attempted
.PP
\fBParameters: \fR
.in +1c
.TP
\fB\fIipersist\fR\fR
value which to set persist; [-1] - only get 
.PP
\fBReturns: \fR
.in +1c
value of persist 
.SS char SWKey::Persist () const
.PP
Gets whether this object itself persists within a module that it was used to SetKey or just a copy.
.PP
(1 - persists in module; 0 - a copy is attempted
.PP
\fBReturns: \fR
.in +1c
value of persist 
.SS SWKey * SWKey::clone () const\fC [virtual]\fR
.PP
Returns a copy of this SWKey object.
.PP
This is useful to get a 1:1 copy of an SWKey based object. 
.PP
\fBReturns: \fR
.in +1c
SWKey 
.PP
Reimplemented in \fBListKey\fR, and \fBVerseKey\fR.
.SS int SWKey::compare (const SWKey & ikey)\fC [virtual]\fR
.PP
Compares another \fBVerseKey\fR object.
.PP
\fBParameters: \fR
.in +1c
.TP
\fB\fIikey\fR\fR
key to compare with this one 
.PP
\fBReturns: \fR
.in +1c
>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 
.PP
Reimplemented in \fBVerseKey\fR.
.PP
Referenced by equals().
.SS void SWKey::copyFrom (const SWKey & ikey)\fC [virtual]\fR
.PP
Equates this SWKey to another SWKey object.
.PP
\fBParameters: \fR
.in +1c
.TP
\fB\fIikey\fR\fR
other swkey object 
.PP
Reimplemented in \fBListKey\fR, and \fBVerseKey\fR.
.PP
Referenced by ListKey::copyFrom().
.SS void SWKey::decrement (int step = 1)\fC [virtual]\fR
.PP
Decrements key a number of entries.
.PP
\fBParameters: \fR
.in +1c
.TP
\fB\fIsteps\fR\fR
Number of entries to jump backward 
.PP
\fBReturns: \fR
.in +1c
*this 
.PP
Reimplemented in \fBListKey\fR, and \fBVerseKey\fR.
.SS bool SWKey::equals (const SWKey & ikey)\fC [inline, virtual]\fR
.PP
Compares another \fBVerseKey\fR object.
.PP
\fBParameters: \fR
.in +1c
.TP
\fB\fIikey\fR\fR
key to compare with this one 
.PP
\fBReturns: \fR
.in +1c
true if the keys are the same 
.PP
Definition at line 163 of file swkey.h.
.SS void SWKey::increment (int step = 1)\fC [virtual]\fR
.PP
Increments key a number of entries.
.PP
\fBParameters: \fR
.in +1c
.TP
\fB\fIincrement\fR\fR
Number of entries to jump forward 
.PP
\fBReturns: \fR
.in +1c
*this 
.PP
Reimplemented in \fBListKey\fR, and \fBVerseKey\fR.
.SS void SWKey::setText (const char * ikey)\fC [virtual]\fR
.PP
Equates this SWKey to a character string.
.PP
\fBParameters: \fR
.in +1c
.TP
\fB\fIikey\fR\fR
string to set this key to 
.PP
Reimplemented in \fBVerseKey\fR.
.PP
Referenced by VerseKey::setText().

.SH AUTHOR
.PP 
Generated automatically by Doxygen for The Sword Project from the source code.