The Sword Project: sword::RawFiles Class Reference

sword::RawFiles Class Reference

Inheritance diagram for sword::RawFiles:

[legend]Collaboration diagram for sword::RawFiles:

[legend]List of all members.

Public Member Functions
	RawFiles (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)
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.
	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 *)
	Creates a new module.
Private Member Functions
char *	getNextFilename ()

---

Detailed Description

Definition at line 34 of file rawfiles.h.

---

Member Function Documentation

virtual SWBuf& sword::RawFiles::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::RawFiles::isWritable

(

)

[virtual]

Is the module writable? :).

Returns:

yes or no

Reimplemented from sword::SWModule.

static char sword::RawFiles::createModule

(

const char *

)

[static]

Creates a new module.

Parameters:

path

The first parameter is path of the new module

Returns:

error

Reimplemented from sword::RawVerse.

virtual void sword::RawFiles::setEntry	(	const char *	inbuf,
		long	len = -1
	)			[virtual]

Modify the current module entry text

• only if module isWritable.

Returns:

*this

Reimplemented from sword::SWModule.

virtual void sword::RawFiles::linkEntry

(

const SWKey *

linkKey

)

[virtual]

Link the current module entry to another module entry

• only if module isWritable.

Returns:

*this

Reimplemented from sword::SWModule.

---

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

• rawfiles.h

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