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

doxygen

Browse source
This commit is contained in:
B. Petersen 2017-11-23 13:32:42 +01:00
parent 324d53277a
commit 6b3f4f2f03
11 changed files with 139 additions and 111 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/html/functions.html
View file

@ -477,12 +477,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>mrmsg_is_systemcmd()
: <a class="el" href="structmrmsg__t.html#a752209192e3a022d087fe6c647fb3ad9">mrmsg_t</a>
</li>
<li>mrmsg_latefiling_mediasize()
: <a class="el" href="structmrmailbox__t.html#a9e5dc81d4e814284b465ad23abbfb6cb">mrmailbox_t</a>
</li>
<li>mrmsg_new()
: <a class="el" href="structmrmsg__t.html#a80f470eb34af414ff28e7d3b3c715b48">mrmsg_t</a>
</li>
<li>mrmsg_save_param_to_disk()
: <a class="el" href="structmrmsg__t.html#a0bc3ce5f2ef0065547e4aee0143d22ef">mrmsg_t</a>
</li>
<li>mrmsg_set_file()
: <a class="el" href="structmrmsg__t.html#a98455bee60d64b3d59d89fbbb520ddd5">mrmsg_t</a>
</li>

6
docs/html/functions_func.html
View file

@ -394,12 +394,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>mrmsg_is_systemcmd()
: <a class="el" href="structmrmsg__t.html#a752209192e3a022d087fe6c647fb3ad9">mrmsg_t</a>
</li>
<li>mrmsg_latefiling_mediasize()
: <a class="el" href="structmrmailbox__t.html#a9e5dc81d4e814284b465ad23abbfb6cb">mrmailbox_t</a>
</li>
<li>mrmsg_new()
: <a class="el" href="structmrmsg__t.html#a80f470eb34af414ff28e7d3b3c715b48">mrmsg_t</a>
</li>
<li>mrmsg_save_param_to_disk()
: <a class="el" href="structmrmsg__t.html#a0bc3ce5f2ef0065547e4aee0143d22ef">mrmsg_t</a>
</li>
<li>mrmsg_set_file()
: <a class="el" href="structmrmsg__t.html#a98455bee60d64b3d59d89fbbb520ddd5">mrmsg_t</a>
</li>

70
docs/html/mrmailbox_8h_source.html
View file

File diff suppressed because one or more lines are too long

47
docs/html/mrmsg_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/search/all_1.js
View file

@ -148,8 +148,8 @@ var searchData=
['mrmsg_5fis_5fforwarded',['mrmsg_is_forwarded',['../structmrmsg__t.html#a3256ed8c6a55a6c1a30e0fce33b85421',1,'mrmsg_t']]],
['mrmsg_5fis_5fincreation',['mrmsg_is_increation',['../structmrmsg__t.html#a32d23bac4bf35ed5f8c2cfbb93d636f5',1,'mrmsg_t']]],
['mrmsg_5fis_5fsystemcmd',['mrmsg_is_systemcmd',['../structmrmsg__t.html#a752209192e3a022d087fe6c647fb3ad9',1,'mrmsg_t']]],
['mrmsg_5flatefiling_5fmediasize',['mrmsg_latefiling_mediasize',['../structmrmailbox__t.html#a9e5dc81d4e814284b465ad23abbfb6cb',1,'mrmailbox_t']]],
['mrmsg_5fnew',['mrmsg_new',['../structmrmsg__t.html#a80f470eb34af414ff28e7d3b3c715b48',1,'mrmsg_t']]],
['mrmsg_5fsave_5fparam_5fto_5fdisk',['mrmsg_save_param_to_disk',['../structmrmsg__t.html#a0bc3ce5f2ef0065547e4aee0143d22ef',1,'mrmsg_t']]],
['mrmsg_5fset_5ffile',['mrmsg_set_file',['../structmrmsg__t.html#a98455bee60d64b3d59d89fbbb520ddd5',1,'mrmsg_t']]],
['mrmsg_5fset_5ftext',['mrmsg_set_text',['../structmrmsg__t.html#ae940aa79a261e1a427b12baefbee2d23',1,'mrmsg_t']]],
['mrmsg_5fset_5ftype',['mrmsg_set_type',['../structmrmsg__t.html#a3581e331fe9f3f38d4c5bb1b1c8c7867',1,'mrmsg_t']]],

