aboutsummaryrefslogtreecommitdiffstats
path: root/doc/api-documentation/html/swfilter_8h-source.html
blob: 7eb7e7ae320787d36e3d086274c87980a6919e7d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>swfilter.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.17 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</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="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </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 <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 &lt;string&gt;</span>
00026 <span class="preprocessor">#include &lt;list&gt;</span>
00027 <span class="preprocessor">#include &lt;swkey.h&gt;</span>
00028 
00029 <span class="preprocessor">#include &lt;defs.h&gt;</span>
00030 
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 &lt; std::string &gt; <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 &lt; std::string &gt; 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.17 </small></address>
</body>
</html>