summaryrefslogtreecommitdiff
path: root/doc/api-documentation/html/class_gbfmorph.html
blob: c983c4ebc7c26d4651f8b66d538b1a2810d85c3d (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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
<!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>GBFMorph 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>GBFMorph  Class Reference</h1>This Filter shows/hides morph tags in a GBF text. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="gbfmorph_h-source.html">gbfmorph.h</a>&gt;</code>
<p>
<p>Inheritance diagram for GBFMorph::
<p><center><img src="class_gbfmorph.gif" usemap="#GBFMorph_map" border="0"></center>
<map name="GBFMorph_map">
<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,74,24">
</map>
<a href="class_gbfmorph-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="GBFMorph::GBFMorph"></a>
&nbsp;</td><td valign=bottom><b>GBFMorph</b> ()</td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="GBFMorph::~GBFMorph"></a>
virtual&nbsp;</td><td valign=bottom><b>~GBFMorph</b> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual char&nbsp;</td><td valign=bottom><a class="el" href="class_gbfmorph.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_gbfmorph.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_gbfmorph.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_gbfmorph.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_gbfmorph.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="GBFMorph::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_gbfmorph.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="GBFMorph::option"></a>
bool&nbsp;</td><td valign=bottom><b>option</b></td></tr>
<tr><td nowrap align=right valign=top><a name="o1" doxytag="GBFMorph::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="GBFMorph::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="GBFMorph::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="GBFMorph::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="GBFMorph::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 morph tags in a GBF text.
<p>

<p>
Definition at line <a class="el" href="gbfmorph_h-source.html#l00029">29</a> of file <a class="el" href="gbfmorph_h-source.html">gbfmorph.h</a>.<hr><h2>Member Function Documentation</h2>
<a name="a2" doxytag="GBFMorph::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 GBFMorph::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="GBFMorph::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 * GBFMorph::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="gbfmorph_h-source.html#l00041">41</a> of file <a class="el" href="gbfmorph_h-source.html">gbfmorph.h</a>.    </td>
  </tr>
</table>
<a name="a4" doxytag="GBFMorph::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 * GBFMorph::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="gbfmorph_h-source.html#l00045">45</a> of file <a class="el" href="gbfmorph_h-source.html">gbfmorph.h</a>.    </td>
  </tr>
</table>
<a name="a7" doxytag="GBFMorph::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 GBFMorph::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="gbfmorph_h-source.html#l00051">51</a> of file <a class="el" href="gbfmorph_h-source.html">gbfmorph.h</a>.    </td>
  </tr>
</table>
<a name="a5" doxytag="GBFMorph::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 GBFMorph::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_gbfmorph.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="gbfmorph_h-source.html">gbfmorph.h</a></ul>
<hr><address><small>Generated at Fri Oct 5 22:45:35 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>