2
docs/html/search/functions_0.js
View file

@ -99,8 +99,8 @@ var searchData=
['mrmsg_5fis_5fforwarded',['mrmsg_is_forwarded',['../structmrmsg__t.html#a3256ed8c6a55a6c1a30e0fce33b85421',1,'mrmsg_t']]],
['mrmsg_5fis_5fincreation',['mrmsg_is_increation',['../structmrmsg__t.html#a32d23bac4bf35ed5f8c2cfbb93d636f5',1,'mrmsg_t']]],
['mrmsg_5fis_5fsystemcmd',['mrmsg_is_systemcmd',['../structmrmsg__t.html#a752209192e3a022d087fe6c647fb3ad9',1,'mrmsg_t']]],
['mrmsg_5flatefiling_5fmediasize',['mrmsg_latefiling_mediasize',['../structmrmailbox__t.html#a9e5dc81d4e814284b465ad23abbfb6cb',1,'mrmailbox_t']]],
['mrmsg_5fnew',['mrmsg_new',['../structmrmsg__t.html#a80f470eb34af414ff28e7d3b3c715b48',1,'mrmsg_t']]],
['mrmsg_5fsave_5fparam_5fto_5fdisk',['mrmsg_save_param_to_disk',['../structmrmsg__t.html#a0bc3ce5f2ef0065547e4aee0143d22ef',1,'mrmsg_t']]],
['mrmsg_5fset_5ffile',['mrmsg_set_file',['../structmrmsg__t.html#a98455bee60d64b3d59d89fbbb520ddd5',1,'mrmsg_t']]],
['mrmsg_5fset_5ftext',['mrmsg_set_text',['../structmrmsg__t.html#ae940aa79a261e1a427b12baefbee2d23',1,'mrmsg_t']]],
['mrmsg_5fset_5ftype',['mrmsg_set_type',['../structmrmsg__t.html#a3581e331fe9f3f38d4c5bb1b1c8c7867',1,'mrmsg_t']]],

1
docs/html/structmrmailbox__t-members.html
View file

@ -154,6 +154,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<tr><td class="entry"><a class="el" href="structmrmailbox__t.html#a8ed1c3bd08cd6515abf6046ebad9cafc">mrmailbox_star_msgs</a>(mrmailbox_t *mailbox, const uint32_t *msg_ids, int msg_cnt, int star)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmailbox__t.html#a825cec4a85da05335674eae221d51374">mrmailbox_unref</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmailbox__t.html#a957f0bbae60f389bac40acf42b68b134">mrmailboxcb_t</a> typedef</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmailbox__t.html#a9e5dc81d4e814284b465ad23abbfb6cb">mrmsg_latefiling_mediasize</a>(mrmsg_t *msg, int width, int height, int duration)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>

70
docs/html/structmrmailbox__t.html
View file

