The Sword Project: sword::zCom Class Reference

sword::zCom Class Reference

Inheritance diagram for sword::zCom:

[legend]Collaboration diagram for sword::zCom:

[legend]List of all members.

Public Member Functions
	zCom (const char *ipath, const char *iname=0, const char *idesc=0, int blockType=CHAPTERBLOCKS, SWCompress *icomp=0, SWDisplay *idisp=0, char encoding=ENC_UNKNOWN, char dir=DIRECTION_LTR, char markup=FMT_UNKNOWN, const char *ilang=0)
virtual SWBuf &	getRawEntryBuf ()
	This function is reimplemented by the different kinds of module objects.
virtual void	increment (int steps=1)
	Increments module key a number of entries.
virtual void	decrement (int steps=1)
	Decrements module key a number of entries.
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 void	rawZFilter (SWBuf &buf, char direction=0)
virtual void	flush ()
	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 *path, int blockBound)
Private Member Functions
bool	sameBlock (VerseKey *lastWriteKey, VerseKey *key)
Private Attributes
VerseKey *	lastWriteKey
int	blockType

---

Detailed Description

Definition at line 32 of file zcom.h.

---

Member Function Documentation

virtual SWBuf& sword::zCom::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 void sword::zCom::increment

(

int

steps = 1

)

[virtual]

Increments module key a number of entries.

Parameters:

steps

Number of entries to jump forward

Reimplemented from sword::SWModule.

virtual void sword::zCom::decrement

(

int

steps = 1

)

[inline, virtual]

Decrements module key a number of entries.

Parameters:

steps

Number of entries to jump backward

Reimplemented from sword::SWModule.

Definition at line 49 of file zcom.h.

References sword::SWModule::increment().

virtual bool sword::zCom::isWritable

(

)

[virtual]

Is the module writable? :).

Returns:

yes or no

Reimplemented from sword::SWModule.

---

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

• zcom.h

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