diff options
Diffstat (limited to 'doc/api-documentation/man/man3/ListKey.3')
| -rw-r--r-- | doc/api-documentation/man/man3/ListKey.3 | 277 |
1 files changed, 277 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/ListKey.3 b/doc/api-documentation/man/man3/ListKey.3 new file mode 100644 index 0000000..45237de --- /dev/null +++ b/doc/api-documentation/man/man3/ListKey.3 @@ -0,0 +1,277 @@ +.TH "ListKey" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ListKey \- ListKey is the basis for all types of keys that have lists of specified indexes (e.g. +.SH SYNOPSIS +.br +.PP +\fC#include <listkey.h>\fP +.PP +Inherits \fBSWKey\fP. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBListKey\fP (const char *ikey=0)" +.br +.RI "\fIinitializes instance of ListKey.\fP" +.ti -1c +.RI "\fBListKey\fP (ListKey const &k)" +.br +.ti -1c +.RI "virtual \fB~ListKey\fP ()" +.br +.RI "\fIcleans up instance of ListKey.\fP" +.ti -1c +.RI "virtual \fBSWKey\fP * \fBclone\fP () const" +.br +.RI "\fIReturns a copy of this \fBSWKey\fP object.\fP" +.ti -1c +.RI "virtual void \fBClearList\fP ()" +.br +.RI "\fIClears out elements of list.\fP" +.ti -1c +.RI "virtual int \fBCount\fP ()" +.br +.RI "\fIReturns number of elements in list.\fP" +.ti -1c +.RI "virtual void \fBRemove\fP ()" +.br +.RI "\fIRemoves current element from list.\fP" +.ti -1c +.RI "virtual char \fBSetToElement\fP (int ielement, SW_POSITION=TOP)" +.br +.RI "\fISets key to element number.\fP" +.ti -1c +.RI "virtual \fBSWKey\fP * \fBGetElement\fP (int pos=-1)" +.br +.RI "\fIGets a key element number.\fP" +.ti -1c +.RI "ListKey & \fBoperator<<\fP (const \fBSWKey\fP &ikey)" +.br +.RI "\fIAdds an element to the list.\fP" +.ti -1c +.RI "virtual void \fBadd\fP (const \fBSWKey\fP &ikey)" +.br +.ti -1c +.RI "virtual void \fBcopyFrom\fP (const ListKey &ikey)" +.br +.RI "\fIEquates this ListKey to another ListKey object.\fP" +.ti -1c +.RI "virtual void \fBcopyFrom\fP (const \fBSWKey\fP &ikey)" +.br +.RI "\fIEquates this \fBSWKey\fP to another \fBSWKey\fP object.\fP" +.ti -1c +.RI "virtual void \fBsetPosition\fP (SW_POSITION)" +.br +.RI "\fIPositions this key.\fP" +.ti -1c +.RI "virtual void \fBdecrement\fP (int step)" +.br +.RI "\fIDecrements a number of elements.\fP" +.ti -1c +.RI "virtual void \fBincrement\fP (int step)" +.br +.RI "\fIIncrements a number of elements.\fP" +.ti -1c +.RI "virtual char \fBTraversable\fP ()" +.br +.ti -1c +.RI "virtual long \fBIndex\fP () const" +.br +.RI "\fIUse this function to get te current position withing a module.\fP" +.ti -1c +.RI "virtual long \fBIndex\fP (long index)" +.br +.RI "\fIReturns the index for the new one given as as parameter.\fP" +.ti -1c +.RI "SWKEY_OPERATORS ListKey & \fBoperator=\fP (const ListKey &key)" +.br +.in -1c +.SS "Protected Attributes" + +.in +1c +.ti -1c +.RI "int \fBarraypos\fP" +.br +.ti -1c +.RI "int \fBarraymax\fP" +.br +.ti -1c +.RI "int \fBarraycnt\fP" +.br +.ti -1c +.RI "\fBSWKey\fP ** \fBarray\fP" +.br +.in -1c +.SS "Private Methods" + +.in +1c +.ti -1c +.RI "void \fBinit\fP ()" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "\fBSWClass\fP \fBclassdef\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +ListKey is the basis for all types of keys that have lists of specified indexes (e.g. +.PP +a list of verses, place, etc.) +.PP +Definition at line 36 of file listkey.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "ListKey::ListKey (const char * ikey = 0)" +.PP +initializes instance of ListKey. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +text key +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual int ListKey::Count ()\fC [virtual]\fP" +.PP +Returns number of elements in list. +.PP +\fBReturns: \fP +.in +1c +number of elements in list +.SS "virtual \fBSWKey\fP* ListKey::GetElement (int pos = -1)\fC [virtual]\fP" +.PP +Gets a key element number. +.PP +Parameters: +.in +1c +.TP +\fB\fIpos\fP\fP +element number to get (or default current) +.PP +\fBReturns: \fP +.in +1c +Key or null on error +.SS "virtual long ListKey::Index (long index)\fC [inline, virtual]\fP" +.PP +Returns the index for the new one given as as parameter. +.PP +The first parameter is the new index. +.PP +Reimplemented from \fBSWKey\fP. +.PP +Definition at line 112 of file listkey.h. +.SS "virtual long ListKey::Index () const\fC [inline, virtual]\fP" +.PP +Use this function to get te current position withing a module. +.PP +Here's a small example how to use this function and \fBIndex\fP(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 from \fBSWKey\fP. +.PP +Definition at line 106 of file listkey.h. +.SS "virtual char ListKey::SetToElement (int ielement, SW_POSITION = TOP)\fC [virtual]\fP" +.PP +Sets key to element number. +.PP +Parameters: +.in +1c +.TP +\fB\fIielement\fP\fP +element number to set to +.PP +\fBReturns: \fP +.in +1c +error status +.PP +Referenced by Index(). +.PP +.SS "virtual \fBSWKey\fP* ListKey::clone () const\fC [virtual]\fP" +.PP +Returns a copy of this \fBSWKey\fP object. +.PP +This is useful to get a 1:1 copy of an \fBSWKey\fP based object. +.PP +\fBReturns: \fP +.in +1c +\fBSWKey\fP +.PP +Reimplemented from \fBSWKey\fP. +.SS "virtual void ListKey::copyFrom (const \fBSWKey\fP & ikey)\fC [inline, virtual]\fP" +.PP +Equates this \fBSWKey\fP to another \fBSWKey\fP object. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +other swkey object +.PP +Reimplemented from \fBSWKey\fP. +.PP +Definition at line 90 of file listkey.h. +.SS "virtual void ListKey::copyFrom (const ListKey & ikey)\fC [virtual]\fP" +.PP +Equates this ListKey to another ListKey object. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +other ListKey object +.SS "ListKey& ListKey::operator<< (const \fBSWKey\fP & ikey)\fC [inline]\fP" +.PP +Adds an element to the list. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +the element to add +.PP +Definition at line 82 of file listkey.h. +.SS "virtual void ListKey::setPosition (SW_POSITION)\fC [virtual]\fP" +.PP +Positions this key. +.PP +Parameters: +.in +1c +.TP +\fB\fIp\fP\fP +position +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Reimplemented from \fBSWKey\fP. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file |