mirror of
https://github.com/deltachat/deltachat-core.git
synced 2025-10-04 18:29:19 +02:00
291 lines
15 KiB
HTML
291 lines
15 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
|
<title>Delta Chat Core C-API: mrlot_t Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="user.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Delta Chat Core C-API
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classmrlot__t-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">mrlot_t Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>An object containing a set of values.
|
|
<a href="classmrlot__t.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="mrlot_8h_source.html">mrlot.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a813e4d0c2f135e962cc4d5ac0753c592"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrlot__t.html#a813e4d0c2f135e962cc4d5ac0753c592">mrlot_unref</a> (<a class="el" href="classmrlot__t.html">mrlot_t</a> *set)</td></tr>
|
|
<tr class="memdesc:a813e4d0c2f135e962cc4d5ac0753c592"><td class="mdescLeft"> </td><td class="mdescRight">Frees an object containing a set of parameters. <a href="#a813e4d0c2f135e962cc4d5ac0753c592">More...</a><br /></td></tr>
|
|
<tr class="separator:a813e4d0c2f135e962cc4d5ac0753c592"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a68c40c0b1436125972bc0f58b7840031"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrlot__t.html#a68c40c0b1436125972bc0f58b7840031">mrlot_get_text1</a> (<a class="el" href="classmrlot__t.html">mrlot_t</a> *lot)</td></tr>
|
|
<tr class="memdesc:a68c40c0b1436125972bc0f58b7840031"><td class="mdescLeft"> </td><td class="mdescRight">Get first string. <a href="#a68c40c0b1436125972bc0f58b7840031">More...</a><br /></td></tr>
|
|
<tr class="separator:a68c40c0b1436125972bc0f58b7840031"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a113bbdb7a4635831703d51e9948bc897"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrlot__t.html#a113bbdb7a4635831703d51e9948bc897">mrlot_get_text2</a> (<a class="el" href="classmrlot__t.html">mrlot_t</a> *lot)</td></tr>
|
|
<tr class="memdesc:a113bbdb7a4635831703d51e9948bc897"><td class="mdescLeft"> </td><td class="mdescRight">Get second string. <a href="#a113bbdb7a4635831703d51e9948bc897">More...</a><br /></td></tr>
|
|
<tr class="separator:a113bbdb7a4635831703d51e9948bc897"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c1780476b6b05f0a18446d10bad049e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrlot__t.html#a6c1780476b6b05f0a18446d10bad049e">mrlot_get_text1_meaning</a> (<a class="el" href="classmrlot__t.html">mrlot_t</a> *lot)</td></tr>
|
|
<tr class="memdesc:a6c1780476b6b05f0a18446d10bad049e"><td class="mdescLeft"> </td><td class="mdescRight">Get the meaning of the first string. <a href="#a6c1780476b6b05f0a18446d10bad049e">More...</a><br /></td></tr>
|
|
<tr class="separator:a6c1780476b6b05f0a18446d10bad049e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae712f421734abf829fc4e78887b2d1e2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrlot__t.html#ae712f421734abf829fc4e78887b2d1e2">mrlot_get_state</a> (<a class="el" href="classmrlot__t.html">mrlot_t</a> *lot)</td></tr>
|
|
<tr class="memdesc:ae712f421734abf829fc4e78887b2d1e2"><td class="mdescLeft"> </td><td class="mdescRight">Get the associated state. <a href="#ae712f421734abf829fc4e78887b2d1e2">More...</a><br /></td></tr>
|
|
<tr class="separator:ae712f421734abf829fc4e78887b2d1e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1fb0045f9345c27ffc57ba1ab42464b9"><td class="memItemLeft" align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrlot__t.html#a1fb0045f9345c27ffc57ba1ab42464b9">mrlot_get_timestamp</a> (<a class="el" href="classmrlot__t.html">mrlot_t</a> *lot)</td></tr>
|
|
<tr class="memdesc:a1fb0045f9345c27ffc57ba1ab42464b9"><td class="mdescLeft"> </td><td class="mdescRight">Get the associated timestamp. <a href="#a1fb0045f9345c27ffc57ba1ab42464b9">More...</a><br /></td></tr>
|
|
<tr class="separator:a1fb0045f9345c27ffc57ba1ab42464b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>An object containing a set of values. </p>
|
|
<p>The meaning of the values is defined by the function returning the set object. Set objects are created eg. by <a class="el" href="classmrchatlist__t.html#a7bb0e80673ca253c7cb71ae6b9d4fa97" title="Get a summary for a chatlist index. ">mrchatlist_get_summary()</a>, <a class="el" href="classmrmsg__t.html#a3c14a8dbd6cc7f90c642223a873312e3" title="Get a summary for a message. ">mrmsg_get_summary()</a> or by <a class="el" href="classmrmsg__t.html#a1c6dfee4004fe0e9b9f90720bad73ecb" title="Get real author and title. ">mrmsg_get_mediainfo()</a>.</p>
|
|
<p>NB: <em>Lot</em> is used in the meaning <em>heap</em> here. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a813e4d0c2f135e962cc4d5ac0753c592"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mrlot_unref </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classmrlot__t.html">mrlot_t</a> * </td>
|
|
<td class="paramname"><em>set</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Frees an object containing a set of parameters. </p>
|
|
<p>If the set object contains strings, the strings are also freed with this function. Set objects are created eg. by <a class="el" href="classmrchatlist__t.html#a7bb0e80673ca253c7cb71ae6b9d4fa97" title="Get a summary for a chatlist index. ">mrchatlist_get_summary()</a>, mrmsg_get_summary or by <a class="el" href="classmrmsg__t.html#a1c6dfee4004fe0e9b9f90720bad73ecb" title="Get real author and title. ">mrmsg_get_mediainfo()</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">set</td><td>The object to free.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a68c40c0b1436125972bc0f58b7840031"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char * mrlot_get_text1 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classmrlot__t.html">mrlot_t</a> * </td>
|
|
<td class="paramname"><em>lot</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get first string. </p>
|
|
<p>The meaning of the string is defined by the creator or the object any may be roughly described by <a class="el" href="classmrlot__t.html#a6c1780476b6b05f0a18446d10bad049e" title="Get the meaning of the first string. ">mrlot_get_text1_meaning()</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">lot</td><td>The lot object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A string, the string may be empty and the returned value must be free()'d. NULL if there is no such string. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a113bbdb7a4635831703d51e9948bc897"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char * mrlot_get_text2 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classmrlot__t.html">mrlot_t</a> * </td>
|
|
<td class="paramname"><em>lot</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get second string. </p>
|
|
<p>The meaning of the string is defined by the creator or the object.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">lot</td><td>The lot object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A string, the string may be empty and the returned value must be free()'d . NULL if there is no such string. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6c1780476b6b05f0a18446d10bad049e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int mrlot_get_text1_meaning </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classmrlot__t.html">mrlot_t</a> * </td>
|
|
<td class="paramname"><em>lot</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the meaning of the first string. </p>
|
|
<p>Posssible meanings of the string are defined by the creator or the object and may be returned eg. as MR_TEXT1_DRAFT, MR_TEXT1_USERNAME or MR_TEXT1_SELF.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">lot</td><td>The lot object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the meaning of the first string, possible meanings are defined by the creator of the object. 0 if there is no concrete meaning or on errors. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae712f421734abf829fc4e78887b2d1e2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int mrlot_get_state </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classmrlot__t.html">mrlot_t</a> * </td>
|
|
<td class="paramname"><em>lot</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the associated state. </p>
|
|
<p>The meaning of the state is defined by the creator or the object.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">lot</td><td>The lot object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The state as defined by the creator of the object. 0 if there is not state or on errors. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1fb0045f9345c27ffc57ba1ab42464b9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">time_t mrlot_get_timestamp </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classmrlot__t.html">mrlot_t</a> * </td>
|
|
<td class="paramname"><em>lot</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the associated timestamp. </p>
|
|
<p>The meaning of the timestamp is defined by the creator or the object.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">lot</td><td>The lot object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The timestamp as defined by the creator of the object. 0 if there is not timestamp or on errors. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>/home/bpetersen/projects/deltachat-core/src/<a class="el" href="mrlot_8h_source.html">mrlot.h</a></li>
|
|
<li>/home/bpetersen/projects/deltachat-core/src/mrlot.c</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|