@ -165,7 +165,7 @@ Public Member Functions</h2></td></tr>
<tr class="memdesc:a4c69c290d57aa2b76f0260c0c2702023"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns all message IDs of the given types in a chat. <a href="#a4c69c290d57aa2b76f0260c0c2702023">More...</a><br /></td></tr>
<tr class="separator:a4c69c290d57aa2b76f0260c0c2702023"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90b7861302d1276a07fdcb2d9c3c73b6"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#a90b7861302d1276a07fdcb2d9c3c73b6">mrmailbox_get_next_media</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox, uint32_t curr_msg_id, int dir)</td></tr>
<tr class="memdesc:a90b7861302d1276a07fdcb2d9c3c73b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns all message IDs of the given types in a chat. <a href="#a90b7861302d1276a07fdcb2d9c3c73b6">More...</a><br /></td></tr>
<tr class="memdesc:a90b7861302d1276a07fdcb2d9c3c73b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get next/previous message of the same type. <a href="#a90b7861302d1276a07fdcb2d9c3c73b6">More...</a><br /></td></tr>
<tr class="separator:a90b7861302d1276a07fdcb2d9c3c73b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab996f74d0e8b5c82ec7175f29da57e3d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrarray__t.html">mrarray_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#ab996f74d0e8b5c82ec7175f29da57e3d">mrmailbox_get_chat_contacts</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox, uint32_t chat_id)</td></tr>
<tr class="memdesc:ab996f74d0e8b5c82ec7175f29da57e3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get contact IDs belonging to a chat. <a href="#ab996f74d0e8b5c82ec7175f29da57e3d">More...</a><br /></td></tr>
@ -290,6 +290,9 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:af4d9c838230758e1b0e40957447232f7"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#af4d9c838230758e1b0e40957447232f7">mrmailbox_create_setup_code</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox)</td></tr>
<tr class="memdesc:af4d9c838230758e1b0e40957447232f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create random setup code. <a href="#af4d9c838230758e1b0e40957447232f7">More...</a><br /></td></tr>
<tr class="separator:af4d9c838230758e1b0e40957447232f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e5dc81d4e814284b465ad23abbfb6cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#a9e5dc81d4e814284b465ad23abbfb6cb">mrmsg_latefiling_mediasize</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg, int width, int height, int duration)</td></tr>
<tr class="memdesc:a9e5dc81d4e814284b465ad23abbfb6cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Late filing information to a message. <a href="#a9e5dc81d4e814284b465ad23abbfb6cb">More...</a><br /></td></tr>
<tr class="separator:a9e5dc81d4e814284b465ad23abbfb6cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
@ -1064,8 +1067,8 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Returns all message IDs of the given types in a chat. </p>
<p>Typically used to show a gallery. The result must be <a class="el" href="structmrarray__t.html#a1400b5e42c682326e809723f02739a8e" title="Free an array object. ">mrarray_unref()</a>'d</p>
<p>Get next/previous message of the same type. </p>
<p>Typically used to implement the "next" and "previous" buttons on a media player playing eg. voice messages.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailbox</td><td>The mailbox object as returned from <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>.</td></tr>
@ -1074,7 +1077,7 @@ Public Attributes</h2></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the message ID that should be displayed next. The returned message is in the same chat as the given one. Typically, this result is passed again to <a class="el" href="structmrmailbox__t.html#a90b7861302d1276a07fdcb2d9c3c73b6" title="Returns all message IDs of the given types in a chat. ">mrmailbox_get_next_media()</a> later on the next swipe. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the message ID that should be played next. The returned message is in the same chat as the given one and has the same type. Typically, this result is passed again to <a class="el" href="structmrmailbox__t.html#a90b7861302d1276a07fdcb2d9c3c73b6" title="Get next/previous message of the same type. ">mrmailbox_get_next_media()</a> later on the next swipe. If there is not next/previous message, the function returns 0. </dd></dl>
</div>
</div>
@ -1577,7 +1580,7 @@ Public Attributes</h2></td></tr>
<table class="params">
<tr><td class="paramname">mailbox</td><td>The mailbox object as returned from <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>.</td></tr>
<tr><td class="paramname">chat_id</td><td>Chat ID to send the message to.</td></tr>
<tr><td class="paramname">msg</td><td>Message object to send to the chat defined by the chat ID. The function does not take ownership of the object, so you have to free it using <a class="el" href="structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02" title="Free an mrmsg_t object created eg. ">mrmsg_unref()</a> as usual.</td></tr>
<tr><td class="paramname">msg</td><td>Message object to send to the chat defined by the chat ID. The function does not take ownership of the object, so you have to free it using <a class="el" href="structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02" title="Free a message object. ">mrmsg_unref()</a> as usual.</td></tr>
</table>
</dd>
</dl>
@ -2243,7 +2246,7 @@ Public Attributes</h2></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="structmrmsg__t.html" title="An object representing a single message in memory. ">mrmsg_t</a> message object. When done, the object must be freed using <a class="el" href="structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02" title="Free an mrmsg_t object created eg. ">mrmsg_unref()</a> </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="structmrmsg__t.html" title="An object representing a single message in memory. ">mrmsg_t</a> message object. When done, the object must be freed using <a class="el" href="structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02" title="Free a message object. ">mrmsg_unref()</a> </dd></dl>
</div>
</div>
@ -2707,6 +2710,60 @@ Public Attributes</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Setup code, must be free()'d after usage. </dd></dl>
</div>
</div>
<a class="anchor" id="a9e5dc81d4e814284b465ad23abbfb6cb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrmsg_latefiling_mediasize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>duration</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Late filing information to a message. </p>
<p>Sometimes, the core cannot find out the width, the height or the duration of an image, an audio or a video.</p>
<p>If, in these cases, the frontend can provide the information, it can save them together with the message object for later usage.</p>
<p>This function should only be used if <a class="el" href="structmrmsg__t.html#adfe10086430b562b8df4e45668b51927" title="Get width of image or video. ">mrmsg_get_width()</a>, <a class="el" href="structmrmsg__t.html#a8600ed157b44b1089783e66ce7b33353" title="Get height of image or video. ">mrmsg_get_height()</a> or <a class="el" href="structmrmsg__t.html#aa180c0fd4c9cdd58cc47006022ebc1e0" title="Get duration of audio or video. ">mrmsg_get_duration()</a> do not provide the expected values.</p>
<p>To get the stored values later, use <a class="el" href="structmrmsg__t.html#adfe10086430b562b8df4e45668b51927" title="Get width of image or video. ">mrmsg_get_width()</a>, <a class="el" href="structmrmsg__t.html#a8600ed157b44b1089783e66ce7b33353" title="Get height of image or video. ">mrmsg_get_height()</a> or <a class="el" href="structmrmsg__t.html#aa180c0fd4c9cdd58cc47006022ebc1e0" title="Get duration of audio or video. ">mrmsg_get_duration()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object.</td></tr>
<tr><td class="paramname">width</td><td>The new width to store in the message object. 0 if you do not want to change it.</td></tr>
<tr><td class="paramname">height</td><td>The new height to store in the message object. 0 if you do not want to change it.</td></tr>
<tr><td class="paramname">duration</td><td>The new duration to store in the message object. 0 if you do not want to change it.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
@ -2760,6 +2817,7 @@ Public Attributes</h2></td></tr>
<li>/home/bpetersen/projects/deltachat-core/src/mrmailbox.c</li>
<li>/home/bpetersen/projects/deltachat-core/src/mrmailbox_configure.c</li>
<li>/home/bpetersen/projects/deltachat-core/src/mrmailbox_imex.c</li>
<li>/home/bpetersen/projects/deltachat-core/src/mrmsg.c</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->

