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

Update doxygen.

Browse source
This commit is contained in:
B. Petersen 2017-11-15 09:27:20 +01:00
parent 526dd1b1c6
commit 58833040f2
5 changed files with 148 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/html/index.html
View file

@ -83,7 +83,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<p>Let's start.</p>
<p>First of all, you have to define a function that is called by the library on specific events (eg. when the configuration is done or when fresh messages arrive). Your function should look like the following:</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;mrmailbox.h&gt;</span></div><div class="line"></div><div class="line">uintptr_t my_delta_handler(<a class="code" href="structmrmailbox__t.html">mrmailbox_t</a>* nb, <span class="keywordtype">int</span> event, uintptr_t data1, uintptr_t data2)</div><div class="line">{</div><div class="line"> <span class="keywordflow">return</span> 0; <span class="comment">// for unhandled events, it is always safe to return 0</span></div><div class="line">}</div></div><!-- fragment --><p>After that, you can create and configure a <a class="el" href="structmrmailbox__t.html" title="An object representing a single mailbox. ">mrmailbox_t</a> object easily as follows:</p>
<div class="fragment"><div class="line"><a class="code" href="structmrmailbox__t.html">mrmailbox_t</a>* mb = <a class="code" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a">mrmailbox_new</a>(my_delta_handler, NULL, NULL);</div><div class="line"></div><div class="line"><a class="code" href="structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad">mrmailbox_set_config</a>(mb, <span class="stringliteral">&quot;addr&quot;</span>, <span class="stringliteral">&quot;alice@delta.chat&quot;</span>); <span class="comment">// use some real test credentials here</span></div><div class="line"><a class="code" href="structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad">mrmailbox_set_config</a>(mb, <span class="stringliteral">&quot;mail_pw&quot;</span>, <span class="stringliteral">&quot;***&quot;</span>);</div><div class="line"></div><div class="line"><a class="code" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387">mrmailbox_configure_and_connect</a>(mb);</div></div><!-- fragment --><p>If this works, you'll receive the event <a class="el" href="mrevent_8h.html#a3be5f7ee95e6d0a8066e7a839f38c30f" title="connection state changed, data1=0:failed-not-connected, 1:configured-and-connected ...">MR_EVENT_CONFIGURE_ENDED</a> with <code>data1</code> set to <code>1</code> - and you can start sending your first message:</p>
<div class="fragment"><div class="line"><a class="code" href="structmrmailbox__t.html">mrmailbox_t</a>* mb = <a class="code" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a">mrmailbox_new</a>(my_delta_handler, NULL, NULL);</div><div class="line"></div><div class="line"><a class="code" href="structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad">mrmailbox_set_config</a>(mb, <span class="stringliteral">&quot;addr&quot;</span>, <span class="stringliteral">&quot;alice@delta.chat&quot;</span>); <span class="comment">// use some real test credentials here</span></div><div class="line"><a class="code" href="structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad">mrmailbox_set_config</a>(mb, <span class="stringliteral">&quot;mail_pw&quot;</span>, <span class="stringliteral">&quot;***&quot;</span>);</div><div class="line"></div><div class="line"><a class="code" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387">mrmailbox_configure_and_connect</a>(mb);</div></div><!-- fragment --><p>If this works, you'll receive the event <a class="el" href="mrevent_8h.html#a3be5f7ee95e6d0a8066e7a839f38c30f" title="Configurartion enden. ">MR_EVENT_CONFIGURE_ENDED</a> with <code>data1</code> set to <code>1</code> - and you can start sending your first message:</p>
<div class="fragment"><div class="line">uint32_t contact_id = <a class="code" href="structmrmailbox__t.html#aa089e97e7ca1add16c10d5cc0e902824">mrmailbox_create_contact</a>(mb, <span class="stringliteral">&quot;bob@delta.chat&quot;</span>); <span class="comment">// use a real testing address here</span></div><div class="line">uint32_t chat_id = <a class="code" href="structmrmailbox__t.html#a1386ec2c091b936b65b25b50a302173d">mrmailbox_create_chat_by_contact_id</a>(mb, contact_id);</div><div class="line"></div><div class="line"><a class="code" href="structmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b">mrmailbox_send_text_msg</a>(mb, chat_id, <span class="stringliteral">&quot;Hi, here is my first message!&quot;</span>);</div></div><!-- fragment --><p>Now, go to the testing address (bob) and you should have received a normal email. Answer this email in any email program with "Got it!" and you will get the message from delta as follows:</p>
<div class="fragment"><div class="line">carray* msglist = <a class="code" href="structmrmailbox__t.html#a5d3be6ed21d43cc93f250a1e7faf979b">mrmailbox_get_chat_msgs</a>(mb, chat_id, 0, 0);</div><div class="line"><span class="keywordflow">for</span>( <span class="keywordtype">size_t</span> i = 0; i &lt; carray_count(msglist); i++ )</div><div class="line">{</div><div class="line"> uint32_t msg_id = carray_get_uint32(msglist, i);</div><div class="line"> <a class="code" href="structmrmsg__t.html">mrmsg_t</a>* msg = <a class="code" href="structmrmailbox__t.html#a9ef144244e7d86ba82ce3257abf14f13">mrmailbox_get_msg</a>(mb, msg_id);</div><div class="line"></div><div class="line"> printf(<span class="stringliteral">&quot;message %i: %s\n&quot;</span>, i+1, msg-&gt;<a class="code" href="structmrmsg__t.html#ae54dcd4036371597d7f8bbd75303527a">m_text</a>);</div><div class="line">}</div></div><!-- fragment --><p>This will output the following two lines:</p>
<div class="fragment"><div class="line">Message 1: Hi, here is my first message!</div><div class="line">Message 2: Got it!</div></div><!-- fragment --><p>I think, you got the idea. For further reading, please dive into the <a class="el" href="structmrmailbox__t.html" title="An object representing a single mailbox. ">mrmailbox_t</a> class.</p>

162
docs/html/mrevent_8h.html
View file

@ -120,29 +120,23 @@ Macros</h2></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 <a class="el" href="structmrmsg__t.html#aca59d28054d3e15b4fe6ca74073d91f4" title="Message state. ">mrmsg_t::m_state</a>). <a href="#a080965cf1f3dd138999c56ec30580b58">More...</a><br /></td></tr>
<tr class="separator:a080965cf1f3dd138999c56ec30580b58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ac741b81ec97628f44795600c0e4d4c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ac741b81ec97628f44795600c0e4d4c"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a5ac741b81ec97628f44795600c0e4d4c">MR_EVENT_CHAT_MODIFIED</a>&#160;&#160;&#160;2020</td></tr>
<tr class="memdesc:a5ac741b81ec97628f44795600c0e4d4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">group name/image changed or members added/removed <br /></td></tr>
<tr class="memitem:a5ac741b81ec97628f44795600c0e4d4c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a5ac741b81ec97628f44795600c0e4d4c">MR_EVENT_CHAT_MODIFIED</a>&#160;&#160;&#160;2020</td></tr>
<tr class="memdesc:a5ac741b81ec97628f44795600c0e4d4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Group name/image changed or members added/removed. <a href="#a5ac741b81ec97628f44795600c0e4d4c">More...</a><br /></td></tr>
<tr class="separator:a5ac741b81ec97628f44795600c0e4d4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad50b3a76349834631dc26b6c9557be8f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad50b3a76349834631dc26b6c9557be8f"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#ad50b3a76349834631dc26b6c9557be8f">MR_EVENT_CONTACTS_CHANGED</a>&#160;&#160;&#160;2030</td></tr>
<tr class="memdesc:ad50b3a76349834631dc26b6c9557be8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">contact(s) created, renamed, blocked or deleted <br /></td></tr>
<tr class="memitem:ad50b3a76349834631dc26b6c9557be8f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#ad50b3a76349834631dc26b6c9557be8f">MR_EVENT_CONTACTS_CHANGED</a>&#160;&#160;&#160;2030</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:a3be5f7ee95e6d0a8066e7a839f38c30f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3be5f7ee95e6d0a8066e7a839f38c30f"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a3be5f7ee95e6d0a8066e7a839f38c30f">MR_EVENT_CONFIGURE_ENDED</a>&#160;&#160;&#160;2040</td></tr>
<tr class="memdesc:a3be5f7ee95e6d0a8066e7a839f38c30f"><td class="mdescLeft">&#160;</td><td class="mdescRight">connection state changed, data1=0:failed-not-connected, 1:configured-and-connected <br /></td></tr>
<tr class="memitem:a3be5f7ee95e6d0a8066e7a839f38c30f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a3be5f7ee95e6d0a8066e7a839f38c30f">MR_EVENT_CONFIGURE_ENDED</a>&#160;&#160;&#160;2040</td></tr>
<tr class="memdesc:a3be5f7ee95e6d0a8066e7a839f38c30f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configurartion enden. <a href="#a3be5f7ee95e6d0a8066e7a839f38c30f">More...</a><br /></td></tr>
<tr class="separator:a3be5f7ee95e6d0a8066e7a839f38c30f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb0881d4c7c887b8f371cedc471846b5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb0881d4c7c887b8f371cedc471846b5"></a>
#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">data1=percent <br /></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. <a href="#abb0881d4c7c887b8f371cedc471846b5">More...</a><br /></td></tr>
<tr class="separator:abb0881d4c7c887b8f371cedc471846b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10211bf20ad64f8f6d635120ca64f374"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10211bf20ad64f8f6d635120ca64f374"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a10211bf20ad64f8f6d635120ca64f374">MR_EVENT_IMEX_ENDED</a>&#160;&#160;&#160;2050</td></tr>
<tr class="memdesc:a10211bf20ad64f8f6d635120ca64f374"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structmrmailbox__t.html#a5de7b87b8c95733619cc4051b3508973" title="Import/export things. ">mrmailbox_imex()</a> done: data1=0:failed, 1=success <br /></td></tr>
<tr class="memitem:a10211bf20ad64f8f6d635120ca64f374"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a10211bf20ad64f8f6d635120ca64f374">MR_EVENT_IMEX_ENDED</a>&#160;&#160;&#160;2050</td></tr>
<tr class="memdesc:a10211bf20ad64f8f6d635120ca64f374"><td class="mdescLeft">&#160;</td><td class="mdescRight">Import/export done. <a href="#a10211bf20ad64f8f6d635120ca64f374">More...</a><br /></td></tr>
<tr class="separator:a10211bf20ad64f8f6d635120ca64f374"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af046556dbd33f0bff86448d62df2b5f7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af046556dbd33f0bff86448d62df2b5f7"></a>
#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">data1=permille <br /></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. <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">file written, event may be needed to make the file public to some system services. <a href="#aeb3ce82a01722f902b02c8e62cf301ab">More...</a><br /></td></tr>
@ -171,6 +165,94 @@ Macros</h2></td></tr>
<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><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a5ac741b81ec97628f44795600c0e4d4c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_CHAT_MODIFIED&#160;&#160;&#160;2020</td>
</tr>
</table>
</div><div class="memdoc">
<p>Group name/image changed or members added/removed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>chat_id </td></tr>
<tr><td class="paramname">data2</td><td>0 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="a3be5f7ee95e6d0a8066e7a839f38c30f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_CONFIGURE_ENDED&#160;&#160;&#160;2040</td>
</tr>
</table>
</div><div class="memdoc">
<p>Configurartion enden. </p>
<p>You'll get this event from a call to <a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387" 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>0=failed-not-connected, 1=configured-and-connected </td></tr>
<tr><td class="paramname">data2</td><td>0 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="abb0881d4c7c887b8f371cedc471846b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_CONFIGURE_PROGRESS&#160;&#160;&#160;2041</td>
</tr>
</table>
</div><div class="memdoc">
<p>Inform about the configuration progress. </p>
<p>As we want to get rid of the threads in the core, this event may be deleted. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>permille </td></tr>
<tr><td class="paramname">data2</td><td>0 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="ad50b3a76349834631dc26b6c9557be8f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_CONTACTS_CHANGED&#160;&#160;&#160;2030</td>
</tr>
</table>
</div><div class="memdoc">
<p>Contact(s) created, renamed, blocked or deleted. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>0 </td></tr>
<tr><td class="paramname">data2</td><td>0 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="a7088b24d6d49fee42d6b83360bf1fcca"></a>
<div class="memitem">
<div class="memproto">
@ -191,6 +273,28 @@ Macros</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="a10211bf20ad64f8f6d635120ca64f374"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_IMEX_ENDED&#160;&#160;&#160;2050</td>
</tr>
</table>
</div><div class="memdoc">
<p>Import/export done. </p>
<p>You'll get this event from a call to <a class="el" href="structmrmailbox__t.html#a5de7b87b8c95733619cc4051b3508973" title="Import/export things. ">mrmailbox_imex()</a>. As we want to get rid of the threads in the core, this event may be deleted. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>0:failed, 1=success </td></tr>
<tr><td class="paramname">data2</td><td>0 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="aeb3ce82a01722f902b02c8e62cf301ab"></a>
@ -206,6 +310,28 @@ Macros</h2></td></tr>
<p>file written, event may be needed to make the file public to some system services. </p>
<p>data1=file name, data2=mime type </p>
</div>
</div>
<a class="anchor" id="af046556dbd33f0bff86448d62df2b5f7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_IMEX_PROGRESS&#160;&#160;&#160;2051</td>
</tr>
</table>
</div><div class="memdoc">
<p>Inform about the import/export progress. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>permille </td></tr>
<tr><td class="paramname">data2</td><td>0 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="a548525a9d4cc03cd240ca6dda4246ae8"></a>

2
docs/html/mrevent_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrmailbox_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/structmrmailbox__t.html
View file

@ -322,7 +322,7 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailbox</td><td>the mailbox object as returned by <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>.</td></tr>
<tr><td class="paramname">event</td><td>one of the MR_EVENT_* constants</td></tr>
<tr><td class="paramname">event</td><td>one of the MR_EVENT_* constants as defined in <a class="el" href="mrevent_8h.html" title="The following constants are used as events reported to the callback given to mrmailbox_new(). ">mrevent.h</a></td></tr>
<tr><td class="paramname">data1</td><td>depends on the event parameter</td></tr>
<tr><td class="paramname">data2</td><td>depends on the event parameter</td></tr>
</table>