---
name: "swfilter"
section: "3"
platform: "linux"
package: "libsword-dev"
version: "1.5.3-3woody2"
release: "Debian 3.0 (Woody)"
platforms: ["linux"]
url: "https://new.carta.tech/swfilter"
---

# swfilter(3)

Base class for all filters in sword.

## NAME

SWFilter - Base class for all filters in sword.

## SYNOPSIS

`#include <swfilter.h>`

Inherited by CipherFilter, **GBFFootnotes**, **GBFHeadings**, **GBFHTML**, **GBFMorph**, **GBFPlain**, **GBFRTF**, **GBFStrongs**, **GBFThML**, **Latin1UTF16**, **Latin1UTF8**, **PLAINFootnotes**, **PLAINHTML**, **RTFHTML**, **RWPHTML**, **RWPRTF**, **SCSUUTF8**, SWBasicFilter, **ThMLGBF**, **ThMLOLB**, **ThMLPlain**, **ThMLRTF**, **UnicodeRTF**, **UTF16UTF8**, **UTF8Cantillation**, **UTF8GreekAccents**, **UTF8HebrewPoints**, and **UTF8UTF16**.

### Public Methods

virtual **~SWFilter** ()\
 virtual const char\* **getOptionName** ()\
 *gets the name of the option of this filter.* virtual const char\* **getOptionTip** ()\
 *gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.* virtual OptionsList **getOptionValues** ()\
 *returns a list of the possible option values might be.* virtual void **setOptionValue** (const char \*)\
 *sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to* *on"*/*off*-*that*would*mean*to*show*or*not*to*show*the*strongs*in*the*text,*see*also***getOptionValues**."* virtual const char\* **getOptionValue** ()\
 virtual char **ProcessText** (char \*text, int maxlen, const **SWKey** \*)\
 *This is the main filter function.* virtual char **ProcessText** (char \*text, int maxlen=-1)\
 *This is the main filter function without the 3rd parameter.*

## DETAILED DESCRIPTION

Base class for all filters in sword.

Filters are used to filter/convert text between different formats like GBF, HTML, RTF ...

Definition at line 41 of file swfilter.h.

## MEMBER FUNCTION DOCUMENTATION

### char SWFilter::ProcessText (char \* text, int maxlen = -1)` [inline, virtual]`

This is the main filter function without the 3rd parameter.

**Parameters:**

- *text*

  the text to be filtered/converted

- *maxlen*

  maximal length of text to be processed

**Returns:**  0

Reimplemented in **GBFThML**, **ThMLGBF**, **ThMLOLB**, **ThMLPlain**, and **ThMLRTF**.

Definition at line 100 of file swfilter.h.

### char SWFilter::ProcessText (char \* text, int maxlen, const SWKey \* key)` [inline, virtual]`

This is the main filter function.

**Parameters:**

- *text*

  the text to be filtered/converted

- *maxlen*

  maximal length of text to be processed

- *key*

  sorry I don't know

**Returns:**  0

Reimplemented in **GBFFootnotes**, **GBFHeadings**, **GBFHTML**, **GBFMorph**, **GBFPlain**, **GBFRTF**, **GBFStrongs**, **Latin1UTF16**, **Latin1UTF8**, **PLAINFootnotes**, **PLAINHTML**, **RTFHTML**, **RWPHTML**, **RWPRTF**, **SCSUUTF8**, **UnicodeRTF**, **UTF16UTF8**, **UTF8Cantillation**, **UTF8GreekAccents**, **UTF8HebrewPoints**, and **UTF8UTF16**.

Definition at line 91 of file swfilter.h.

Referenced by ProcessText().

### const char \* SWFilter::getOptionName ()` [inline, virtual]`

gets the name of the option of this filter.

**Returns:**  option name

Reimplemented in **GBFFootnotes**, **GBFHeadings**, **GBFMorph**, **GBFStrongs**, **PLAINFootnotes**, **UTF8Cantillation**, **UTF8GreekAccents**, and **UTF8HebrewPoints**.

Definition at line 51 of file swfilter.h.

### const char \* SWFilter::getOptionTip ()` [inline, virtual]`

gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.

**Returns:**  option tip/explanation

Reimplemented in **GBFFootnotes**, **GBFHeadings**, **GBFMorph**, **GBFStrongs**, **PLAINFootnotes**, **UTF8Cantillation**, **UTF8GreekAccents**, and **UTF8HebrewPoints**.

Definition at line 59 of file swfilter.h.

### OptionsList SWFilter::getOptionValues ()` [inline, virtual]`

returns a list of the possible option values might be.

**Returns:**  list of option values

Reimplemented in **GBFFootnotes**, **GBFHeadings**, **GBFMorph**, **GBFStrongs**, **PLAINFootnotes**, **UTF8Cantillation**, **UTF8GreekAccents**, and **UTF8HebrewPoints**.

Definition at line 67 of file swfilter.h.

### void SWFilter::setOptionValue (const char \* ival)` [inline, virtual]`

sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also **getOptionValues**.

**Parameters:**

- *ival*

  the new option valus

Reimplemented in **GBFFootnotes**, **GBFHeadings**, **GBFMorph**, **GBFStrongs**, **PLAINFootnotes**, **UTF8Cantillation**, **UTF8GreekAccents**, and **UTF8HebrewPoints**.

Definition at line 78 of file swfilter.h.

## AUTHOR

Generated automatically by Doxygen for The Sword Project from the source code.