sword::OSISRTF Class Reference

this filter converts OSIS text to RTF text More...

#include <osisrtf.h>

Inheritance diagram for sword::OSISRTF:

[legend]Collaboration diagram for sword::OSISRTF:


Protected Member Functions
virtual BasicFilterUserData *	createUserData (const SWModule module, const SWKey key)
virtual bool	handleToken (SWBuf &buf, const char token, BasicFilterUserData userData)
	This function is called for every token encountered in the input text.
virtual char	processText (SWBuf &text, const SWKey key=0, const SWModule module=0)
	This is the main filter function.

Detailed Description

this filter converts OSIS text to RTF text

Definition at line 30 of file osisrtf.h.

virtual bool sword::OSISRTF::handleToken	(	SWBuf &	buf,
		const char *	token,
		BasicFilterUserData *	userData
	)			`[protected, virtual]`

This function is called for every token encountered in the input text.

Parameters:

	buf	the output buffer
	token	the token (e.g. `"p align='left'"`
	userData	user storage space for data transient to 1 full buffer parse

Returns:: subclasses should return true if they handled the token, or false if they did not.

virtual char sword::OSISRTF::processText	(	SWBuf &	text,
		const SWKey *	key = `0`,
		const SWModule *	module = `0`
	)			`[protected, virtual]`

This is the main filter function.

Parameters:

	text	The text to be filtered/converted
	key	Current key That was used.
	module	Current module.

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

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