9
docs/html/structmrmsg__t-members.html
View file

@ -117,11 +117,10 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a32d23bac4bf35ed5f8c2cfbb93d636f5">mrmsg_is_increation</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a752209192e3a022d087fe6c647fb3ad9">mrmsg_is_systemcmd</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a80f470eb34af414ff28e7d3b3c715b48">mrmsg_new</a>()</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a0bc3ce5f2ef0065547e4aee0143d22ef">mrmsg_save_param_to_disk</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a98455bee60d64b3d59d89fbbb520ddd5">mrmsg_set_file</a>(mrmsg_t *msg, const char *file)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#ae940aa79a261e1a427b12baefbee2d23">mrmsg_set_text</a>(mrmsg_t *msg, const char *text)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a3581e331fe9f3f38d4c5bb1b1c8c7867">mrmsg_set_type</a>(mrmsg_t *msg, int type)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02">mrmsg_unref</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a98455bee60d64b3d59d89fbbb520ddd5">mrmsg_set_file</a>(mrmsg_t *msg, const char *file)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#ae940aa79a261e1a427b12baefbee2d23">mrmsg_set_text</a>(mrmsg_t *msg, const char *text)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a3581e331fe9f3f38d4c5bb1b1c8c7867">mrmsg_set_type</a>(mrmsg_t *msg, int type)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02">mrmsg_unref</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>

35
docs/html/structmrmsg__t.html
View file

