#include <swkey.h>
Inheritance diagram for SWKey::

Public Methods | |
| SWKey (const char *ikey=0) | |
| initializes instance of SWKey. More... | |
| SWKey (SWKey const &k) | |
| Copy Constructor. More... | |
| virtual | ~SWKey () |
| Destructor, cleans up this instance of SWKey. | |
| virtual SWKey * | clone () const |
| Returns a copy of this SWKey object. More... | |
| char | Persist () const |
| Gets whether this object itself persists within a module that it was used to SetKey or just a copy. More... | |
| char | Persist (char ikey) |
| Set/gets whether this object itself persists within a module that it was used to SetKey or just a copy. More... | |
| virtual char | Error () |
| Gets and clears error status. More... | |
| 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 const char * | getText () const |
| returns text key if (char *) cast is requested. | |
| virtual int | compare (const SWKey &ikey) |
| Compares another VerseKey object. More... | |
| virtual bool | equals (const SWKey &ikey) |
| Compares another VerseKey object. More... | |
| virtual void | setPosition (SW_POSITION) |
| virtual void | decrement (int steps=1) |
| Decrements key a number of entries. More... | |
| virtual void | increment (int steps=1) |
| Increments key a number of entries. More... | |
| virtual char | Traversable () |
| virtual long | Index () const |
| Use this function to get te current position withing a module. More... | |
| virtual long | Index (long iindex) |
Protected Attributes | |
| char * | keytext |
| char | persist |
| char | error |
Private Methods | |
| void | init () |
Private Attributes | |
| long | index |
Static Private Attributes | |
| SWClass | classdef |
verse, word, place, etc.)
Definition at line 76 of file swkey.h.
|
|
initializes instance of SWKey.
|
|
|
Copy Constructor.
|
|
|
Gets and clears error status.
|
|
|
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 in ListKey, and VerseKey. Definition at line 204 of file swkey.h. Referenced by ListKey::Index().
|
|
|
Set/gets whether this object itself persists within a module that it was used to SetKey or just a copy. (1 - persists in module; 0 - a copy is attempted
|
|
|
Gets whether this object itself persists within a module that it was used to SetKey or just a copy. (1 - persists in module; 0 - a copy is attempted
|
|
|
Returns a copy of this SWKey object. This is useful to get a 1:1 copy of an SWKey based object.
|
|
|
Compares another VerseKey object.
Reimplemented in VerseKey. Referenced by equals().
|
|
|
Equates this SWKey to another SWKey object.
Reimplemented in ListKey, and VerseKey. Referenced by ListKey::copyFrom().
|
|
|
Decrements key a number of entries.
|
|
|
Compares another VerseKey object.
|
|
|
Increments key a number of entries.
|
|
|
Equates this SWKey to a character string.
Reimplemented in VerseKey. Referenced by VerseKey::setText().
|
1.2.9.1 written by Dimitri van Heesch,
© 1997-2001