/[debian]/fullquottel/branches/upstream/current/doc_programmer/html/structOptions.html
ViewVC logotype

Contents of /fullquottel/branches/upstream/current/doc_programmer/html/structOptions.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 120 - (show annotations)
Sat Feb 25 16:41:21 2006 UTC (15 years, 3 months ago) by gregoa
File MIME type: text/html
File size: 15360 byte(s)
[svn-inject] Installing original source of fullquottel
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>fullquottel: Options Struct Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.4.4 -->
7 <div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
8 <h1>Options Struct Reference</h1><!-- doxytag: class="Options" -->Structure to store the program options.
9 <a href="#_details">More...</a>
10 <p>
11 <a href="structOptions-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
12 <tr><td></td></tr>
13 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
14 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#a0">Options</a> ()</td></tr>
15
16 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the constructor initializes the options with their default values. <a href="#a0"></a><br></td></tr>
17 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
18 <tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#o0">scoreThreshold</a></td></tr>
19
20 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Threshold of the added scores of the tests, that decide, whether the mail is a tofu mail or not (default: 0.5). <a href="#o0"></a><br></td></tr>
21 <tr><td class="memItemLeft" nowrap align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#o1">quoteChars</a></td></tr>
22
23 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Character(s) that are used to quote. The default value is "&gt;|#". <a href="#o1"></a><br></td></tr>
24 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#o2">debug</a></td></tr>
25
26 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If this option is set, the internal variables that show the mail statistics are print (default: false). <a href="#o2"></a><br></td></tr>
27 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="fullquottel_8cpp.html#a3">TextLines</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#o3">attributionLines</a></td></tr>
28
29 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">List of Microsoft Attribution Lines (needed for the <a class="el" href="index.html#doc_msTest">Microsoft Attribution Line Test (msTest)</a>). <a href="#o3"></a><br></td></tr>
30 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structSigRating.html">SigRating</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#o4">ownSigTest</a></td></tr>
31
32 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Signature filename and rating options for the <a class="el" href="index.html#doc_ownSigTest">Own Signature Test (ownSigTest)</a> (default: ~/.signature). <a href="#o4"></a><br></td></tr>
33 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structIntegerRating.html">IntegerRating</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#o5">msTest</a></td></tr>
34
35 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Rating options for the <a class="el" href="index.html#doc_msTest">Microsoft Attribution Line Test (msTest)</a>. <a href="#o5"></a><br></td></tr>
36 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structRatioRating.html">RatioRating</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#o6">quotedToAllTest</a></td></tr>
37
38 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Rating options for the <a class="el" href="index.html#doc_quotedToAllTest">Ratio Quoted Lines To All Lines Test (quotedToAllTest)</a>. <a href="#o6"></a><br></td></tr>
39 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structRatioRating.html">RatioRating</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#o7">bottomQuotedToAllTest</a></td></tr>
40
41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Rating options for the <a class="el" href="index.html#doc_bottomQuotedToAllTest">Ratio Quoted Lines At Bottom Of The Mail To All Lines Test (bottomQuotedToAllTest)</a>. <a href="#o7"></a><br></td></tr>
42 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structRatioRating.html">RatioRating</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#o8">bottomQuotedToQuotedTest</a></td></tr>
43
44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Rating options for the <a class="el" href="index.html#doc_bottomQuotedToQuotedTest">Ratio Quoted Lines At Bottom Of The Mail To Quoted Lines Test (bottomQuotedToQuotedTest)</a>. <a href="#o8"></a><br></td></tr>
45 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structBoolRating.html">BoolRating</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#o9">singleBottomQuoteTest</a></td></tr>
46
47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Rating options for the <a class="el" href="index.html#doc_singleBottomQuoteTest">Single Quote Block At The Bottom of The Mail Test (mailSingleBottomQuote)</a>. <a href="#o9"></a><br></td></tr>
48 </table>
49 <hr><a name="_details"></a><h2>Detailed Description</h2>
50 Structure to store the program options.
51 <p>
52 It stores all options and parameters that are needed to run the program. The command line options, system wide file options, and user file options are transfered within this struct and after that, only this struct is used to access the options.
53 <p>
54 <hr><h2>Constructor &amp; Destructor Documentation</h2>
55 <a class="anchor" name="a0"></a><!-- doxytag: member="Options::Options" ref="a0" args="()" --><p>
56 <table class="mdTable" cellpadding="2" cellspacing="0">
57 <tr>
58 <td class="mdRow">
59 <table cellpadding="0" cellspacing="0" border="0">
60 <tr>
61 <td class="md" nowrap valign="top">Options::Options </td>
62 <td class="md" valign="top">(&nbsp;</td>
63 <td class="mdname1" valign="top" nowrap> </td>
64 <td class="md" valign="top">&nbsp;)&nbsp;</td>
65 <td class="md" nowrap></td>
66 </tr>
67 </table>
68 </td>
69 </tr>
70 </table>
71 <table cellspacing="5" cellpadding="0" border="0">
72 <tr>
73 <td>
74 &nbsp;
75 </td>
76 <td>
77
78 <p>
79 the constructor initializes the options with their default values.
80 <p>
81 </td>
82 </tr>
83 </table>
84 <hr><h2>Member Data Documentation</h2>
85 <a class="anchor" name="o0"></a><!-- doxytag: member="Options::scoreThreshold" ref="o0" args="" --><p>
86 <table class="mdTable" cellpadding="2" cellspacing="0">
87 <tr>
88 <td class="mdRow">
89 <table cellpadding="0" cellspacing="0" border="0">
90 <tr>
91 <td class="md" nowrap valign="top">double <a class="el" href="structOptions.html#o0">Options::scoreThreshold</a> </td>
92 </tr>
93 </table>
94 </td>
95 </tr>
96 </table>
97 <table cellspacing="5" cellpadding="0" border="0">
98 <tr>
99 <td>
100 &nbsp;
101 </td>
102 <td>
103
104 <p>
105 Threshold of the added scores of the tests, that decide, whether the mail is a tofu mail or not (default: 0.5).
106 <p>
107 </td>
108 </tr>
109 </table>
110 <a class="anchor" name="o1"></a><!-- doxytag: member="Options::quoteChars" ref="o1" args="" --><p>
111 <table class="mdTable" cellpadding="2" cellspacing="0">
112 <tr>
113 <td class="mdRow">
114 <table cellpadding="0" cellspacing="0" border="0">
115 <tr>
116 <td class="md" nowrap valign="top">string <a class="el" href="structOptions.html#o1">Options::quoteChars</a> </td>
117 </tr>
118 </table>
119 </td>
120 </tr>
121 </table>
122 <table cellspacing="5" cellpadding="0" border="0">
123 <tr>
124 <td>
125 &nbsp;
126 </td>
127 <td>
128
129 <p>
130 Character(s) that are used to quote. The default value is "&gt;|#".
131 <p>
132 </td>
133 </tr>
134 </table>
135 <a class="anchor" name="o2"></a><!-- doxytag: member="Options::debug" ref="o2" args="" --><p>
136 <table class="mdTable" cellpadding="2" cellspacing="0">
137 <tr>
138 <td class="mdRow">
139 <table cellpadding="0" cellspacing="0" border="0">
140 <tr>
141 <td class="md" nowrap valign="top">bool <a class="el" href="structOptions.html#o2">Options::debug</a> </td>
142 </tr>
143 </table>
144 </td>
145 </tr>
146 </table>
147 <table cellspacing="5" cellpadding="0" border="0">
148 <tr>
149 <td>
150 &nbsp;
151 </td>
152 <td>
153
154 <p>
155 If this option is set, the internal variables that show the mail statistics are print (default: false).
156 <p>
157 </td>
158 </tr>
159 </table>
160 <a class="anchor" name="o3"></a><!-- doxytag: member="Options::attributionLines" ref="o3" args="" --><p>
161 <table class="mdTable" cellpadding="2" cellspacing="0">
162 <tr>
163 <td class="mdRow">
164 <table cellpadding="0" cellspacing="0" border="0">
165 <tr>
166 <td class="md" nowrap valign="top"><a class="el" href="fullquottel_8cpp.html#a3">TextLines</a> <a class="el" href="structOptions.html#o3">Options::attributionLines</a> </td>
167 </tr>
168 </table>
169 </td>
170 </tr>
171 </table>
172 <table cellspacing="5" cellpadding="0" border="0">
173 <tr>
174 <td>
175 &nbsp;
176 </td>
177 <td>
178
179 <p>
180 List of Microsoft Attribution Lines (needed for the <a class="el" href="index.html#doc_msTest">Microsoft Attribution Line Test (msTest)</a>).
181 <p>
182 </td>
183 </tr>
184 </table>
185 <a class="anchor" name="o4"></a><!-- doxytag: member="Options::ownSigTest" ref="o4" args="" --><p>
186 <table class="mdTable" cellpadding="2" cellspacing="0">
187 <tr>
188 <td class="mdRow">
189 <table cellpadding="0" cellspacing="0" border="0">
190 <tr>
191 <td class="md" nowrap valign="top"><a class="el" href="structSigRating.html">SigRating</a> <a class="el" href="structOptions.html#o4">Options::ownSigTest</a> </td>
192 </tr>
193 </table>
194 </td>
195 </tr>
196 </table>
197 <table cellspacing="5" cellpadding="0" border="0">
198 <tr>
199 <td>
200 &nbsp;
201 </td>
202 <td>
203
204 <p>
205 Signature filename and rating options for the <a class="el" href="index.html#doc_ownSigTest">Own Signature Test (ownSigTest)</a> (default: ~/.signature).
206 <p>
207 </td>
208 </tr>
209 </table>
210 <a class="anchor" name="o5"></a><!-- doxytag: member="Options::msTest" ref="o5" args="" --><p>
211 <table class="mdTable" cellpadding="2" cellspacing="0">
212 <tr>
213 <td class="mdRow">
214 <table cellpadding="0" cellspacing="0" border="0">
215 <tr>
216 <td class="md" nowrap valign="top"><a class="el" href="structIntegerRating.html">IntegerRating</a> <a class="el" href="structOptions.html#o5">Options::msTest</a> </td>
217 </tr>
218 </table>
219 </td>
220 </tr>
221 </table>
222 <table cellspacing="5" cellpadding="0" border="0">
223 <tr>
224 <td>
225 &nbsp;
226 </td>
227 <td>
228
229 <p>
230 Rating options for the <a class="el" href="index.html#doc_msTest">Microsoft Attribution Line Test (msTest)</a>.
231 <p>
232 </td>
233 </tr>
234 </table>
235 <a class="anchor" name="o6"></a><!-- doxytag: member="Options::quotedToAllTest" ref="o6" args="" --><p>
236 <table class="mdTable" cellpadding="2" cellspacing="0">
237 <tr>
238 <td class="mdRow">
239 <table cellpadding="0" cellspacing="0" border="0">
240 <tr>
241 <td class="md" nowrap valign="top"><a class="el" href="structRatioRating.html">RatioRating</a> <a class="el" href="structOptions.html#o6">Options::quotedToAllTest</a> </td>
242 </tr>
243 </table>
244 </td>
245 </tr>
246 </table>
247 <table cellspacing="5" cellpadding="0" border="0">
248 <tr>
249 <td>
250 &nbsp;
251 </td>
252 <td>
253
254 <p>
255 Rating options for the <a class="el" href="index.html#doc_quotedToAllTest">Ratio Quoted Lines To All Lines Test (quotedToAllTest)</a>.
256 <p>
257 </td>
258 </tr>
259 </table>
260 <a class="anchor" name="o7"></a><!-- doxytag: member="Options::bottomQuotedToAllTest" ref="o7" args="" --><p>
261 <table class="mdTable" cellpadding="2" cellspacing="0">
262 <tr>
263 <td class="mdRow">
264 <table cellpadding="0" cellspacing="0" border="0">
265 <tr>
266 <td class="md" nowrap valign="top"><a class="el" href="structRatioRating.html">RatioRating</a> <a class="el" href="structOptions.html#o7">Options::bottomQuotedToAllTest</a> </td>
267 </tr>
268 </table>
269 </td>
270 </tr>
271 </table>
272 <table cellspacing="5" cellpadding="0" border="0">
273 <tr>
274 <td>
275 &nbsp;
276 </td>
277 <td>
278
279 <p>
280 Rating options for the <a class="el" href="index.html#doc_bottomQuotedToAllTest">Ratio Quoted Lines At Bottom Of The Mail To All Lines Test (bottomQuotedToAllTest)</a>.
281 <p>
282 </td>
283 </tr>
284 </table>
285 <a class="anchor" name="o8"></a><!-- doxytag: member="Options::bottomQuotedToQuotedTest" ref="o8" args="" --><p>
286 <table class="mdTable" cellpadding="2" cellspacing="0">
287 <tr>
288 <td class="mdRow">
289 <table cellpadding="0" cellspacing="0" border="0">
290 <tr>
291 <td class="md" nowrap valign="top"><a class="el" href="structRatioRating.html">RatioRating</a> <a class="el" href="structOptions.html#o8">Options::bottomQuotedToQuotedTest</a> </td>
292 </tr>
293 </table>
294 </td>
295 </tr>
296 </table>
297 <table cellspacing="5" cellpadding="0" border="0">
298 <tr>
299 <td>
300 &nbsp;
301 </td>
302 <td>
303
304 <p>
305 Rating options for the <a class="el" href="index.html#doc_bottomQuotedToQuotedTest">Ratio Quoted Lines At Bottom Of The Mail To Quoted Lines Test (bottomQuotedToQuotedTest)</a>.
306 <p>
307 </td>
308 </tr>
309 </table>
310 <a class="anchor" name="o9"></a><!-- doxytag: member="Options::singleBottomQuoteTest" ref="o9" args="" --><p>
311 <table class="mdTable" cellpadding="2" cellspacing="0">
312 <tr>
313 <td class="mdRow">
314 <table cellpadding="0" cellspacing="0" border="0">
315 <tr>
316 <td class="md" nowrap valign="top"><a class="el" href="structBoolRating.html">BoolRating</a> <a class="el" href="structOptions.html#o9">Options::singleBottomQuoteTest</a> </td>
317 </tr>
318 </table>
319 </td>
320 </tr>
321 </table>
322 <table cellspacing="5" cellpadding="0" border="0">
323 <tr>
324 <td>
325 &nbsp;
326 </td>
327 <td>
328
329 <p>
330 Rating options for the <a class="el" href="index.html#doc_singleBottomQuoteTest">Single Quote Block At The Bottom of The Mail Test (mailSingleBottomQuote)</a>.
331 <p>
332 </td>
333 </tr>
334 </table>
335 <hr>The documentation for this struct was generated from the following file:<ul>
336 <li><a class="el" href="fullquottel_8cpp.html">fullquottel.cpp</a></ul>
337 <hr size="1"><address style="align: right;"><small>Generated on Fri Sep 2 16:27:02 2005 for fullquottel by&nbsp;
338 <a href="http://www.doxygen.org/index.html">
339 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4 </small></address>
340 </body>
341 </html>

  ViewVC Help
Powered by ViewVC 1.1.26