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

doxygen

Browse source
This commit is contained in:
B. Petersen 2017-11-24 14:01:15 +01:00
parent 366c70f7dc
commit 6c33483cd0
25 changed files with 593 additions and 133 deletions
Download patch file Download diff file Expand all files Collapse all files

40
docs/html/structmrmsg__t.html
View file

@ -124,9 +124,9 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:afd11616dcf572662561829c0f48ca713"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#afd11616dcf572662561829c0f48ca713">mrmsg_get_filebytes</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:afd11616dcf572662561829c0f48ca713"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the size of the file. <a href="#afd11616dcf572662561829c0f48ca713">More...</a><br /></td></tr>
<tr class="separator:afd11616dcf572662561829c0f48ca713"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad87b7df007489b3a47c3fde79978a58a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrpoortext__t.html">mrpoortext_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#ad87b7df007489b3a47c3fde79978a58a">mrmsg_get_mediainfo</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:ad87b7df007489b3a47c3fde79978a58a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get real author and title. <a href="#ad87b7df007489b3a47c3fde79978a58a">More...</a><br /></td></tr>
<tr class="separator:ad87b7df007489b3a47c3fde79978a58a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c6dfee4004fe0e9b9f90720bad73ecb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrlot__t.html">mrlot_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a1c6dfee4004fe0e9b9f90720bad73ecb">mrmsg_get_mediainfo</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:a1c6dfee4004fe0e9b9f90720bad73ecb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get real author and title. <a href="#a1c6dfee4004fe0e9b9f90720bad73ecb">More...</a><br /></td></tr>
<tr class="separator:a1c6dfee4004fe0e9b9f90720bad73ecb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfe10086430b562b8df4e45668b51927"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#adfe10086430b562b8df4e45668b51927">mrmsg_get_width</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:adfe10086430b562b8df4e45668b51927"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get width of image or video. <a href="#adfe10086430b562b8df4e45668b51927">More...</a><br /></td></tr>
<tr class="separator:adfe10086430b562b8df4e45668b51927"><td class="memSeparator" colspan="2">&#160;</td></tr>
@ -139,9 +139,9 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a7f1bd3d845bbc5face7636aed8f8afd4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a7f1bd3d845bbc5face7636aed8f8afd4">mrmsg_get_showpadlock</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:a7f1bd3d845bbc5face7636aed8f8afd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a padlock should be shown beside the message. <a href="#a7f1bd3d845bbc5face7636aed8f8afd4">More...</a><br /></td></tr>
<tr class="separator:a7f1bd3d845bbc5face7636aed8f8afd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc3d94448ada0ad7142cf168cab1462e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrpoortext__t.html">mrpoortext_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#afc3d94448ada0ad7142cf168cab1462e">mrmsg_get_summary</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg, <a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:afc3d94448ada0ad7142cf168cab1462e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a summary for a message. <a href="#afc3d94448ada0ad7142cf168cab1462e">More...</a><br /></td></tr>
<tr class="separator:afc3d94448ada0ad7142cf168cab1462e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c14a8dbd6cc7f90c642223a873312e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrlot__t.html">mrlot_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a3c14a8dbd6cc7f90c642223a873312e3">mrmsg_get_summary</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg, <a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:a3c14a8dbd6cc7f90c642223a873312e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a summary for a message. <a href="#a3c14a8dbd6cc7f90c642223a873312e3">More...</a><br /></td></tr>
<tr class="separator:a3c14a8dbd6cc7f90c642223a873312e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c8c1f342f01439ae40c5cf37532387e"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a8c8c1f342f01439ae40c5cf37532387e">mrmsg_get_summarytext</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg, int approx_characters)</td></tr>
<tr class="memdesc:a8c8c1f342f01439ae40c5cf37532387e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a message summary as a single line of text. <a href="#a8c8c1f342f01439ae40c5cf37532387e">More...</a><br /></td></tr>
<tr class="separator:a8c8c1f342f01439ae40c5cf37532387e"><td class="memSeparator" colspan="2">&#160;</td></tr>
@ -425,12 +425,12 @@ Public Attributes</h2></td></tr>
</div>
</div>
<a class="anchor" id="ad87b7df007489b3a47c3fde79978a58a"></a>
<a class="anchor" id="a1c6dfee4004fe0e9b9f90720bad73ecb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmrpoortext__t.html">mrpoortext_t</a> * mrmsg_get_mediainfo </td>
<td class="memname"><a class="el" href="structmrlot__t.html">mrlot_t</a> * mrmsg_get_mediainfo </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>
@ -440,17 +440,19 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Get real author and title. </p>
<p>The information is returned by a <a class="el" href="structmrlot__t.html" title="An object containing a set of values. ">mrlot_t</a> object with the following fields:</p>
<ul>
<li>For voice messages, the author is the sender and the trackname is the sending time.</li>
<li>For music messages and videos, we read the information from the filename (we do not read ID3 and such at this stage, the needed libraries are too complicated and oversized. However, this is no big problem, as the sender usually sets the filename in a way we expect it)</li>
<li><a class="el" href="structmrlot__t.html#afa71b7a11147bc6e73313986a08fdcd7" title="The meaning of this string is defined by the creator of the object. ">mrlot_t::m_text1</a>: Author of the media. For voice messages, this is the sender. For music messages, the information are read from the filename. NULL if unknown.</li>
<li><a class="el" href="structmrlot__t.html#ad894f96fe9a1672808944fdb0ba04628" title="The meaning of this string is defined by the creator of the object. ">mrlot_t::m_text2</a>: Title of the media. For voice messages, this is the date. For music messages, the information are read from the filename. NULL if unknown.</li>
</ul>
<p>Currently, we do not read ID3 and such at this stage, the needed libraries are too complicated and oversized. However, this is no big problem, as the sender usually sets the filename in a way we expect it.</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><a class="el" href="structmrpoortext__t.html" title="An object representing text with some attributes. ">mrpoortext_t</a> object that contains the author as <a class="el" href="structmrpoortext__t.html#af3b56661ccf1c783f397c15c310cf36f" title="The meaning is defined by m_text1_meaning and by the creator of the object. ">mrpoortext_t::m_text1</a> and the title as <a class="el" href="structmrpoortext__t.html#a54e10365f38dddd070a2ab68f4177331" title="The meaning is defined by the creator of the object. ">mrpoortext_t::m_text2</a>. Both may be NULL if unknown. The returned object must be freed using <a class="el" href="structmrpoortext__t.html#a89c28735bfd718051ffc6b742f9c10ed" title="Frees a poortext object. ">mrpoortext_unref()</a> when no longer used. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>Media information as an <a class="el" href="structmrlot__t.html" title="An object containing a set of values. ">mrlot_t</a> object. Must be freed using <a class="el" href="structmrlot__t.html#a813e4d0c2f135e962cc4d5ac0753c592" title="Frees an object containing a set of parameters. ">mrlot_unref()</a>. NULL is never returned. </dd></dl>
</div>
</div>
@ -562,12 +564,12 @@ Public Attributes</h2></td></tr>
</div>
</div>
<a class="anchor" id="afc3d94448ada0ad7142cf168cab1462e"></a>
<a class="anchor" id="a3c14a8dbd6cc7f90c642223a873312e3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmrpoortext__t.html">mrpoortext_t</a> * mrmsg_get_summary </td>
<td class="memname"><a class="el" href="structmrlot__t.html">mrlot_t</a> * mrmsg_get_summary </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>
@ -587,7 +589,15 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Get a summary for a message. </p>
<p>Typically used to display a search result.</p>
<p>The summary is returned by a <a class="el" href="structmrlot__t.html" title="An object containing a set of values. ">mrlot_t</a> object with the following fields:</p>
<ul>
<li><a class="el" href="structmrlot__t.html#afa71b7a11147bc6e73313986a08fdcd7" title="The meaning of this string is defined by the creator of the object. ">mrlot_t::m_text1</a>: contains the username or the string "Me". The string may be colored by having a look at m_text1_meaning. If the name should not be displayed, the element is NULL.</li>
<li><a class="el" href="structmrlot__t.html#a38067382d835f912ad1d4f7350306dc0" title="The meaning of this value is defined by the creator of the object. ">mrlot_t::m_text1_meaning</a>: one of MR_TEXT1_USERNAME or MR_TEXT1_SELF. Typically used to show <a class="el" href="structmrlot__t.html#afa71b7a11147bc6e73313986a08fdcd7" title="The meaning of this string is defined by the creator of the object. ">mrlot_t::m_text1</a> with different colors. 0 if not applicable.</li>
<li><a class="el" href="structmrlot__t.html#ad894f96fe9a1672808944fdb0ba04628" title="The meaning of this string is defined by the creator of the object. ">mrlot_t::m_text2</a>: contains an excerpt of the message text.</li>
<li><a class="el" href="structmrlot__t.html#af71c6758491ef50b7c25a11c0d9fee17" title="The meaning of this value is defined by the creator of the object. ">mrlot_t::m_timestamp</a>: the timestamp of the message.</li>
<li><a class="el" href="structmrlot__t.html#acc3e27731b8dbe46733cab6001032f9a" title="The meaning of this value is defined by the creator of the object. ">mrlot_t::m_state</a>: The state of the message as one of the MR_STATE_* constants (see <a class="el" href="structmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5" title="Get the state of a message. ">mrmsg_get_state()</a>).</li>
</ul>
<p>Typically used to display a search result. See also <a class="el" href="structmrchatlist__t.html#a7bb0e80673ca253c7cb71ae6b9d4fa97" title="Get a summary for a chatlist index. ">mrchatlist_get_summary()</a> to display a list of chats.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object.</td></tr>
@ -595,7 +605,7 @@ Public Attributes</h2></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The returned summary is similar to <a class="el" href="structmrchatlist__t.html#ae7670d62ab7fc83aff18f299f26853d8" title="Get a summary for a chatlist index. ">mrchatlist_get_summary()</a>, however, without "draft", "no messages" and so on. The result must be freed using <a class="el" href="structmrpoortext__t.html#a89c28735bfd718051ffc6b742f9c10ed" title="Frees a poortext object. ">mrpoortext_unref()</a>. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The summary as an <a class="el" href="structmrlot__t.html" title="An object containing a set of values. ">mrlot_t</a> object. Must be freed using <a class="el" href="structmrlot__t.html#a813e4d0c2f135e962cc4d5ac0753c592" title="Frees an object containing a set of parameters. ">mrlot_unref()</a>. NULL is never returned. </dd></dl>
</div>
</div>