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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 695 - (hide annotations)
Sun Apr 1 22:06:28 2007 UTC (14 years, 4 months ago) by gregoa
File MIME type: text/html
File size: 15007 byte(s)
[svn-upgrade] Integrating new upstream version, fullquottel (0.1.2)
1 gregoa 120 <!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 gregoa 695 <link href="tabs.css" rel="stylesheet" type="text/css">
6 gregoa 120 </head><body>
7 gregoa 695 <!-- Generated by Doxygen 1.5.1 -->
8     <div class="tabs">
9     <ul>
10     <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11     <li><a href="namespaces.html"><span>Namespaces</span></a></li>
12     <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
13     <li><a href="files.html"><span>Files</span></a></li>
14     </ul></div>
15     <div class="tabs">
16     <ul>
17     <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
18     <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
19     <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
20     </ul></div>
21 gregoa 120 <h1>Options Struct Reference</h1><!-- doxytag: class="Options" -->Structure to store the program options.
22     <a href="#_details">More...</a>
23     <p>
24     <a href="structOptions-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
25     <tr><td></td></tr>
26     <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
27 gregoa 695 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#b72fb640172a6109e34c8a5366563753">Options</a> ()</td></tr>
28 gregoa 120
29 gregoa 695 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the constructor initializes the options with their default values. <a href="#b72fb640172a6109e34c8a5366563753"></a><br></td></tr>
30 gregoa 120 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
31 gregoa 695 <tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#f83a903df203c52330bbf08c4f806e79">scoreThreshold</a></td></tr>
32 gregoa 120
33 gregoa 695 <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="#f83a903df203c52330bbf08c4f806e79"></a><br></td></tr>
34     <tr><td class="memItemLeft" nowrap align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#fb21fbcb9dd29da17ddebe161ed6fba8">quoteChars</a></td></tr>
35 gregoa 120
36 gregoa 695 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Character(s) that are used to quote. The default value is "&gt;|#". <a href="#fb21fbcb9dd29da17ddebe161ed6fba8"></a><br></td></tr>
37     <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#2659b52db8688c4975db64de2601a13b">debug</a></td></tr>
38 gregoa 120
39 gregoa 695 <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="#2659b52db8688c4975db64de2601a13b"></a><br></td></tr>
40     <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="fullquottel_8cpp.html#c5f732bfa685eef86e748807e9295e1c">TextLines</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#c379c5023df0e03d841436c38560bff0">attributionLines</a></td></tr>
41 gregoa 120
42 gregoa 695 <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="#c379c5023df0e03d841436c38560bff0"></a><br></td></tr>
43     <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#fd7c803a9ce0fa91678fe312ba4011f8">ownSigTest</a></td></tr>
44 gregoa 120
45 gregoa 695 <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="#fd7c803a9ce0fa91678fe312ba4011f8"></a><br></td></tr>
46     <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#1b01b0d73e2c905120e95e96caabfe27">msTest</a></td></tr>
47 gregoa 120
48 gregoa 695 <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="#1b01b0d73e2c905120e95e96caabfe27"></a><br></td></tr>
49     <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#625435077e0760c8f484b1f4109314d9">quotedToAllTest</a></td></tr>
50 gregoa 120
51 gregoa 695 <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="#625435077e0760c8f484b1f4109314d9"></a><br></td></tr>
52     <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#75852fb51d45dd48c139deb58c6af336">bottomQuotedToAllTest</a></td></tr>
53 gregoa 120
54 gregoa 695 <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="#75852fb51d45dd48c139deb58c6af336"></a><br></td></tr>
55     <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#6e4841f3f5a6c0f3ef48287ff19f45ee">bottomQuotedToQuotedTest</a></td></tr>
56 gregoa 120
57 gregoa 695 <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="#6e4841f3f5a6c0f3ef48287ff19f45ee"></a><br></td></tr>
58     <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#df91188c340583fffc590cd9d1d63369">singleBottomQuoteTest</a></td></tr>
59 gregoa 120
60 gregoa 695 <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="#df91188c340583fffc590cd9d1d63369"></a><br></td></tr>
61 gregoa 120 </table>
62     <hr><a name="_details"></a><h2>Detailed Description</h2>
63     Structure to store the program options.
64     <p>
65     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.
66     <p>
67     <hr><h2>Constructor &amp; Destructor Documentation</h2>
68 gregoa 695 <a class="anchor" name="b72fb640172a6109e34c8a5366563753"></a><!-- doxytag: member="Options::Options" ref="b72fb640172a6109e34c8a5366563753" args="()" -->
69     <div class="memitem">
70     <div class="memproto">
71     <table class="memname">
72 gregoa 120 <tr>
73 gregoa 695 <td class="memname">Options::Options </td>
74     <td>(</td>
75     <td class="paramname"> </td>
76     <td>&nbsp;)&nbsp;</td>
77     <td width="100%"></td>
78 gregoa 120 </tr>
79     </table>
80 gregoa 695 </div>
81     <div class="memdoc">
82 gregoa 120
83     <p>
84     the constructor initializes the options with their default values.
85     <p>
86 gregoa 695
87     </div>
88     </div><p>
89 gregoa 120 <hr><h2>Member Data Documentation</h2>
90 gregoa 695 <a class="anchor" name="f83a903df203c52330bbf08c4f806e79"></a><!-- doxytag: member="Options::scoreThreshold" ref="f83a903df203c52330bbf08c4f806e79" args="" -->
91     <div class="memitem">
92     <div class="memproto">
93     <table class="memname">
94 gregoa 120 <tr>
95 gregoa 695 <td class="memname">double <a class="el" href="structOptions.html#f83a903df203c52330bbf08c4f806e79">Options::scoreThreshold</a> </td>
96 gregoa 120 </tr>
97     </table>
98 gregoa 695 </div>
99     <div class="memdoc">
100 gregoa 120
101     <p>
102     Threshold of the added scores of the tests, that decide, whether the mail is a tofu mail or not (default: 0.5).
103     <p>
104 gregoa 695
105     </div>
106     </div><p>
107     <a class="anchor" name="fb21fbcb9dd29da17ddebe161ed6fba8"></a><!-- doxytag: member="Options::quoteChars" ref="fb21fbcb9dd29da17ddebe161ed6fba8" args="" -->
108     <div class="memitem">
109     <div class="memproto">
110     <table class="memname">
111 gregoa 120 <tr>
112 gregoa 695 <td class="memname">string <a class="el" href="structOptions.html#fb21fbcb9dd29da17ddebe161ed6fba8">Options::quoteChars</a> </td>
113 gregoa 120 </tr>
114     </table>
115 gregoa 695 </div>
116     <div class="memdoc">
117 gregoa 120
118     <p>
119     Character(s) that are used to quote. The default value is "&gt;|#".
120     <p>
121 gregoa 695
122     </div>
123     </div><p>
124     <a class="anchor" name="2659b52db8688c4975db64de2601a13b"></a><!-- doxytag: member="Options::debug" ref="2659b52db8688c4975db64de2601a13b" args="" -->
125     <div class="memitem">
126     <div class="memproto">
127     <table class="memname">
128 gregoa 120 <tr>
129 gregoa 695 <td class="memname">bool <a class="el" href="structOptions.html#2659b52db8688c4975db64de2601a13b">Options::debug</a> </td>
130 gregoa 120 </tr>
131     </table>
132 gregoa 695 </div>
133     <div class="memdoc">
134 gregoa 120
135     <p>
136     If this option is set, the internal variables that show the mail statistics are print (default: false).
137     <p>
138 gregoa 695
139     </div>
140     </div><p>
141     <a class="anchor" name="c379c5023df0e03d841436c38560bff0"></a><!-- doxytag: member="Options::attributionLines" ref="c379c5023df0e03d841436c38560bff0" args="" -->
142     <div class="memitem">
143     <div class="memproto">
144     <table class="memname">
145 gregoa 120 <tr>
146 gregoa 695 <td class="memname"><a class="el" href="fullquottel_8cpp.html#c5f732bfa685eef86e748807e9295e1c">TextLines</a> <a class="el" href="structOptions.html#c379c5023df0e03d841436c38560bff0">Options::attributionLines</a> </td>
147 gregoa 120 </tr>
148     </table>
149 gregoa 695 </div>
150     <div class="memdoc">
151 gregoa 120
152     <p>
153     List of Microsoft Attribution Lines (needed for the <a class="el" href="index.html#doc_msTest">Microsoft Attribution Line Test (msTest)</a>).
154     <p>
155 gregoa 695
156     </div>
157     </div><p>
158     <a class="anchor" name="fd7c803a9ce0fa91678fe312ba4011f8"></a><!-- doxytag: member="Options::ownSigTest" ref="fd7c803a9ce0fa91678fe312ba4011f8" args="" -->
159     <div class="memitem">
160     <div class="memproto">
161     <table class="memname">
162 gregoa 120 <tr>
163 gregoa 695 <td class="memname"><a class="el" href="structSigRating.html">SigRating</a> <a class="el" href="structOptions.html#fd7c803a9ce0fa91678fe312ba4011f8">Options::ownSigTest</a> </td>
164 gregoa 120 </tr>
165     </table>
166 gregoa 695 </div>
167     <div class="memdoc">
168 gregoa 120
169     <p>
170     Signature filename and rating options for the <a class="el" href="index.html#doc_ownSigTest">Own Signature Test (ownSigTest)</a> (default: ~/.signature).
171     <p>
172 gregoa 695
173     </div>
174     </div><p>
175     <a class="anchor" name="1b01b0d73e2c905120e95e96caabfe27"></a><!-- doxytag: member="Options::msTest" ref="1b01b0d73e2c905120e95e96caabfe27" args="" -->
176     <div class="memitem">
177     <div class="memproto">
178     <table class="memname">
179 gregoa 120 <tr>
180 gregoa 695 <td class="memname"><a class="el" href="structIntegerRating.html">IntegerRating</a> <a class="el" href="structOptions.html#1b01b0d73e2c905120e95e96caabfe27">Options::msTest</a> </td>
181 gregoa 120 </tr>
182     </table>
183 gregoa 695 </div>
184     <div class="memdoc">
185 gregoa 120
186     <p>
187     Rating options for the <a class="el" href="index.html#doc_msTest">Microsoft Attribution Line Test (msTest)</a>.
188     <p>
189 gregoa 695
190     </div>
191     </div><p>
192     <a class="anchor" name="625435077e0760c8f484b1f4109314d9"></a><!-- doxytag: member="Options::quotedToAllTest" ref="625435077e0760c8f484b1f4109314d9" args="" -->
193     <div class="memitem">
194     <div class="memproto">
195     <table class="memname">
196 gregoa 120 <tr>
197 gregoa 695 <td class="memname"><a class="el" href="structRatioRating.html">RatioRating</a> <a class="el" href="structOptions.html#625435077e0760c8f484b1f4109314d9">Options::quotedToAllTest</a> </td>
198 gregoa 120 </tr>
199     </table>
200 gregoa 695 </div>
201     <div class="memdoc">
202 gregoa 120
203     <p>
204     Rating options for the <a class="el" href="index.html#doc_quotedToAllTest">Ratio Quoted Lines To All Lines Test (quotedToAllTest)</a>.
205     <p>
206 gregoa 695
207     </div>
208     </div><p>
209     <a class="anchor" name="75852fb51d45dd48c139deb58c6af336"></a><!-- doxytag: member="Options::bottomQuotedToAllTest" ref="75852fb51d45dd48c139deb58c6af336" args="" -->
210     <div class="memitem">
211     <div class="memproto">
212     <table class="memname">
213 gregoa 120 <tr>
214 gregoa 695 <td class="memname"><a class="el" href="structRatioRating.html">RatioRating</a> <a class="el" href="structOptions.html#75852fb51d45dd48c139deb58c6af336">Options::bottomQuotedToAllTest</a> </td>
215 gregoa 120 </tr>
216     </table>
217 gregoa 695 </div>
218     <div class="memdoc">
219 gregoa 120
220     <p>
221     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>.
222     <p>
223 gregoa 695
224     </div>
225     </div><p>
226     <a class="anchor" name="6e4841f3f5a6c0f3ef48287ff19f45ee"></a><!-- doxytag: member="Options::bottomQuotedToQuotedTest" ref="6e4841f3f5a6c0f3ef48287ff19f45ee" args="" -->
227     <div class="memitem">
228     <div class="memproto">
229     <table class="memname">
230 gregoa 120 <tr>
231 gregoa 695 <td class="memname"><a class="el" href="structRatioRating.html">RatioRating</a> <a class="el" href="structOptions.html#6e4841f3f5a6c0f3ef48287ff19f45ee">Options::bottomQuotedToQuotedTest</a> </td>
232 gregoa 120 </tr>
233     </table>
234 gregoa 695 </div>
235     <div class="memdoc">
236 gregoa 120
237     <p>
238     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>.
239     <p>
240 gregoa 695
241     </div>
242     </div><p>
243     <a class="anchor" name="df91188c340583fffc590cd9d1d63369"></a><!-- doxytag: member="Options::singleBottomQuoteTest" ref="df91188c340583fffc590cd9d1d63369" args="" -->
244     <div class="memitem">
245     <div class="memproto">
246     <table class="memname">
247 gregoa 120 <tr>
248 gregoa 695 <td class="memname"><a class="el" href="structBoolRating.html">BoolRating</a> <a class="el" href="structOptions.html#df91188c340583fffc590cd9d1d63369">Options::singleBottomQuoteTest</a> </td>
249 gregoa 120 </tr>
250     </table>
251 gregoa 695 </div>
252     <div class="memdoc">
253 gregoa 120
254     <p>
255     Rating options for the <a class="el" href="index.html#doc_singleBottomQuoteTest">Single Quote Block At The Bottom of The Mail Test (mailSingleBottomQuote)</a>.
256     <p>
257 gregoa 695
258     </div>
259     </div><p>
260 gregoa 120 <hr>The documentation for this struct was generated from the following file:<ul>
261     <li><a class="el" href="fullquottel_8cpp.html">fullquottel.cpp</a></ul>
262 gregoa 695 <hr size="1"><address style="align: right;"><small>Generated on Mon Apr 2 00:02:38 2007 for fullquottel by&nbsp;
263 gregoa 120 <a href="http://www.doxygen.org/index.html">
264 gregoa 695 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
265 gregoa 120 </body>
266     </html>

  ViewVC Help
Powered by ViewVC 1.1.26