The Sword Project: sword::SWLD Class Reference

sword::SWLD Class Reference

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

#include <swld.h>

Inheritance diagram for sword::SWLD:

[legend]Collaboration diagram for sword::SWLD:

[legend]List of all members.

Public Member Functions
	SWLD (const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, char encoding=ENC_UNKNOWN, char dir=DIRECTION_LTR, char markup=FMT_UNKNOWN, const char *ilang=0)
	Initializes data for instance of SWLD.
virtual SWKey *	CreateKey ()
	Allocates a key of specific type for module The different reimplementatiosn of SWModule (e.g.
virtual const char *	KeyText (const char *ikeytext=0)
	Sets/gets module KeyText, getting from saved text if key is persistent.
virtual void	setPosition (SW_POSITION pos)
	Positions this modules to a logical position entry.
	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 Attributes
char *	entkeytxt

---

Detailed Description

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

Definition at line 35 of file swld.h.

---

Member Function Documentation

virtual SWKey* sword::SWLD::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.

virtual const char* sword::SWLD::KeyText

(

const char *

ikeytext = 0

)

[virtual]

Sets/gets module KeyText, getting from saved text if key is persistent.

Parameters:

ikeytext

value which to set keytext; [0] - only get

Returns:

pointer to keytext

Reimplemented from sword::SWModule.

virtual void sword::SWLD::setPosition

(

SW_POSITION

pos

)

[virtual]

Positions this modules to a logical position entry.

Parameters:

pos

position (e.g. TOP, BOTTOM)

Reimplemented from sword::SWModule.

---

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

• swld.h

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