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

SWCom Class Reference

The basis for all commentary modules. More...

#include <swcom.h>

Inheritance diagram for SWCom:

Inheritance graph
[legend]
Collaboration diagram for SWCom:

Collaboration graph
[legend]
List of all members.

Public Methods

 SWCom (const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, SWTextEncoding enc=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup mark=FMT_UNKNOWN, const char *ilang=0)
 Initializes data for instance of SWCom. More...

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


Detailed Description

The basis for all commentary modules.

Definition at line 33 of file swcom.h.


Constructor & Destructor Documentation

SWCom::SWCom const char *    imodname = 0,
const char *    imoddesc = 0,
SWDisplay   idisp = 0,
SWTextEncoding    enc = ENC_UNKNOWN,
SWTextDirection    dir = DIRECTION_LTR,
SWTextMarkup    mark = FMT_UNKNOWN,
const char *    ilang = 0
 

Initializes data for instance of SWCom.

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 swcom.cpp.

References CreateKey(), and SWModule::key.

00017                                                                                                                                                        : SWModule(imodname, imoddesc, idisp, "Commentaries", enc, dir, mark, ilang)
00018 {
00019         delete key;
00020         key = CreateKey();
00021 }


Member Function Documentation

virtual SWKey* SWCom::CreateKey   [inline, 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.

Definition at line 44 of file swcom.h.

Referenced by SWCom().

00045   {
00046     return new VerseKey();
00047   }


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