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
deltachat-core/docs/html/structmrpoortext__t.html
B. Petersen 25f5a0ba1f Doxygen
2017-11-21 23:06:56 +01:00

245 lines
12 KiB
HTML
Raw Blame History

<!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: mrpoortext_t Struct 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&#160;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&#160;List</span></a></li>
<li><a href="functions.html"><span>Class&#160;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> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structmrpoortext__t-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mrpoortext_t Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>An object representing text with some attributes.
<a href="structmrpoortext__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="mrpoortext_8h_source.html">mrpoortext.h</a>&gt;</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:a89c28735bfd718051ffc6b742f9c10ed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpoortext__t.html#a89c28735bfd718051ffc6b742f9c10ed">mrpoortext_unref</a> (<a class="el" href="structmrpoortext__t.html">mrpoortext_t</a> *poortext)</td></tr>
<tr class="memdesc:a89c28735bfd718051ffc6b742f9c10ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees a poortext object. <a href="#a89c28735bfd718051ffc6b742f9c10ed">More...</a><br /></td></tr>
<tr class="separator:a89c28735bfd718051ffc6b742f9c10ed"><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>
<tr class="memitem:a39469bd76b12fc8da2c3341433cab893"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpoortext__t.html#a39469bd76b12fc8da2c3341433cab893">m_text1_meaning</a></td></tr>
<tr class="memdesc:a39469bd76b12fc8da2c3341433cab893"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines the meaning of the m_text1 string. <a href="#a39469bd76b12fc8da2c3341433cab893">More...</a><br /></td></tr>
<tr class="separator:a39469bd76b12fc8da2c3341433cab893"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3b56661ccf1c783f397c15c310cf36f"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpoortext__t.html#af3b56661ccf1c783f397c15c310cf36f">m_text1</a></td></tr>
<tr class="memdesc:af3b56661ccf1c783f397c15c310cf36f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The meaning is defined by m_text1_meaning and by the creator of the object. <a href="#af3b56661ccf1c783f397c15c310cf36f">More...</a><br /></td></tr>
<tr class="separator:af3b56661ccf1c783f397c15c310cf36f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54e10365f38dddd070a2ab68f4177331"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpoortext__t.html#a54e10365f38dddd070a2ab68f4177331">m_text2</a></td></tr>
<tr class="memdesc:a54e10365f38dddd070a2ab68f4177331"><td class="mdescLeft">&#160;</td><td class="mdescRight">The meaning is defined by the creator of the object. <a href="#a54e10365f38dddd070a2ab68f4177331">More...</a><br /></td></tr>
<tr class="separator:a54e10365f38dddd070a2ab68f4177331"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a372913d9a39616e48722ea04c759f887"><td class="memItemLeft" align="right" valign="top">time_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpoortext__t.html#a372913d9a39616e48722ea04c759f887">m_timestamp</a></td></tr>
<tr class="memdesc:a372913d9a39616e48722ea04c759f887"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typically a message timestamp. <a href="#a372913d9a39616e48722ea04c759f887">More...</a><br /></td></tr>
<tr class="separator:a372913d9a39616e48722ea04c759f887"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbf2ae7473784db66127e63657e04f60"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpoortext__t.html#afbf2ae7473784db66127e63657e04f60">m_state</a></td></tr>
<tr class="memdesc:afbf2ae7473784db66127e63657e04f60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typically a MR_MSG_STATE_* constant. <a href="#afbf2ae7473784db66127e63657e04f60">More...</a><br /></td></tr>
<tr class="separator:afbf2ae7473784db66127e63657e04f60"><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>An object representing text with some attributes. </p>
<p>A poortext object contains some strings together with their meaning and some attributes. Poortext objects are returned eg. from <a class="el" href="structmrchatlist__t.html#ae7670d62ab7fc83aff18f299f26853d8" title="Get a summary for a chatlist index. ">mrchatlist_get_summary()</a> or <a class="el" href="structmrmsg__t.html#afc3d94448ada0ad7142cf168cab1462e" title="Get a summary for a message. ">mrmsg_get_summary()</a>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a89c28735bfd718051ffc6b742f9c10ed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpoortext_unref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrpoortext__t.html">mrpoortext_t</a> *&#160;</td>
<td class="paramname"><em>poortext</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees a poortext object. </p>
<p>Poortext objects are typically created by <a class="el" href="structmrchatlist__t.html#ae7670d62ab7fc83aff18f299f26853d8" title="Get a summary for a chatlist index. ">mrchatlist_get_summary()</a> or by <a class="el" href="structmrmsg__t.html#afc3d94448ada0ad7142cf168cab1462e" title="Get a summary for a message. ">mrmsg_get_summary()</a>. This also frees the strings objects.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">poortext</td><td>The <a class="el" href="structmrpoortext__t.html" title="An object representing text with some attributes. ">mrpoortext_t</a> object to free.</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>
<a class="anchor" id="a39469bd76b12fc8da2c3341433cab893"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrpoortext_t::m_text1_meaning</td>
</tr>
</table>
</div><div class="memdoc">
<p>Defines the meaning of the m_text1 string. </p>
<ul>
<li>MR_TEXT1_NORMAL (0) = m_text1 is a normal text field.</li>
<li>MR_TEXT1_DRAFT = m_text1 is the string "Draft", typically, this is shown in another color.</li>
<li>MR_TEXT1_USERNAME = m_text1 is a username, typically, this is shown in another color.</li>
<li>MR_TEXT1_SELF = m_text1 is the string "Me", typically, this is shown in another color. </li>
</ul>
</div>
</div>
<a class="anchor" id="af3b56661ccf1c783f397c15c310cf36f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mrpoortext_t::m_text1</td>
</tr>
</table>
</div><div class="memdoc">
<p>The meaning is defined by m_text1_meaning and by the creator of the object. </p>
<p>May be NULL. </p>
</div>
</div>
<a class="anchor" id="a54e10365f38dddd070a2ab68f4177331"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mrpoortext_t::m_text2</td>
</tr>
</table>
</div><div class="memdoc">
<p>The meaning is defined by the creator of the object. </p>
<p>May be NULL. </p>
</div>
</div>
<a class="anchor" id="a372913d9a39616e48722ea04c759f887"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">time_t mrpoortext_t::m_timestamp</td>
</tr>
</table>
</div><div class="memdoc">
<p>Typically a message timestamp. </p>
<p>The concrete meaning is defined by the creator of the object. May be 0. </p>
</div>
</div>
<a class="anchor" id="afbf2ae7473784db66127e63657e04f60"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrpoortext_t::m_state</td>
</tr>
</table>
</div><div class="memdoc">
<p>Typically a MR_MSG_STATE_* constant. </p>
<p>May be 0. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>/home/bpetersen/projects/deltachat-core/src/<a class="el" href="mrpoortext_8h_source.html">mrpoortext.h</a></li>
<li>/home/bpetersen/projects/deltachat-core/src/mrpoortext.c</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink