Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

SWGenBook Class Reference

the basis for all types of Lexicon and Dictionary modules (hence the 'LD'). More...

#include <swgenbook.h>

Inheritance diagram for SWGenBook:

Inheritance graph
[legend]
Collaboration diagram for SWGenBook:

Collaboration graph
[legend]
List of all members.

Public Methods

 SWGenBook (const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *ilang=0)
 Initializes data for instance of SWLD. More...

virtual ~SWGenBook ()
virtual SWKeyCreateKey ()=0
 Allocates a key of specific type for module The different reimplementatiosn of SWModule (e.g. More...


Protected Attributes

char * entkeytxt

Detailed Description

the basis for all types of Lexicon and Dictionary modules (hence the 'LD').

Definition at line 34 of file swgenbook.h.


Constructor & Destructor Documentation

SWGenBook::SWGenBook const char *    imodname = 0,
const char *    imoddesc = 0,
SWDisplay   idisp = 0,
SWTextEncoding    encoding = ENC_UNKNOWN,
SWTextDirection    dir = DIRECTION_LTR,
SWTextMarkup    markup = FMT_UNKNOWN,
const char *    ilang = 0
 

Initializes data for instance of SWLD.

Parameters:
imodname  Internal name for module
imoddesc  Name to display to user for module
idisp  Display object to use for displaying

Definition at line 17 of file swgenbook.cpp.

00017                                                                                                                                                                 : SWModule(imodname, imoddesc, idisp, "Generic Books", enc, dir, mark, ilang) {
00018 }


Member Function Documentation

virtual SWKey* SWGenBook::CreateKey   [pure virtual]
 

Allocates a key of specific type for module The different reimplementatiosn of SWModule (e.g.

SWText) support SWKey implementations, which support special. This functions returns a SWKey object which works with the current implementation of SWModule. For example for the SWText class it returns a VerseKey object.

See also:
VerseKey, ListKey, SWText, SWLD, SWCom
Returns:
pointer to allocated key

Reimplemented from SWModule.


The documentation for this class was generated from the following files:
Generated on Thu Jun 20 22:13:03 2002 for The Sword Project by doxygen1.2.15