diff options
Diffstat (limited to 'doc/api-documentation/html/swfilter_8h-source.html')
| -rw-r--r-- | doc/api-documentation/html/swfilter_8h-source.html | 145 |
1 files changed, 74 insertions, 71 deletions
diff --git a/doc/api-documentation/html/swfilter_8h-source.html b/doc/api-documentation/html/swfilter_8h-source.html index 76f7525..7eb7e7a 100644 --- a/doc/api-documentation/html/swfilter_8h-source.html +++ b/doc/api-documentation/html/swfilter_8h-source.html @@ -3,82 +3,85 @@ <title>swfilter.h Source File</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> -<!-- Generated by Doxygen 1.2.15 --> +<!-- Generated by Doxygen 1.2.17 --> <center> -<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</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.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> -00002 <font class="comment"> * swfilter.h - definition of class SWFilter used to filter text between</font> -00003 <font class="comment"> * different formats</font> -00004 <font class="comment"> *</font> -00005 <font class="comment"> * $Id: swfilter_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $</font> -00006 <font class="comment"> *</font> -00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> -00008 <font class="comment"> * CrossWire Bible Society</font> -00009 <font class="comment"> * P. O. Box 2528</font> -00010 <font class="comment"> * Tempe, AZ 85280-2528</font> -00011 <font class="comment"> *</font> -00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> -00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> -00014 <font class="comment"> * Free Software Foundation version 2.</font> -00015 <font class="comment"> *</font> -00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> -00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> -00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> -00019 <font class="comment"> * General Public License for more details.</font> -00020 <font class="comment"> *</font> -00021 <font class="comment"> */</font> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</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="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swfilter.h</h1><div class="fragment"><pre>00001 <span class="comment">/******************************************************************************</span> +00002 <span class="comment"> * swfilter.h - definition of class SWFilter used to filter text between</span> +00003 <span class="comment"> * different formats</span> +00004 <span class="comment"> *</span> +00005 <span class="comment"> * $Id: swfilter_8h-source.html,v 1.9 2002/10/31 11:30:16 joachim Exp $</span> +00006 <span class="comment"> *</span> +00007 <span class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</span> +00008 <span class="comment"> * CrossWire Bible Society</span> +00009 <span class="comment"> * P. O. Box 2528</span> +00010 <span class="comment"> * Tempe, AZ 85280-2528</span> +00011 <span class="comment"> *</span> +00012 <span class="comment"> * This program is free software; you can redistribute it and/or modify it</span> +00013 <span class="comment"> * under the terms of the GNU General Public License as published by the</span> +00014 <span class="comment"> * Free Software Foundation version 2.</span> +00015 <span class="comment"> *</span> +00016 <span class="comment"> * This program is distributed in the hope that it will be useful, but</span> +00017 <span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span> +00018 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> +00019 <span class="comment"> * General Public License for more details.</span> +00020 <span class="comment"> *</span> +00021 <span class="comment"> */</span> 00022 -00023 <font class="preprocessor">#ifndef SWFILTER_H</font> -00024 <font class="preprocessor"></font><font class="preprocessor">#define SWFILTER_H</font> -00025 <font class="preprocessor"></font><font class="preprocessor">#include <string></font> -00026 <font class="preprocessor">#include <list></font> -00027 <font class="preprocessor">#include <swkey.h></font> +00023 <span class="preprocessor">#ifndef SWFILTER_H</span> +00024 <span class="preprocessor"></span><span class="preprocessor">#define SWFILTER_H</span> +00025 <span class="preprocessor"></span><span class="preprocessor">#include <string></span> +00026 <span class="preprocessor">#include <list></span> +00027 <span class="preprocessor">#include <swkey.h></span> 00028 -00029 <font class="preprocessor">#include <defs.h></font> +00029 <span class="preprocessor">#include <defs.h></span> 00030 -00034 <font class="keyword">typedef</font> std::list < std::string > OptionsList; -00035 -00036 -00041 <font class="keyword">class </font><a class="code" href="class_s_w_module.html">SWModule</a>; -00042 -00043 <font class="keyword">class </font>SWDLLEXPORT SWFilter { -00044 <font class="keyword">public</font>: -00045 <font class="keyword">virtual</font> ~SWFilter() {} -00049 <font class="comment">// typedef std::list < std::string > OptionsList;</font> -00053 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> * getOptionName () -00054 { -00055 <font class="keywordflow">return</font> 0; -00056 } -00061 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> * getOptionTip () -00062 { -00063 <font class="keywordflow">return</font> 0; -00064 } -00069 <font class="keyword">virtual</font> OptionsList getOptionValues () -00070 { -00071 OptionsList options; -00072 <font class="keywordflow">return</font> options; -00073 } -00080 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *) -00081 { -00082 } -00083 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> * getOptionValue () -00084 { -00085 <font class="keywordflow">return</font> 0; -00086 } -00093 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText(<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> *, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0) -00094 { -00095 <font class="keywordflow">return</font> ProcessText(text, maxlen); -00096 } -00102 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText(<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1) -00103 { -00104 <font class="keywordflow">return</font> ProcessText(text, maxlen, 0); -00105 } -00106 }; -00107 -00108 <font class="preprocessor">#endif</font> -</pre></div><hr><address align="right"><small>Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by +00031 SWORD_NAMESPACE_START +00032 +<a name="l00036"></a><a class="code" href="namespacesword.html#a82">00036</a> <span class="keyword">typedef</span> std::list < std::string > <a class="code" href="namespacesword.html#a82">OptionsList</a>; +00037 +00038 +00043 <span class="keyword">class </span><a class="code" href="classsword_1_1_s_w_module.html">SWModule</a>; +00044 +00045 <span class="keyword">class </span>SWDLLEXPORT SWFilter { +00046 <span class="keyword">public</span>: +00047 <span class="keyword">virtual</span> ~SWFilter() {} +00051 <span class="comment">// typedef std::list < std::string > OptionsList;</span> +00055 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * getOptionName () +00056 { +00057 <span class="keywordflow">return</span> 0; +00058 } +00063 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * getOptionTip () +00064 { +00065 <span class="keywordflow">return</span> 0; +00066 } +00071 <span class="keyword">virtual</span> <a class="code" href="namespacesword.html#a82">OptionsList</a> getOptionValues () +00072 { +00073 <a class="code" href="namespacesword.html#a82">OptionsList</a> options; +00074 <span class="keywordflow">return</span> options; +00075 } +00082 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setOptionValue (<span class="keyword">const</span> <span class="keywordtype">char</span> *) +00083 { +00084 } +00085 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * getOptionValue () +00086 { +00087 <span class="keywordflow">return</span> 0; +00088 } +00095 <span class="keyword">virtual</span> <span class="keywordtype">char</span> ProcessText(<span class="keywordtype">char</span> *text, <span class="keywordtype">int</span> maxlen, <span class="keyword">const</span> SWKey *, <span class="keyword">const</span> SWModule * = 0) +00096 { +00097 <span class="keywordflow">return</span> ProcessText(text, maxlen); +00098 } +00104 <span class="keyword">virtual</span> <span class="keywordtype">char</span> ProcessText(<span class="keywordtype">char</span> *text, <span class="keywordtype">int</span> maxlen = -1) +00105 { +00106 <span class="keywordflow">return</span> ProcessText(text, maxlen, 0); +00107 } +00108 }; +00109 +00110 SWORD_NAMESPACE_END +00111 <span class="preprocessor">#endif</span> +</pre></div><hr><address style="align: right;"><small>Generated on Thu Oct 31 12:11:28 2002 for The Sword Project by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 -width=110 height=53></a>1.2.15 </small></address> +width=110 height=53></a>1.2.17 </small></address> </body> </html> |