The Sword Project: sword::SWCom Class Reference

sword::SWCom Class Reference

The basis for all commentary modules. More...

#include <swcom.h>

Inheritance diagram for sword::SWCom:

[legend]Collaboration diagram for sword::SWCom:

[legend]List of all members.

Public Member Functions
	SWCom (const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, char enc=ENC_UNKNOWN, char dir=DIRECTION_LTR, char mark=FMT_UNKNOWN, const char *ilang=0)
	Initializes data for instance of SWCom.
virtual SWKey *	CreateKey ()
	Allocates a key of specific type for module The different reimplementatiosn of SWModule (e.g.
virtual long	Index () const
virtual long	Index (long iindex)
	operator const char * ()
	operator SWKey & ()
	operator SWKey * ()
SWModule &	operator<< (const char *inbuf)
SWModule &	operator<< (const SWKey *sourceKey)
SWModule &	operator-= (int steps)
SWModule &	operator+= (int steps)
SWModule &	operator++ (int)
SWModule &	operator-- (int)
SWModule &	operator= (SW_POSITION p)
Protected Member Functions
VerseKey &	getVerseKey () const
Private Attributes
VerseKey *	tmpVK

---

Detailed Description

The basis for all commentary modules.

Definition at line 37 of file swcom.h.

---

Member Function Documentation

virtual SWKey* sword::SWCom::CreateKey

(

)

[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 sword::SWModule.

---

The documentation for this class was generated from the following file:

• swcom.h

The SWORD Project; P. O. Box 2528; Tempe, AZ 85280-2528 USA