diff options
Diffstat (limited to 'doc/api-documentation/html/class_swfilter.html')
| -rw-r--r-- | doc/api-documentation/html/class_swfilter.html | 350 |
1 files changed, 350 insertions, 0 deletions
diff --git a/doc/api-documentation/html/class_swfilter.html b/doc/api-documentation/html/class_swfilter.html new file mode 100644 index 0000000..d131e37 --- /dev/null +++ b/doc/api-documentation/html/class_swfilter.html @@ -0,0 +1,350 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWFilter class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWFilter Class Reference</h1>Base class for all filters in sword. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swfilter_h-source.html">swfilter.h</a>></code> +<p> +<p>Inheritance diagram for SWFilter:: +<p><center><img src="class_swfilter.gif" usemap="#SWFilter_map" border="0"></center> +<map name="SWFilter_map"> +<area href="class_gbffootnotes.html" alt="GBFFootnotes" shape="rect" coords="132,56,254,80"> +<area href="class_gbfheadings.html" alt="GBFHeadings" shape="rect" coords="132,112,254,136"> +<area href="class_gbfhtml.html" alt="GBFHTML" shape="rect" coords="132,168,254,192"> +<area href="class_gbfmorph.html" alt="GBFMorph" shape="rect" coords="132,224,254,248"> +<area href="class_gbfplain.html" alt="GBFPlain" shape="rect" coords="132,280,254,304"> +<area href="class_gbfrtf.html" alt="GBFRTF" shape="rect" coords="132,336,254,360"> +<area href="class_gbfstrongs.html" alt="GBFStrongs" shape="rect" coords="132,392,254,416"> +<area href="class_gbfthml.html" alt="GBFThML" shape="rect" coords="132,448,254,472"> +<area href="class_latin1utf16.html" alt="Latin1UTF16" shape="rect" coords="132,504,254,528"> +<area href="class_latin1utf8.html" alt="Latin1UTF8" shape="rect" coords="132,560,254,584"> +<area href="class_plainfootnotes.html" alt="PLAINFootnotes" shape="rect" coords="132,616,254,640"> +<area href="class_plainhtml.html" alt="PLAINHTML" shape="rect" coords="132,672,254,696"> +<area href="class_rtfhtml.html" alt="RTFHTML" shape="rect" coords="132,728,254,752"> +<area href="class_rwphtml.html" alt="RWPHTML" shape="rect" coords="132,784,254,808"> +<area href="class_rwprtf.html" alt="RWPRTF" shape="rect" coords="132,840,254,864"> +<area href="class_scsuutf8.html" alt="SCSUUTF8" shape="rect" coords="132,896,254,920"> +<area href="class_thmlgbf.html" alt="ThMLGBF" shape="rect" coords="132,952,254,976"> +<area href="class_thmlolb.html" alt="ThMLOLB" shape="rect" coords="132,1008,254,1032"> +<area href="class_thmlplain.html" alt="ThMLPlain" shape="rect" coords="132,1064,254,1088"> +<area href="class_thmlrtf.html" alt="ThMLRTF" shape="rect" coords="132,1120,254,1144"> +<area href="class_unicodertf.html" alt="UnicodeRTF" shape="rect" coords="132,1176,254,1200"> +<area href="class_utf16utf8.html" alt="UTF16UTF8" shape="rect" coords="132,1232,254,1256"> +<area href="class_utf8cantillation.html" alt="UTF8Cantillation" shape="rect" coords="132,1288,254,1312"> +<area href="class_utf8greekaccents.html" alt="UTF8GreekAccents" shape="rect" coords="132,1344,254,1368"> +<area href="class_utf8hebrewpoints.html" alt="UTF8HebrewPoints" shape="rect" coords="132,1400,254,1424"> +<area href="class_utf8utf16.html" alt="UTF8UTF16" shape="rect" coords="132,1456,254,1480"> +</map> +<a href="class_swfilter-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="SWFilter::~SWFilter"></a> +virtual </td><td valign=bottom><b>~SWFilter</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_swfilter.html#a1">getOptionName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets the name of the option of this filter.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_swfilter.html#a2">getOptionTip</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual OptionsList </td><td valign=bottom><a class="el" href="class_swfilter.html#a3">getOptionValues</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>returns a list of the possible option values might be.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swfilter.html#a4">setOptionValue</a> (const char *)</td></tr> +<tr><td> </td><td><font size=-1><em>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 <a class="el" href="class_swfilter.html#a3">getOptionValues</a>.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="SWFilter::getOptionValue"></a> +virtual const char* </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_swfilter.html#a6">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_swfilter.html#a7">ProcessText</a> (char *text, int maxlen=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function without the 3rd parameter.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Base class for all filters in sword. +<p> +Filters are used to filter/convert text between different formats like GBF, HTML, RTF ... +<p> + +<p> +Definition at line <a class="el" href="swfilter_h-source.html#l00041">41</a> of file <a class="el" href="swfilter_h-source.html">swfilter.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a7" doxytag="SWFilter::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char SWFilter::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em> = -1 )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function without the 3rd parameter. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented in <a class="el" href="class_gbfthml.html#a1">GBFThML</a>, <a class="el" href="class_thmlgbf.html#a1">ThMLGBF</a>, <a class="el" href="class_thmlolb.html#a1">ThMLOLB</a>, <a class="el" href="class_thmlplain.html#a1">ThMLPlain</a>, and <a class="el" href="class_thmlrtf.html#a1">ThMLRTF</a>. +<p> +Definition at line <a class="el" href="swfilter_h-source.html#l00100">100</a> of file <a class="el" href="swfilter_h-source.html">swfilter.h</a>. </td> + </tr> +</table> +<a name="a6" doxytag="SWFilter::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char SWFilter::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented in <a class="el" href="class_gbffootnotes.html#a2">GBFFootnotes</a>, <a class="el" href="class_gbfheadings.html#a2">GBFHeadings</a>, <a class="el" href="class_gbfhtml.html#a1">GBFHTML</a>, <a class="el" href="class_gbfmorph.html#a2">GBFMorph</a>, <a class="el" href="class_gbfplain.html#a1">GBFPlain</a>, <a class="el" href="class_gbfrtf.html#a1">GBFRTF</a>, <a class="el" href="class_gbfstrongs.html#a2">GBFStrongs</a>, <a class="el" href="class_latin1utf16.html#a1">Latin1UTF16</a>, <a class="el" href="class_latin1utf8.html#a1">Latin1UTF8</a>, <a class="el" href="class_plainfootnotes.html#a2">PLAINFootnotes</a>, <a class="el" href="class_plainhtml.html#a1">PLAINHTML</a>, <a class="el" href="class_rtfhtml.html#a1">RTFHTML</a>, <a class="el" href="class_rwphtml.html#a1">RWPHTML</a>, <a class="el" href="class_rwprtf.html#a1">RWPRTF</a>, <a class="el" href="class_scsuutf8.html#a1">SCSUUTF8</a>, <a class="el" href="class_unicodertf.html#a1">UnicodeRTF</a>, <a class="el" href="class_utf16utf8.html#a1">UTF16UTF8</a>, <a class="el" href="class_utf8cantillation.html#a2">UTF8Cantillation</a>, <a class="el" href="class_utf8greekaccents.html#a2">UTF8GreekAccents</a>, <a class="el" href="class_utf8hebrewpoints.html#a2">UTF8HebrewPoints</a>, and <a class="el" href="class_utf8utf16.html#a1">UTF8UTF16</a>. +<p> +Definition at line <a class="el" href="swfilter_h-source.html#l00091">91</a> of file <a class="el" href="swfilter_h-source.html">swfilter.h</a>. +<p> +Referenced by <a class="el" href="swfilter_h-source.html#l00100">ProcessText</a>(). </td> + </tr> +</table> +<a name="a1" doxytag="SWFilter::getOptionName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * SWFilter::getOptionName ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets the name of the option of this filter. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option name </dl> +<p> +Reimplemented in <a class="el" href="class_gbffootnotes.html#a3">GBFFootnotes</a>, <a class="el" href="class_gbfheadings.html#a3">GBFHeadings</a>, <a class="el" href="class_gbfmorph.html#a3">GBFMorph</a>, <a class="el" href="class_gbfstrongs.html#a3">GBFStrongs</a>, <a class="el" href="class_plainfootnotes.html#a3">PLAINFootnotes</a>, <a class="el" href="class_utf8cantillation.html#a3">UTF8Cantillation</a>, <a class="el" href="class_utf8greekaccents.html#a3">UTF8GreekAccents</a>, and <a class="el" href="class_utf8hebrewpoints.html#a3">UTF8HebrewPoints</a>. +<p> +Definition at line <a class="el" href="swfilter_h-source.html#l00051">51</a> of file <a class="el" href="swfilter_h-source.html">swfilter.h</a>. </td> + </tr> +</table> +<a name="a2" doxytag="SWFilter::getOptionTip"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * SWFilter::getOptionTip ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option tip/explanation </dl> +<p> +Reimplemented in <a class="el" href="class_gbffootnotes.html#a4">GBFFootnotes</a>, <a class="el" href="class_gbfheadings.html#a4">GBFHeadings</a>, <a class="el" href="class_gbfmorph.html#a4">GBFMorph</a>, <a class="el" href="class_gbfstrongs.html#a4">GBFStrongs</a>, <a class="el" href="class_plainfootnotes.html#a4">PLAINFootnotes</a>, <a class="el" href="class_utf8cantillation.html#a4">UTF8Cantillation</a>, <a class="el" href="class_utf8greekaccents.html#a4">UTF8GreekAccents</a>, and <a class="el" href="class_utf8hebrewpoints.html#a4">UTF8HebrewPoints</a>. +<p> +Definition at line <a class="el" href="swfilter_h-source.html#l00059">59</a> of file <a class="el" href="swfilter_h-source.html">swfilter.h</a>. </td> + </tr> +</table> +<a name="a3" doxytag="SWFilter::getOptionValues"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +OptionsList SWFilter::getOptionValues ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +returns a list of the possible option values might be. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +list of option values </dl> +<p> +Reimplemented in <a class="el" href="class_gbffootnotes.html#a7">GBFFootnotes</a>, <a class="el" href="class_gbfheadings.html#a7">GBFHeadings</a>, <a class="el" href="class_gbfmorph.html#a7">GBFMorph</a>, <a class="el" href="class_gbfstrongs.html#a7">GBFStrongs</a>, <a class="el" href="class_plainfootnotes.html#a7">PLAINFootnotes</a>, <a class="el" href="class_utf8cantillation.html#a7">UTF8Cantillation</a>, <a class="el" href="class_utf8greekaccents.html#a7">UTF8GreekAccents</a>, and <a class="el" href="class_utf8hebrewpoints.html#a7">UTF8HebrewPoints</a>. +<p> +Definition at line <a class="el" href="swfilter_h-source.html#l00067">67</a> of file <a class="el" href="swfilter_h-source.html">swfilter.h</a>. </td> + </tr> +</table> +<a name="a4" doxytag="SWFilter::setOptionValue"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWFilter::setOptionValue ( + </b></td> + <td valign="bottom"><b> +const char * <em>ival</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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 <a class="el" href="class_swfilter.html#a3">getOptionValues</a>. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ival</em> + </td><td> +the new option valus </td></tr> +</table> +</dl> +<p> +Reimplemented in <a class="el" href="class_gbffootnotes.html#a5">GBFFootnotes</a>, <a class="el" href="class_gbfheadings.html#a5">GBFHeadings</a>, <a class="el" href="class_gbfmorph.html#a5">GBFMorph</a>, <a class="el" href="class_gbfstrongs.html#a5">GBFStrongs</a>, <a class="el" href="class_plainfootnotes.html#a5">PLAINFootnotes</a>, <a class="el" href="class_utf8cantillation.html#a5">UTF8Cantillation</a>, <a class="el" href="class_utf8greekaccents.html#a5">UTF8GreekAccents</a>, and <a class="el" href="class_utf8hebrewpoints.html#a5">UTF8HebrewPoints</a>. +<p> +Definition at line <a class="el" href="swfilter_h-source.html#l00078">78</a> of file <a class="el" href="swfilter_h-source.html">swfilter.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swfilter_h-source.html">swfilter.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> |