diff options
Diffstat (limited to 'doc/html/namespaceTypes.html')
| -rw-r--r-- | doc/html/namespaceTypes.html | 230 |
1 files changed, 230 insertions, 0 deletions
diff --git a/doc/html/namespaceTypes.html b/doc/html/namespaceTypes.html new file mode 100644 index 0000000..c4c4460 --- /dev/null +++ b/doc/html/namespaceTypes.html @@ -0,0 +1,230 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>kshowmail.kdevelop: Types Namespace Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.0 --> +<div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li id="current"><a href="namespaces.html"><span>Namespaces</span></a></li> + <li><a href="classes.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li><a href="dirs.html"><span>Directories</span></a></li> + </ul></div> +<div class="tabs"> + <ul> + <li><a href="namespaces.html"><span>Namespace List</span></a></li> + <li><a href="namespacemembers.html"><span>Namespace Members</span></a></li> + </ul></div> +<h1>Types Namespace Reference</h1> +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Classes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structTypes_1_1DownloadActionParams__Type.html">DownloadActionParams_Type</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structTypes_1_1FilterCriteria__Type.html">FilterCriteria_Type</a></td></tr> + +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef QValueList< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTypes.html#48fad16d3707caeaf47bb1e8fab4be55">MailNumberList_Type</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef QMap< QString, bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTypes.html#ca963e9ff87e4dfc99a0123af22c0346">AccountTaskMap_Type</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef QMap< int, <a class="el" href="structTypes_1_1DownloadActionParams__Type.html">DownloadActionParams_Type</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTypes.html#28b7da8de2bbe1b7a098d41242e78ab7">MailToDownloadMap_Type</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef list< <a class="el" href="structTypes_1_1FilterCriteria__Type.html">FilterCriteria_Type</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTypes.html#2eaafd5612933c2e6ab8dd15593969a2">FilterCriteriaList_Type</a></td></tr> + +<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTypes.html#dc227eb5720632a8290561b001aaa565">State_Type</a> { <br> + <a class="el" href="namespaceTypes.html#dc227eb5720632a8290561b001aaa565c37aa546c58cdb9c8efabbbe513f8380">idle</a>, +<a class="el" href="namespaceTypes.html#dc227eb5720632a8290561b001aaa565f49cd232f53f8851506c138924f2ec65">deleting</a>, +<a class="el" href="namespaceTypes.html#dc227eb5720632a8290561b001aaa5653cde4c681a768eef7df3659c849a34b6">configure</a>, +<a class="el" href="namespaceTypes.html#dc227eb5720632a8290561b001aaa56575f7f7187ee9497e63584b0ccb17a919">executing</a>, +<br> + <a class="el" href="namespaceTypes.html#dc227eb5720632a8290561b001aaa5655ee02dbb2bbc5f45a1a2517f7536c77c">showing</a>, +<a class="el" href="namespaceTypes.html#dc227eb5720632a8290561b001aaa56592bd813e8e24cdf9c233a4cf26ebb691">refreshing</a> +<br> + }</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTypes.html#57c868019acd102e855ff50f6043c1b6">AccountState_Type</a> { <a class="el" href="namespaceTypes.html#57c868019acd102e855ff50f6043c1b6a15826a259a1b9518c05738511bca3c7">AccountIdle</a>, +<a class="el" href="namespaceTypes.html#57c868019acd102e855ff50f6043c1b6c13599f1c51b33a59b319794917ccff5">AccountDeleting</a>, +<a class="el" href="namespaceTypes.html#57c868019acd102e855ff50f6043c1b63accada2afa1ad270e3b25c14cae5fd9">AccountDownloading</a>, +<a class="el" href="namespaceTypes.html#57c868019acd102e855ff50f6043c1b6ba5316f9cbdb41a05f75ebe4976865b9">AccountRefreshing</a> + }</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adf">FilterAction_Type</a> { <br> + <a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adf0e2f723024c86b001d2c0d50cc70e456">FActPass</a>, +<a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adf9de5e046888ae556dd3f4548957fcf10">FActDelete</a>, +<a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adf0b8c53628aabb517f41d6ccdf5bf5d4c">FActMark</a>, +<a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adf4f2a44934f9b85ed07832ccf32016462">FActMove</a>, +<br> + <a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adfc54805588ea5ecd697098c55a3ec73a1">FActSpamcheck</a>, +<a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adf6b838ac6d09fdaade0e40f4a50d33b68">FActIgnore</a>, +<a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adfb62372bfae14c67a307649aa9f2f7f34">FActNone</a> +<br> + }</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +All special types for KShowMail. +<p> +<hr><h2>Typedef Documentation</h2> +<a class="anchor" name="ca963e9ff87e4dfc99a0123af22c0346"></a><!-- doxytag: member="Types::AccountTaskMap_Type" ref="ca963e9ff87e4dfc99a0123af22c0346" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef QMap<QString, bool> <a class="el" href="namespaceTypes.html#ca963e9ff87e4dfc99a0123af22c0346">Types::AccountTaskMap_Type</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Map to notice which accounts need to get an order to do a task. The Key is the account name and the data a boolean. TRUE means the task was ordered, FALSE the task was ended. +</div> +</div><p> +<a class="anchor" name="2eaafd5612933c2e6ab8dd15593969a2"></a><!-- doxytag: member="Types::FilterCriteriaList_Type" ref="2eaafd5612933c2e6ab8dd15593969a2" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef list<<a class="el" href="structTypes_1_1FilterCriteria__Type.html">FilterCriteria_Type</a>> <a class="el" href="namespaceTypes.html#2eaafd5612933c2e6ab8dd15593969a2">Types::FilterCriteriaList_Type</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +List of filter criterias. +</div> +</div><p> +<a class="anchor" name="48fad16d3707caeaf47bb1e8fab4be55"></a><!-- doxytag: member="Types::MailNumberList_Type" ref="48fad16d3707caeaf47bb1e8fab4be55" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef QValueList<int> <a class="el" href="namespaceTypes.html#48fad16d3707caeaf47bb1e8fab4be55">Types::MailNumberList_Type</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +List of mail numbers. It is a QValueList of integers. +</div> +</div><p> +<a class="anchor" name="28b7da8de2bbe1b7a098d41242e78ab7"></a><!-- doxytag: member="Types::MailToDownloadMap_Type" ref="28b7da8de2bbe1b7a098d41242e78ab7" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef QMap<int, <a class="el" href="structTypes_1_1DownloadActionParams__Type.html">DownloadActionParams_Type</a>> <a class="el" href="namespaceTypes.html#28b7da8de2bbe1b7a098d41242e78ab7">Types::MailToDownloadMap_Type</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +This map is used by <a class="el" href="classConfigElem.html">ConfigElem</a> and <a class="el" href="classShowRecord.html">ShowRecord</a> to hold a list of mail numbers which shall be downloaded for some filter actions; at time for moving and spam check +</div> +</div><p> +<hr><h2>Enumeration Type Documentation</h2> +<a class="anchor" name="57c868019acd102e855ff50f6043c1b6"></a><!-- doxytag: member="Types::AccountState_Type" ref="57c868019acd102e855ff50f6043c1b6" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="namespaceTypes.html#57c868019acd102e855ff50f6043c1b6">Types::AccountState_Type</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +State of an account. <dl compact><dt><b>Enumerator: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="57c868019acd102e855ff50f6043c1b6a15826a259a1b9518c05738511bca3c7"></a><!-- doxytag: member="AccountIdle" ref="57c868019acd102e855ff50f6043c1b6a15826a259a1b9518c05738511bca3c7" args="" -->AccountIdle</em> </td><td> +it's doing nothing </td></tr> +<tr><td valign="top"><em><a class="anchor" name="57c868019acd102e855ff50f6043c1b6c13599f1c51b33a59b319794917ccff5"></a><!-- doxytag: member="AccountDeleting" ref="57c868019acd102e855ff50f6043c1b6c13599f1c51b33a59b319794917ccff5" args="" -->AccountDeleting</em> </td><td> +a deletion is running </td></tr> +<tr><td valign="top"><em><a class="anchor" name="57c868019acd102e855ff50f6043c1b63accada2afa1ad270e3b25c14cae5fd9"></a><!-- doxytag: member="AccountDownloading" ref="57c868019acd102e855ff50f6043c1b63accada2afa1ad270e3b25c14cae5fd9" args="" -->AccountDownloading</em> </td><td> +the account is downloading mail bodies </td></tr> +<tr><td valign="top"><em><a class="anchor" name="57c868019acd102e855ff50f6043c1b6ba5316f9cbdb41a05f75ebe4976865b9"></a><!-- doxytag: member="AccountRefreshing" ref="57c868019acd102e855ff50f6043c1b6ba5316f9cbdb41a05f75ebe4976865b9" args="" -->AccountRefreshing</em> </td><td> +the account is refreshing its mail list </td></tr> +</table> +</dl> + +</div> +</div><p> +<a class="anchor" name="ce032cf029e8037fd21721b33e3a6adf"></a><!-- doxytag: member="Types::FilterAction_Type" ref="ce032cf029e8037fd21721b33e3a6adf" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adf">Types::FilterAction_Type</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Actions returned by filters. <dl compact><dt><b>Enumerator: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="ce032cf029e8037fd21721b33e3a6adf0e2f723024c86b001d2c0d50cc70e456"></a><!-- doxytag: member="FActPass" ref="ce032cf029e8037fd21721b33e3a6adf0e2f723024c86b001d2c0d50cc70e456" args="" -->FActPass</em> </td><td> +Mail has passed the filter check. It can showed in the list. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="ce032cf029e8037fd21721b33e3a6adf9de5e046888ae556dd3f4548957fcf10"></a><!-- doxytag: member="FActDelete" ref="ce032cf029e8037fd21721b33e3a6adf9de5e046888ae556dd3f4548957fcf10" args="" -->FActDelete</em> </td><td> +Undesirable mail. Delete it. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="ce032cf029e8037fd21721b33e3a6adf0b8c53628aabb517f41d6ccdf5bf5d4c"></a><!-- doxytag: member="FActMark" ref="ce032cf029e8037fd21721b33e3a6adf0b8c53628aabb517f41d6ccdf5bf5d4c" args="" -->FActMark</em> </td><td> +Probably undesirable mail. Mark it in the mail list. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="ce032cf029e8037fd21721b33e3a6adf4f2a44934f9b85ed07832ccf32016462"></a><!-- doxytag: member="FActMove" ref="ce032cf029e8037fd21721b33e3a6adf4f2a44934f9b85ed07832ccf32016462" args="" -->FActMove</em> </td><td> +Move the mail to a certain mail box. The name of the box will returned by a further parameter. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="ce032cf029e8037fd21721b33e3a6adfc54805588ea5ecd697098c55a3ec73a1"></a><!-- doxytag: member="FActSpamcheck" ref="ce032cf029e8037fd21721b33e3a6adfc54805588ea5ecd697098c55a3ec73a1" args="" -->FActSpamcheck</em> </td><td> +This mail shall be forwared to a spam filter, which checks the whole mail including body. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="ce032cf029e8037fd21721b33e3a6adf6b838ac6d09fdaade0e40f4a50d33b68"></a><!-- doxytag: member="FActIgnore" ref="ce032cf029e8037fd21721b33e3a6adf6b838ac6d09fdaade0e40f4a50d33b68" args="" -->FActIgnore</em> </td><td> +This mail shall not be shown. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="ce032cf029e8037fd21721b33e3a6adfb62372bfae14c67a307649aa9f2f7f34"></a><!-- doxytag: member="FActNone" ref="ce032cf029e8037fd21721b33e3a6adfb62372bfae14c67a307649aa9f2f7f34" args="" -->FActNone</em> </td><td> +The mail doesn't match up with the filter. Perform the next one. </td></tr> +</table> +</dl> + +</div> +</div><p> +<a class="anchor" name="dc227eb5720632a8290561b001aaa565"></a><!-- doxytag: member="Types::State_Type" ref="dc227eb5720632a8290561b001aaa565" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="namespaceTypes.html#dc227eb5720632a8290561b001aaa565">Types::State_Type</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +State of the application during running time. <dl compact><dt><b>Enumerator: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="dc227eb5720632a8290561b001aaa565c37aa546c58cdb9c8efabbbe513f8380"></a><!-- doxytag: member="idle" ref="dc227eb5720632a8290561b001aaa565c37aa546c58cdb9c8efabbbe513f8380" args="" -->idle</em> </td><td> +it's doing nothing </td></tr> +<tr><td valign="top"><em><a class="anchor" name="dc227eb5720632a8290561b001aaa565f49cd232f53f8851506c138924f2ec65"></a><!-- doxytag: member="deleting" ref="dc227eb5720632a8290561b001aaa565f49cd232f53f8851506c138924f2ec65" args="" -->deleting</em> </td><td> +it's deleting a message on the server </td></tr> +<tr><td valign="top"><em><a class="anchor" name="dc227eb5720632a8290561b001aaa5653cde4c681a768eef7df3659c849a34b6"></a><!-- doxytag: member="configure" ref="dc227eb5720632a8290561b001aaa5653cde4c681a768eef7df3659c849a34b6" args="" -->configure</em> </td><td> +the user is configuring the application or the mail or just the header of the mail is being shown </td></tr> +<tr><td valign="top"><em><a class="anchor" name="dc227eb5720632a8290561b001aaa56575f7f7187ee9497e63584b0ccb17a919"></a><!-- doxytag: member="executing" ref="dc227eb5720632a8290561b001aaa56575f7f7187ee9497e63584b0ccb17a919" args="" -->executing</em> </td><td> +a command on the command list is being executed </td></tr> +<tr><td valign="top"><em><a class="anchor" name="dc227eb5720632a8290561b001aaa5655ee02dbb2bbc5f45a1a2517f7536c77c"></a><!-- doxytag: member="showing" ref="dc227eb5720632a8290561b001aaa5655ee02dbb2bbc5f45a1a2517f7536c77c" args="" -->showing</em> </td><td> +it's downloading and showing a mail </td></tr> +<tr><td valign="top"><em><a class="anchor" name="dc227eb5720632a8290561b001aaa56592bd813e8e24cdf9c233a4cf26ebb691"></a><!-- doxytag: member="refreshing" ref="dc227eb5720632a8290561b001aaa56592bd813e8e24cdf9c233a4cf26ebb691" args="" -->refreshing</em> </td><td> +it's refreshing the mail lists </td></tr> +</table> +</dl> + +</div> +</div><p> +<hr size="1"><address style="align: right;"><small>Generated on Tue Apr 1 21:59:50 2008 for kshowmail.kdevelop by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address> +</body> +</html> |