summaryrefslogtreecommitdiff
path: root/doc/api-documentation/html/swfilter.h-source.html
blob: ee74cc5c7b67933ca954e1db5bbc7e22b7c0ab65 (plain)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<title>swfilter.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 -->
<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>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.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg 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>
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 &lt;string&gt;</font>
00026 <font class="preprocessor">#include &lt;list&gt;</font>
00027 <font class="preprocessor">#include &lt;swkey.h&gt;</font>
00028 
00029 <font class="preprocessor">#include &lt;defs.h&gt;</font>
00030 
00034 <font class="keyword">typedef</font> std::list &lt; std::string &gt; OptionsList;
00035 
00036 
<a name="l00041"></a><a class="code" href="class_swfilter.html">00041</a> <font class="keyword">class </font>SWDLLEXPORT  <a class="code" href="class_swfilter.html">SWFilter</a> {
00042 <font class="keyword">public</font>:
00043        <font class="keyword">virtual</font> ~SWFilter()<font class="keyword"> </font>{}
00047 <font class="comment">//  typedef std::list &lt; std::string &gt; OptionsList;
</font><a name="l00051"></a><a class="code" href="class_swfilter.html#a1">00051</a> <font class="comment"></font>  <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> * <a class="code" href="class_swfilter.html#a1">getOptionName</a> ()<font class="keyword">
</font>00052 <font class="keyword">  </font>{
00053     <font class="keywordflow">return</font> 0;
00054   }
<a name="l00059"></a><a class="code" href="class_swfilter.html#a2">00059</a>   <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> * <a class="code" href="class_swfilter.html#a2">getOptionTip</a> ()<font class="keyword">
</font>00060 <font class="keyword">  </font>{
00061     <font class="keywordflow">return</font> 0;
00062   }
<a name="l00067"></a><a class="code" href="class_swfilter.html#a3">00067</a>   <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swfilter.html#a3">getOptionValues</a> ()<font class="keyword">
</font>00068 <font class="keyword">  </font>{
00069     OptionsList options;
00070     <font class="keywordflow">return</font> options;
00071   }
<a name="l00078"></a><a class="code" href="class_swfilter.html#a4">00078</a>   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swfilter.html#a4">setOptionValue</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *)<font class="keyword">
</font>00079 <font class="keyword">  </font>{
00080   }
00081   <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> * getOptionValue ()<font class="keyword">
</font>00082 <font class="keyword">  </font>{
00083     <font class="keywordflow">return</font> 0;
00084   }
<a name="l00091"></a><a class="code" href="class_swfilter.html#a6">00091</a>   <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a>(<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *)<font class="keyword">
</font>00092 <font class="keyword">  </font>{
00093     <font class="keywordflow">return</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a>(text, maxlen);
00094   }
<a name="l00100"></a><a class="code" href="class_swfilter.html#a7">00100</a>   <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a>(<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1)<font class="keyword">
</font>00101 <font class="keyword">  </font>{
00102     <font class="keywordflow">return</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a>(text, maxlen, 0);
00103   }
00104 };
00105 
00106 <font class="preprocessor">#endif
</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by
<a href="http://www.stack.nl/~dimitri/doxygen/index.html">
<img src="doxygen.gif" alt="doxygen" align=center border=0 
width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
 &copy; 1997-2000</small></address>
</body>
</html>