The Sword Project: sword::RawGenBook Class Reference

sword::RawGenBook Class Reference

Inheritance diagram for sword::RawGenBook:

[legend]Collaboration diagram for sword::RawGenBook:

[legend]List of all members.

Public Member Functions
	RawGenBook (const char *ipath, const char *iname=0, const char *idesc=0, SWDisplay *idisp=0, char encoding=ENC_UNKNOWN, char dir=DIRECTION_LTR, char markup=FMT_UNKNOWN, const char *ilang=0, const char *keyType="TreeKey")
virtual SWBuf &	getRawEntryBuf ()
	This function is reimplemented by the different kinds of module objects.
virtual bool	isWritable ()
	Is the module writable? :).
virtual void	setEntry (const char *inbuf, long len=-1)
	Modify the current module entry text - only if module isWritable().
virtual void	linkEntry (const SWKey *linkKey)
	Link the current module entry to another module entry - only if module isWritable().
virtual void	deleteEntry ()
	Delete current module entry - only if module isWritable().
virtual SWKey *	CreateKey ()
	Allocates a key of specific type for module The different reimplementatiosn of SWModule (e.g.
	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)
Static Public Member Functions
static char	createModule (const char *ipath)
	Creates a new, empty module.
Private Attributes
char *	path
FileDesc *	bdtfd
bool	verseKey

---

Detailed Description

Definition at line 34 of file rawgenbook.h.

---

Member Function Documentation

virtual SWBuf& sword::RawGenBook::getRawEntryBuf

(

)

[virtual]

This function is reimplemented by the different kinds of module objects.

Returns:

the raw module text of the current entry

Implements sword::SWModule.

virtual bool sword::RawGenBook::isWritable

(

)

[virtual]

Is the module writable? :).

Returns:

yes or no

Reimplemented from sword::SWModule.

static char sword::RawGenBook::createModule

(

const char *

ipath

)

[static]

Creates a new, empty module.

Parameters:

path

path where to create the new module

Returns:

error

Reimplemented from sword::SWModule.

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

Implements sword::SWGenBook.

---

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

• rawgenbook.h

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