yetangitu/deltachat-core
1
0
Fork 0
mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-05 02:29:28 +02:00
Code Issues Releases Wiki Activity

doxygen

Browse source
This commit is contained in:
B. Petersen 2018-01-08 21:48:17 +01:00
parent b23759e06e
commit 2dd616d1e7
51 changed files with 853 additions and 7323 deletions
Download patch file Download diff file Expand all files Collapse all files

36
docs/html/mrevent_8h.html
View file

@ -92,7 +92,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div><!--header-->
<div class="contents">
<p>The following constants are used as events reported to the callback given to <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>.
<p>The following constants are used as events reported to the callback given to <a class="el" href="classmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>.
<a href="#details">More...</a></p>
<p><a href="mrevent_8h_source.html">Go to the source code of this file.</a></p>
@ -103,7 +103,7 @@ Macros</h2></td></tr>
<tr class="memdesc:abc46d188d1a1a25c92433aa05568e23b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The user may write an informational string to the log. <a href="#abc46d188d1a1a25c92433aa05568e23b">More...</a><br /></td></tr>
<tr class="separator:abc46d188d1a1a25c92433aa05568e23b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa124fce3009b0cf018f49b69b76bce55"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#aa124fce3009b0cf018f49b69b76bce55">MR_EVENT_WARNING</a>&#160;&#160;&#160;300</td></tr>
<tr class="memdesc:aa124fce3009b0cf018f49b69b76bce55"><td class="mdescLeft">&#160;</td><td class="mdescRight">The user should write an warning string to the log. <a href="#aa124fce3009b0cf018f49b69b76bce55">More...</a><br /></td></tr>
<tr class="memdesc:aa124fce3009b0cf018f49b69b76bce55"><td class="mdescLeft">&#160;</td><td class="mdescRight">The user should write a warning string to the log. <a href="#aa124fce3009b0cf018f49b69b76bce55">More...</a><br /></td></tr>
<tr class="separator:aa124fce3009b0cf018f49b69b76bce55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7088b24d6d49fee42d6b83360bf1fcca"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a7088b24d6d49fee42d6b83360bf1fcca">MR_EVENT_ERROR</a>&#160;&#160;&#160;400</td></tr>
<tr class="memdesc:a7088b24d6d49fee42d6b83360bf1fcca"><td class="mdescLeft">&#160;</td><td class="mdescRight">The user should show an error. <a href="#a7088b24d6d49fee42d6b83360bf1fcca">More...</a><br /></td></tr>
@ -115,7 +115,7 @@ Macros</h2></td></tr>
<tr class="memdesc:a548525a9d4cc03cd240ca6dda4246ae8"><td class="mdescLeft">&#160;</td><td class="mdescRight">There is a fresh message. <a href="#a548525a9d4cc03cd240ca6dda4246ae8">More...</a><br /></td></tr>
<tr class="separator:a548525a9d4cc03cd240ca6dda4246ae8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10c4a8b6fa9014e5725e3a1daadf301b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a10c4a8b6fa9014e5725e3a1daadf301b">MR_EVENT_MSG_DELIVERED</a>&#160;&#160;&#160;2010</td></tr>
<tr class="memdesc:a10c4a8b6fa9014e5725e3a1daadf301b"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single message is send successfully (state changed from MR_STATE_OUT_PENDING to MR_STATE_OUT_DELIVERED, see mrmsg_t::m_state). <a href="#a10c4a8b6fa9014e5725e3a1daadf301b">More...</a><br /></td></tr>
<tr class="memdesc:a10c4a8b6fa9014e5725e3a1daadf301b"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single message is sent successfully (state changed from MR_STATE_OUT_PENDING to MR_STATE_OUT_DELIVERED, see mrmsg_t::m_state). <a href="#a10c4a8b6fa9014e5725e3a1daadf301b">More...</a><br /></td></tr>
<tr class="separator:a10c4a8b6fa9014e5725e3a1daadf301b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a080965cf1f3dd138999c56ec30580b58"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a080965cf1f3dd138999c56ec30580b58">MR_EVENT_MSG_READ</a>&#160;&#160;&#160;2015</td></tr>
<tr class="memdesc:a080965cf1f3dd138999c56ec30580b58"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single message is read by the receiver (state changed from MR_STATE_OUT_DELIVERED to MR_STATE_OUT_MDN_RCVD, see mrmsg_t::m_state). <a href="#a080965cf1f3dd138999c56ec30580b58">More...</a><br /></td></tr>
@ -127,10 +127,10 @@ Macros</h2></td></tr>
<tr class="memdesc:ad50b3a76349834631dc26b6c9557be8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contact(s) created, renamed, blocked or deleted. <a href="#ad50b3a76349834631dc26b6c9557be8f">More...</a><br /></td></tr>
<tr class="separator:ad50b3a76349834631dc26b6c9557be8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb0881d4c7c887b8f371cedc471846b5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#abb0881d4c7c887b8f371cedc471846b5">MR_EVENT_CONFIGURE_PROGRESS</a>&#160;&#160;&#160;2041</td></tr>
<tr class="memdesc:abb0881d4c7c887b8f371cedc471846b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inform about the configuration progress started by <a class="el" href="structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a>. <a href="#abb0881d4c7c887b8f371cedc471846b5">More...</a><br /></td></tr>
<tr class="memdesc:abb0881d4c7c887b8f371cedc471846b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inform about the configuration progress started by <a class="el" href="classmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a>. <a href="#abb0881d4c7c887b8f371cedc471846b5">More...</a><br /></td></tr>
<tr class="separator:abb0881d4c7c887b8f371cedc471846b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af046556dbd33f0bff86448d62df2b5f7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#af046556dbd33f0bff86448d62df2b5f7">MR_EVENT_IMEX_PROGRESS</a>&#160;&#160;&#160;2051</td></tr>
<tr class="memdesc:af046556dbd33f0bff86448d62df2b5f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inform about the import/export progress started by <a class="el" href="structmrmailbox__t.html#a7db60273eae74ebbc74231f4c6d7204f" title="Import/export things. ">mrmailbox_imex()</a>. <a href="#af046556dbd33f0bff86448d62df2b5f7">More...</a><br /></td></tr>
<tr class="memdesc:af046556dbd33f0bff86448d62df2b5f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inform about the import/export progress started by <a class="el" href="classmrmailbox__t.html#a7db60273eae74ebbc74231f4c6d7204f" title="Import/export things. ">mrmailbox_imex()</a>. <a href="#af046556dbd33f0bff86448d62df2b5f7">More...</a><br /></td></tr>
<tr class="separator:af046556dbd33f0bff86448d62df2b5f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb3ce82a01722f902b02c8e62cf301ab"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#aeb3ce82a01722f902b02c8e62cf301ab">MR_EVENT_IMEX_FILE_WRITTEN</a>&#160;&#160;&#160;2052</td></tr>
<tr class="memdesc:aeb3ce82a01722f902b02c8e62cf301ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">A file has been exported. <a href="#aeb3ce82a01722f902b02c8e62cf301ab">More...</a><br /></td></tr>
@ -152,7 +152,7 @@ Macros</h2></td></tr>
<tr class="separator:a8312b0e8f1e7422300a5502d86e0db01"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The following constants are used as events reported to the callback given to <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>. </p>
<div class="textblock"><p>The following constants are used as events reported to the callback given to <a class="el" href="classmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>. </p>
<p>If you do not want to handle an event, it is always safe to return 0, so there is no need to add a "case" for every event. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="abc46d188d1a1a25c92433aa05568e23b"></a>
@ -166,7 +166,7 @@ Macros</h2></td></tr>
</div><div class="memdoc">
<p>The user may write an informational string to the log. </p>
<p>Passed to the callback given to <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>. This event should not be reported using a popup or something like that.</p>
<p>Passed to the callback given to <a class="el" href="classmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>. This event should not be reported using a popup or something like that.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>0</td></tr>
@ -188,8 +188,8 @@ Macros</h2></td></tr>
</table>
</div><div class="memdoc">
<p>The user should write an warning string to the log. </p>
<p>Passed to the callback given to <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>. This event should not be reported using a popup or something like that.</p>
<p>The user should write a warning string to the log. </p>
<p>Passed to the callback given to <a class="el" href="classmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>. This event should not be reported using a popup or something like that.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>0</td></tr>
@ -236,8 +236,8 @@ Macros</h2></td></tr>
<p>Messages or chats changed. </p>
<p>One or more messages or chats changed for various reasons in the database:</p><ul>
<li>Messages send, received or removed</li>
<li>A message could not be sent (see <a class="el" href="structmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5" title="Get the state of a message. ">mrmsg_get_state()</a>/MR_STATE_OUT_ERROR)</li>
<li>Messages sent, received or removed</li>
<li>A message could not be sent (see <a class="el" href="classmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5" title="Get the state of a message. ">mrmsg_get_state()</a>/MR_STATE_OUT_ERROR)</li>
<li>Chats created, deleted or archived</li>
<li>A draft has been set</li>
</ul>
@ -286,7 +286,7 @@ Macros</h2></td></tr>
</table>
</div><div class="memdoc">
<p>A single message is send successfully (state changed from MR_STATE_OUT_PENDING to MR_STATE_OUT_DELIVERED, see mrmsg_t::m_state). </p>
<p>A single message is sent successfully (state changed from MR_STATE_OUT_PENDING to MR_STATE_OUT_DELIVERED, see mrmsg_t::m_state). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>chat_id</td></tr>
@ -331,7 +331,7 @@ Macros</h2></td></tr>
</div><div class="memdoc">
<p>Group changed. </p>
<p>The name or the image of a chat group was changed or members were added or removed. See <a class="el" href="structmrmailbox__t.html#a8772e9bb55b02299f65ebd8bcc682bb1" title="Set group name. ">mrmailbox_set_chat_name()</a>, <a class="el" href="structmrmailbox__t.html#a08c527170681c949ddd6931a004fdd5f" title="Set group profile image. ">mrmailbox_set_chat_profile_image()</a>, <a class="el" href="structmrmailbox__t.html#a96368620971935c7ac4a0bb324ece2c9" title="Add a member to a group. ">mrmailbox_add_contact_to_chat()</a> and <a class="el" href="structmrmailbox__t.html#a40226d401548b002a62648ea054ac635" title="Remove a member from a group. ">mrmailbox_remove_contact_from_chat()</a>.</p>
<p>The name or the image of a chat group was changed or members were added or removed. See <a class="el" href="classmrmailbox__t.html#a8772e9bb55b02299f65ebd8bcc682bb1" title="Set group name. ">mrmailbox_set_chat_name()</a>, <a class="el" href="classmrmailbox__t.html#a08c527170681c949ddd6931a004fdd5f" title="Set group profile image. ">mrmailbox_set_chat_profile_image()</a>, <a class="el" href="classmrmailbox__t.html#a96368620971935c7ac4a0bb324ece2c9" title="Add a member to a group. ">mrmailbox_add_contact_to_chat()</a> and <a class="el" href="classmrmailbox__t.html#a40226d401548b002a62648ea054ac635" title="Remove a member from a group. ">mrmailbox_remove_contact_from_chat()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>chat_id</td></tr>
@ -375,7 +375,7 @@ Macros</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Inform about the configuration progress started by <a class="el" href="structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a>. </p>
<p>Inform about the configuration progress started by <a class="el" href="classmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>Permille</td></tr>
@ -397,7 +397,7 @@ Macros</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Inform about the import/export progress started by <a class="el" href="structmrmailbox__t.html#a7db60273eae74ebbc74231f4c6d7204f" title="Import/export things. ">mrmailbox_imex()</a>. </p>
<p>Inform about the import/export progress started by <a class="el" href="classmrmailbox__t.html#a7db60273eae74ebbc74231f4c6d7204f" title="Import/export things. ">mrmailbox_imex()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>Permille</td></tr>
@ -420,7 +420,7 @@ Macros</h2></td></tr>
</div><div class="memdoc">
<p>A file has been exported. </p>
<p>A file has been written by <a class="el" href="structmrmailbox__t.html#a7db60273eae74ebbc74231f4c6d7204f" title="Import/export things. ">mrmailbox_imex()</a>. This event may be send multiple times by a single call to <a class="el" href="structmrmailbox__t.html#a7db60273eae74ebbc74231f4c6d7204f" title="Import/export things. ">mrmailbox_imex()</a>.</p>
<p>A file has been written by <a class="el" href="classmrmailbox__t.html#a7db60273eae74ebbc74231f4c6d7204f" title="Import/export things. ">mrmailbox_imex()</a>. This event may be sent multiple times by a single call to <a class="el" href="classmrmailbox__t.html#a7db60273eae74ebbc74231f4c6d7204f" title="Import/export things. ">mrmailbox_imex()</a>.</p>
<p>A typical purpose for a handler of this event may be to make the file public to some system services.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
@ -493,7 +493,7 @@ Macros</h2></td></tr>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>ID of the string to request, one of the MR_STR_* constants as defined in <a class="el" href="mrstock_8h_source.html">mrstock.h</a></td></tr>
<tr><td class="paramname">data2</td><td>The count. The frontend may retrurn different strings on this value and normally also includes the value itself to the string.</td></tr>
<tr><td class="paramname">data2</td><td>The count. The frontend may return different strings on this value and normally also includes the value itself to the string.</td></tr>
</table>
</dd>
</dl>
@ -534,7 +534,7 @@ Macros</h2></td></tr>
</div><div class="memdoc">
<p>Acquire or release a wakelock. </p>
<p>The core surrounds critcal functions that should not be killed by the operating system with wakelocks. Before a critical function <em>MR_EVENT_WAKE_LOCK with data1=1</em> is called, it it finishes, <em>MR_EVENT_WAKE_LOCK with data1=0</em> is called. If you do not need this functionality, just ignore this event.</p>
<p>The core surrounds critical functions that should not be killed by the operating system with wakelocks. Before a critical function <em>MR_EVENT_WAKE_LOCK with data1=1</em> is called, it it finishes, <em>MR_EVENT_WAKE_LOCK with data1=0</em> is called. If you do not need this functionality, just ignore this event.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>1=acquire wakelock, 0=release wakelock, the core does not make nested or unsynchronized calls</td></tr>