mirror of
https://github.com/deltachat/deltachat-core.git
synced 2025-10-04 18:29:19 +02:00
111 lines
23 KiB
HTML
111 lines
23 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-Library: /home/bpetersen/projects/deltachat-core/src/mrchat.h Source File</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-Library
|
|
</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><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><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="files.html"><span>File List</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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">mrchat.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*******************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Delta Chat Core</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (C) 2017 Björn Petersen</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Contact: r10s@b44t.com, http://b44t.com</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * This program is free software: you can redistribute it and/or modify it under</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * the terms of the GNU General Public License as published by the Free Software</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Foundation, either version 3 of the License, or (at your option) any later</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * version.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * This program is distributed in the hope that it will be useful, but WITHOUT</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * details.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * You should have received a copy of the GNU General Public License along with</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * this program. If not, see http://www.gnu.org/licenses/ .</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> ******************************************************************************/</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef __MRCHAT_H__</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define __MRCHAT_H__</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structmrmailbox__t.html">mrmailbox_t</a> <a class="code" href="structmrmailbox__t.html">mrmailbox_t</a>;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structmrparam__t.html">mrparam_t</a> <a class="code" href="structmrparam__t.html">mrparam_t</a>;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structmrchat__t.html"> 39</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structmrchat__t.html">mrchat_t</a></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"> #define MR_CHAT_ID_DEADDROP 1 </span><span class="comment">/* messages send from unknown/unwanted users to us, chats_contacts is not set up. This group may be shown normally. */</span><span class="preprocessor"></span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"> #define MR_CHAT_ID_TO_DEADDROP 2 </span><span class="comment">/* messages send from us to unknown/unwanted users (this may happen when deleting chats or when using CC: in the email-program) */</span><span class="preprocessor"></span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"> #define MR_CHAT_ID_TRASH 3 </span><span class="comment">/* messages that should be deleted get this chat_id; the messages are deleted from the working thread later then. This is also needed as rfc724_mid should be preset as long as the message is not deleted on the server (otherwise it is downloaded again) */</span><span class="preprocessor"></span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"> #define MR_CHAT_ID_MSGS_IN_CREATION 4 </span><span class="comment">/* a message is just in creation but not yet assigned to a chat (eg. we may need the message ID to set up blobs; this avoids unready message to be send and shown) */</span><span class="preprocessor"></span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"> #define MR_CHAT_ID_STARRED 5 </span><span class="comment">/* virtual chat containing all starred messages */</span><span class="preprocessor"></span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"> #define MR_CHAT_ID_ARCHIVED_LINK 6 </span><span class="comment">/* a link at the end of the chatlist, if present the UI should show the button "Archived chats" */</span><span class="preprocessor"></span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor"> #define MR_CHAT_ID_LAST_SPECIAL 9 </span><span class="comment">/* larger chat IDs are "real" chats, their messages are "real" messages. */</span><span class="preprocessor"></span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  uint32_t m_id;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor"> #define MR_CHAT_TYPE_UNDEFINED 0</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"> #define MR_CHAT_TYPE_NORMAL 100 </span><span class="comment">/* a normal chat is a chat with a single contact, chats_contacts contains one record for the user, MR_CONTACT_ID_SELF is not added. */</span><span class="preprocessor"></span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor"> #define MR_CHAT_TYPE_GROUP 120 </span><span class="comment">/* a group chat, chats_contacts conain all group members, incl. MR_CONTACT_ID_SELF */</span><span class="preprocessor"></span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">int</span> m_type;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structmrchat__t.html#abbd344d8d361a1a4d14bfc9b5dc57140"> 55</a></span>  <span class="keywordtype">char</span>* <a class="code" href="structmrchat__t.html#abbd344d8d361a1a4d14bfc9b5dc57140">m_name</a>; </div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structmrchat__t.html#a565101f53278f5ab1ff58317ffc9555c"> 56</a></span>  time_t <a class="code" href="structmrchat__t.html#a565101f53278f5ab1ff58317ffc9555c">m_draft_timestamp</a>; </div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structmrchat__t.html#abe916f48ac83c2ca6476312eae084cfa"> 57</a></span>  <span class="keywordtype">char</span>* <a class="code" href="structmrchat__t.html#abe916f48ac83c2ca6476312eae084cfa">m_draft_text</a>; </div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structmrchat__t.html#abf3e1a34f567e168bc0597f9a544a50d"> 58</a></span>  <a class="code" href="structmrmailbox__t.html">mrmailbox_t</a>* <a class="code" href="structmrchat__t.html#abf3e1a34f567e168bc0597f9a544a50d">m_mailbox</a>; </div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structmrchat__t.html#a5b28b343ceb290d4a613d0e5a7d528bc"> 59</a></span>  <span class="keywordtype">int</span> <a class="code" href="structmrchat__t.html#a5b28b343ceb290d4a613d0e5a7d528bc">m_archived</a>; </div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structmrchat__t.html#ad2792ee7df778521de61087bc79795a7"> 60</a></span>  <a class="code" href="structmrparam__t.html">mrparam_t</a>* <a class="code" href="structmrchat__t.html#ad2792ee7df778521de61087bc79795a7">m_param</a>; </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">char</span>* m_grpid; <span class="comment">/* NULL if unset */</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> } <a class="code" href="structmrchat__t.html">mrchat_t</a>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <a class="code" href="structmrchat__t.html">mrchat_t</a>* mrchat_new (<a class="code" href="structmrmailbox__t.html">mrmailbox_t</a>*);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keywordtype">void</span> <a class="code" href="structmrchat__t.html#af0d39be9ac9885810d8765053cfb81eb">mrchat_empty</a> (<a class="code" href="structmrchat__t.html">mrchat_t</a>*);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keywordtype">void</span> <a class="code" href="structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9">mrchat_unref</a> (<a class="code" href="structmrchat__t.html">mrchat_t</a>*);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keywordtype">char</span>* <a class="code" href="structmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08">mrchat_get_subtitle</a> (<a class="code" href="structmrchat__t.html">mrchat_t</a>*);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">/* library-internal */</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">int</span> mrchat_load_from_db__ (<a class="code" href="structmrchat__t.html">mrchat_t</a>*, uint32_t <span class="keywordtype">id</span>);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">int</span> mrchat_update_param__ (<a class="code" href="structmrchat__t.html">mrchat_t</a>*);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#define MR_CHAT_PREFIX "Chat:" </span><span class="comment">/* you MUST NOT modify this or the following strings */</span><span class="preprocessor"></span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#define MR_CHATS_FOLDER "Chats" </span><span class="comment">/* if we want to support Gma'l-labels - "Chats" is a reserved word for Gma'l */</span><span class="preprocessor"></span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> } <span class="comment">/* /extern "C" */</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#endif </span><span class="comment">/* __MRCHAT_H__ */</span><span class="preprocessor"></span></div><div class="ttc" id="structmrmailbox__t_html"><div class="ttname"><a href="structmrmailbox__t.html">mrmailbox_t</a></div><div class="ttdoc">An object representing a single mailbox. </div><div class="ttdef"><b>Definition:</b> <a href="mrmailbox_8h_source.html#l00141">mrmailbox.h:141</a></div></div>
|
|
<div class="ttc" id="structmrchat__t_html_a3b1befb4542c1bad915f2175c7c2a2b9"><div class="ttname"><a href="structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9">mrchat_t::mrchat_unref</a></div><div class="ttdeci">void mrchat_unref(mrchat_t *chat)</div><div class="ttdoc">Free a chat object. </div><div class="ttdef"><b>Definition:</b> <a href="mrchat_8c_source.html#l00160">mrchat.c:160</a></div></div>
|
|
<div class="ttc" id="structmrchat__t_html_abe916f48ac83c2ca6476312eae084cfa"><div class="ttname"><a href="structmrchat__t.html#abe916f48ac83c2ca6476312eae084cfa">mrchat_t::m_draft_text</a></div><div class="ttdeci">char * m_draft_text</div><div class="ttdoc">NULL if unset. </div><div class="ttdef"><b>Definition:</b> <a href="mrchat_8h_source.html#l00057">mrchat.h:57</a></div></div>
|
|
<div class="ttc" id="structmrchat__t_html_abf3e1a34f567e168bc0597f9a544a50d"><div class="ttname"><a href="structmrchat__t.html#abf3e1a34f567e168bc0597f9a544a50d">mrchat_t::m_mailbox</a></div><div class="ttdeci">mrmailbox_t * m_mailbox</div><div class="ttdoc">!= NULL </div><div class="ttdef"><b>Definition:</b> <a href="mrchat_8h_source.html#l00058">mrchat.h:58</a></div></div>
|
|
<div class="ttc" id="structmrchat__t_html_ad2792ee7df778521de61087bc79795a7"><div class="ttname"><a href="structmrchat__t.html#ad2792ee7df778521de61087bc79795a7">mrchat_t::m_param</a></div><div class="ttdeci">mrparam_t * m_param</div><div class="ttdoc">!= NULL </div><div class="ttdef"><b>Definition:</b> <a href="mrchat_8h_source.html#l00060">mrchat.h:60</a></div></div>
|
|
<div class="ttc" id="structmrchat__t_html_a5b28b343ceb290d4a613d0e5a7d528bc"><div class="ttname"><a href="structmrchat__t.html#a5b28b343ceb290d4a613d0e5a7d528bc">mrchat_t::m_archived</a></div><div class="ttdeci">int m_archived</div><div class="ttdoc">1=chat archived, this state should always be shown the UI, eg. </div><div class="ttdef"><b>Definition:</b> <a href="mrchat_8h_source.html#l00059">mrchat.h:59</a></div></div>
|
|
<div class="ttc" id="structmrchat__t_html_abbd344d8d361a1a4d14bfc9b5dc57140"><div class="ttname"><a href="structmrchat__t.html#abbd344d8d361a1a4d14bfc9b5dc57140">mrchat_t::m_name</a></div><div class="ttdeci">char * m_name</div><div class="ttdoc">NULL if unset. </div><div class="ttdef"><b>Definition:</b> <a href="mrchat_8h_source.html#l00055">mrchat.h:55</a></div></div>
|
|
<div class="ttc" id="structmrparam__t_html"><div class="ttname"><a href="structmrparam__t.html">mrparam_t</a></div><div class="ttdoc">An object for handling key=value parameter lists. </div><div class="ttdef"><b>Definition:</b> <a href="mrparam_8h_source.html#l00036">mrparam.h:36</a></div></div>
|
|
<div class="ttc" id="structmrchat__t_html_af0d39be9ac9885810d8765053cfb81eb"><div class="ttname"><a href="structmrchat__t.html#af0d39be9ac9885810d8765053cfb81eb">mrchat_t::mrchat_empty</a></div><div class="ttdeci">void mrchat_empty(mrchat_t *ths)</div><div class="ttdoc">Empty a chat object. </div><div class="ttdef"><b>Definition:</b> <a href="mrchat_8c_source.html#l00181">mrchat.c:181</a></div></div>
|
|
<div class="ttc" id="structmrchat__t_html_a565101f53278f5ab1ff58317ffc9555c"><div class="ttname"><a href="structmrchat__t.html#a565101f53278f5ab1ff58317ffc9555c">mrchat_t::m_draft_timestamp</a></div><div class="ttdeci">time_t m_draft_timestamp</div><div class="ttdoc">0 if there is no draft </div><div class="ttdef"><b>Definition:</b> <a href="mrchat_8h_source.html#l00056">mrchat.h:56</a></div></div>
|
|
<div class="ttc" id="structmrchat__t_html"><div class="ttname"><a href="structmrchat__t.html">mrchat_t</a></div><div class="ttdoc">An object representing a single chat in memory. </div><div class="ttdef"><b>Definition:</b> <a href="mrchat_8h_source.html#l00039">mrchat.h:39</a></div></div>
|
|
<div class="ttc" id="structmrchat__t_html_ae1e9920618c9f6cb8ad66d5bb6962a08"><div class="ttname"><a href="structmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08">mrchat_t::mrchat_get_subtitle</a></div><div class="ttdeci">char * mrchat_get_subtitle(mrchat_t *chat)</div><div class="ttdoc">Get a subtitle for a chat. </div><div class="ttdef"><b>Definition:</b> <a href="mrchat_8c_source.html#l00215">mrchat.c:215</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Tue Nov 14 2017 02:47:14 for Delta Chat Core C-Library 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>
|