@ -101,7 +101,7 @@ Public Member Functions</h2></td></tr>
<tr class="memdesc:a80f470eb34af414ff28e7d3b3c715b48"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create new message object. <a href="#a80f470eb34af414ff28e7d3b3c715b48">More...</a><br /></td></tr>
<tr class="separator:a80f470eb34af414ff28e7d3b3c715b48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa33212e41efff643aa7290753f3d9b02"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02">mrmsg_unref</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:aa33212e41efff643aa7290753f3d9b02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free an <a class="el" href="structmrmsg__t.html" title="An object representing a single message in memory. ">mrmsg_t</a> object created eg. <a href="#aa33212e41efff643aa7290753f3d9b02">More...</a><br /></td></tr>
<tr class="memdesc:aa33212e41efff643aa7290753f3d9b02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free a message object. <a href="#aa33212e41efff643aa7290753f3d9b02">More...</a><br /></td></tr>
<tr class="separator:aa33212e41efff643aa7290753f3d9b02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57d94b55fc918b27874b9194d6c35388"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a57d94b55fc918b27874b9194d6c35388">mrmsg_empty</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:a57d94b55fc918b27874b9194d6c35388"><td class="mdescLeft">&#160;</td><td class="mdescRight">Empty a message object. <a href="#a57d94b55fc918b27874b9194d6c35388">More...</a><br /></td></tr>
@ -166,9 +166,6 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a32d23bac4bf35ed5f8c2cfbb93d636f5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a32d23bac4bf35ed5f8c2cfbb93d636f5">mrmsg_is_increation</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:a32d23bac4bf35ed5f8c2cfbb93d636f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a message is still in creation. <a href="#a32d23bac4bf35ed5f8c2cfbb93d636f5">More...</a><br /></td></tr>
<tr class="separator:a32d23bac4bf35ed5f8c2cfbb93d636f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bc3ce5f2ef0065547e4aee0143d22ef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a0bc3ce5f2ef0065547e4aee0143d22ef">mrmsg_save_param_to_disk</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:a0bc3ce5f2ef0065547e4aee0143d22ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add additional, persistent information to a message record. <a href="#a0bc3ce5f2ef0065547e4aee0143d22ef">More...</a><br /></td></tr>
<tr class="separator:a0bc3ce5f2ef0065547e4aee0143d22ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
@ -240,8 +237,8 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Free an <a class="el" href="structmrmsg__t.html" title="An object representing a single message in memory. ">mrmsg_t</a> object created eg. </p>
<p>by <a class="el" href="structmrmsg__t.html#a80f470eb34af414ff28e7d3b3c715b48" title="Create new message object. ">mrmsg_new()</a> or <a class="el" href="structmrmailbox__t.html#a9ef144244e7d86ba82ce3257abf14f13" title="Get a single message object of the type mrmsg_t. ">mrmailbox_get_msg()</a>. This also free()s all strings; so if you set up the object yourself, make sure to use strdup()!</p>
<p>Free a message object. </p>
<p>Message objects are created eg. by <a class="el" href="structmrmailbox__t.html#a9ef144244e7d86ba82ce3257abf14f13" title="Get a single message object of the type mrmsg_t. ">mrmailbox_get_msg()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object to free.</td></tr>
@ -873,32 +870,6 @@ Public Attributes</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1=message is still in creation (<code>&lt;filename&gt;.increation</code> exists), 0=message no longer in creation </dd></dl>
</div>
</div>
<a class="anchor" id="a0bc3ce5f2ef0065547e4aee0143d22ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrmsg_save_param_to_disk </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add additional, persistent information to a message record. </p>
<p>Normally, this function is not needed; message records are created by <a class="el" href="structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c" title="Send a message of any type to a chat. ">mrmailbox_send_msg()</a> or <a class="el" href="structmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b" title="Send a simple text message to the given chat. ">mrmailbox_send_text_msg()</a> and modified by actions of the user. However, for rare cases, it might be necessary to save an paramter later to disk. For this purpose, use this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>

2
src/mrmsg.c
View file

@ -942,7 +942,7 @@ void mrmsg_save_param_to_disk__(mrmsg_t* msg)
*
* @memberof mrmailbox_t
*
* @param mailbox The message object.
* @param msg The message object.
*
* @param width The new width to store in the message object. 0 if you do not want to change it.
*