summaryrefslogtreecommitdiff
path: root/doc/api-documentation/html/class_gbffootnotes.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api-documentation/html/class_gbffootnotes.html')
-rw-r--r--doc/api-documentation/html/class_gbffootnotes.html278
1 files changed, 0 insertions, 278 deletions
diff --git a/doc/api-documentation/html/class_gbffootnotes.html b/doc/api-documentation/html/class_gbffootnotes.html
deleted file mode 100644
index 7a6d654..0000000
--- a/doc/api-documentation/html/class_gbffootnotes.html
+++ /dev/null
@@ -1,278 +0,0 @@
-<!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>GBFFootnotes 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> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </center>
-<hr><h1>GBFFootnotes Class Reference</h1>This Filter shows/hides footnotes in a GBF text.
-<a href="#_details">More...</a>
-<p>
-<code>#include &lt;<a class="el" href="gbffootnotes_h-source.html">gbffootnotes.h</a>&gt;</code>
-<p>
-<p>Inheritance diagram for GBFFootnotes::
-<p><center><img src="class_gbffootnotes.gif" usemap="#GBFFootnotes_map" border="0"></center>
-<map name="GBFFootnotes_map">
-<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,92,24">
-</map>
-<a href="class_gbffootnotes-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="GBFFootnotes::GBFFootnotes"></a>
-&nbsp;</td><td valign=bottom><b>GBFFootnotes</b> ()</td></tr>
-<tr><td nowrap align=right valign=top><a name="a1" doxytag="GBFFootnotes::~GBFFootnotes"></a>
-virtual&nbsp;</td><td valign=bottom><b>~GBFFootnotes</b> ()</td></tr>
-<tr><td nowrap align=right valign=top>virtual char&nbsp;</td><td valign=bottom><a class="el" href="class_gbffootnotes.html#a2">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>This is the main filter function.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>virtual const char*&nbsp;</td><td valign=bottom><a class="el" href="class_gbffootnotes.html#a3">getOptionName</a> ()</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>gets the name of the option of this filter.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>virtual const char*&nbsp;</td><td valign=bottom><a class="el" href="class_gbffootnotes.html#a4">getOptionTip</a> ()</td></tr>
-<tr><td>&nbsp;</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="#a4">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="class_gbffootnotes.html#a5">setOptionValue</a> (const char *ival)</td></tr>
-<tr><td>&nbsp;</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_gbffootnotes.html#a7">getOptionValues</a>.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top><a name="a6" doxytag="GBFFootnotes::getOptionValue"></a>
-virtual const char*&nbsp;</td><td valign=bottom><b>getOptionValue</b> ()</td></tr>
-<tr><td nowrap align=right valign=top>virtual OptionsList&nbsp;</td><td valign=bottom><a class="el" href="class_gbffootnotes.html#a7">getOptionValues</a> ()</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>returns a list of the possible option values might be.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr>
-<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
-<tr><td nowrap align=right valign=top><a name="o0" doxytag="GBFFootnotes::option"></a>
-bool&nbsp;</td><td valign=bottom><b>option</b></td></tr>
-<tr><td nowrap align=right valign=top><a name="o1" doxytag="GBFFootnotes::options"></a>
-OptionsList&nbsp;</td><td valign=bottom><b>options</b></td></tr>
-<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr>
-<tr><td nowrap align=right valign=top><a name="r0" doxytag="GBFFootnotes::on"></a>
-const char&nbsp;</td><td valign=bottom><b>on</b> []</td></tr>
-<tr><td nowrap align=right valign=top><a name="r1" doxytag="GBFFootnotes::off"></a>
-const char&nbsp;</td><td valign=bottom><b>off</b> []</td></tr>
-<tr><td nowrap align=right valign=top><a name="r2" doxytag="GBFFootnotes::optName"></a>
-const char&nbsp;</td><td valign=bottom><b>optName</b> []</td></tr>
-<tr><td nowrap align=right valign=top><a name="r3" doxytag="GBFFootnotes::optTip"></a>
-const char&nbsp;</td><td valign=bottom><b>optTip</b> []</td></tr>
-</table>
-<hr><a name="_details"></a><h2>Detailed Description</h2>
-This Filter shows/hides footnotes in a GBF text.
-<p>
-
-<p>
-Definition at line <a class="el" href="gbffootnotes_h-source.html#l00030">30</a> of file <a class="el" href="gbffootnotes_h-source.html">gbffootnotes.h</a>.<hr><h2>Member Function Documentation</h2>
-<a name="a2" doxytag="GBFFootnotes::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>
-virtual char GBFFootnotes::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>&nbsp;)<code> [virtual]</code>
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </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>
-&nbsp;</td><td>
-the text to be filtered/converted </td></tr>
-<tr><td valign=top><em>maxlen</em>
-&nbsp;</td><td>
-maximal length of text to be processed </td></tr>
-<tr><td valign=top><em>key</em>
-&nbsp;</td><td>
-sorry I don't know </td></tr>
-</table>
-</dl><dl compact><dt>
-<b>Returns: </b><dd>
-0 </dl>
-<p>
-Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td>
- </tr>
-</table>
-<a name="a3" doxytag="GBFFootnotes::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 * GBFFootnotes::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>
- &nbsp;
- </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 from <a class="el" href="class_swfilter.html#a1">SWFilter</a>.
-<p>
-Definition at line <a class="el" href="gbffootnotes_h-source.html#l00042">42</a> of file <a class="el" href="gbffootnotes_h-source.html">gbffootnotes.h</a>. </td>
- </tr>
-</table>
-<a name="a4" doxytag="GBFFootnotes::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 * GBFFootnotes::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>
- &nbsp;
- </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 from <a class="el" href="class_swfilter.html#a2">SWFilter</a>.
-<p>
-Definition at line <a class="el" href="gbffootnotes_h-source.html#l00046">46</a> of file <a class="el" href="gbffootnotes_h-source.html">gbffootnotes.h</a>. </td>
- </tr>
-</table>
-<a name="a7" doxytag="GBFFootnotes::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 GBFFootnotes::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>
- &nbsp;
- </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 from <a class="el" href="class_swfilter.html#a3">SWFilter</a>.
-<p>
-Definition at line <a class="el" href="gbffootnotes_h-source.html#l00052">52</a> of file <a class="el" href="gbffootnotes_h-source.html">gbffootnotes.h</a>. </td>
- </tr>
-</table>
-<a name="a5" doxytag="GBFFootnotes::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>
-virtual void GBFFootnotes::setOptionValue (
- </b></td>
- <td valign="bottom"><b>
-const char * <em>ival</em>&nbsp;)<code> [virtual]</code>
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </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_gbffootnotes.html#a7">getOptionValues</a>.
-<p>
-<dl compact><dt>
-<b>Parameters: </b><dd>
-<table border=0 cellspacing=2 cellpadding=0>
-<tr><td valign=top><em>ival</em>
-&nbsp;</td><td>
-the new option valus </td></tr>
-</table>
-</dl>
-<p>
-Reimplemented from <a class="el" href="class_swfilter.html#a4">SWFilter</a>. </td>
- </tr>
-</table>
-<hr>The documentation for this class was generated from the following file:<ul>
-<li><a class="el" href="gbffootnotes_h-source.html">gbffootnotes.h</a></ul>
-<hr><address><small>Generated at Fri Oct 5 22:45:34 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>,
- &copy;&nbsp;1997-2001</small></address>
-</body>
-</html>