aboutsummaryrefslogtreecommitdiff
path: root/doc/html/QXmppMessage_8h_source.html
blob: 536893b01890365dc6756c0e14e82152ed7d03dd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>QXmpp: QXmppMessage.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</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">
        <img id="MSearchSelect" src="search/search.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)"/>
        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
        </div>
      </li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
    </ul>
  </div>
<h1>QXmppMessage.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2008-2010 The QXmpp developers</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Author:</span>
<a name="l00005"></a>00005 <span class="comment"> *  Manjeet Dahiya</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * Source:</span>
<a name="l00008"></a>00008 <span class="comment"> *  http://code.google.com/p/qxmpp</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * This file is a part of QXmpp library.</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00013"></a>00013 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00014"></a>00014 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00015"></a>00015 <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * This library is distributed in the hope that it will be useful,</span>
<a name="l00018"></a>00018 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00019"></a>00019 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00020"></a>00020 <span class="comment"> * Lesser General Public License for more details.</span>
<a name="l00021"></a>00021 <span class="comment"> *</span>
<a name="l00022"></a>00022 <span class="comment"> */</span>
<a name="l00023"></a>00023 
<a name="l00024"></a>00024 
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef QXMPPMESSAGE_H</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define QXMPPMESSAGE_H</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;QDateTime&gt;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &quot;QXmppStanza.h&quot;</span>
<a name="l00030"></a>00030 
<a name="l00035"></a>00035 
<a name="l00036"></a><a class="code" href="classQXmppMessage.html">00036</a> <span class="keyword">class </span><a class="code" href="classQXmppMessage.html" title="The QXmppMessage class represents an XMPP message.">QXmppMessage</a> : <span class="keyword">public</span> <a class="code" href="classQXmppStanza.html" title="The QXmppStanza class is the base class for all XMPP stanzas.">QXmppStanza</a>
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 <span class="keyword">public</span>:
<a name="l00040"></a><a class="code" href="classQXmppMessage.html#ac91ae4671526e44e51b18449005b224b">00040</a>     <span class="keyword">enum</span> <a class="code" href="classQXmppMessage.html#ac91ae4671526e44e51b18449005b224b" title="This enum described a message type.">Type</a>
<a name="l00041"></a>00041     {
<a name="l00042"></a>00042         Error = 0,
<a name="l00043"></a>00043         Normal,
<a name="l00044"></a>00044         Chat,
<a name="l00045"></a>00045         GroupChat,
<a name="l00046"></a>00046         Headline
<a name="l00047"></a>00047     };
<a name="l00048"></a>00048 
<a name="l00051"></a><a class="code" href="classQXmppMessage.html#aeaa3cc5ccb7d451067a80dd1f3c7099a">00051</a>     <span class="keyword">enum</span> <a class="code" href="classQXmppMessage.html#aeaa3cc5ccb7d451067a80dd1f3c7099a">State</a>
<a name="l00052"></a>00052     {
<a name="l00053"></a>00053         None = 0,
<a name="l00054"></a>00054         Active,
<a name="l00055"></a>00055         Inactive,
<a name="l00056"></a>00056         Gone,
<a name="l00057"></a>00057         Composing,
<a name="l00058"></a>00058         Paused,
<a name="l00059"></a>00059     };
<a name="l00060"></a>00060 
<a name="l00061"></a>00061     <a class="code" href="classQXmppMessage.html" title="The QXmppMessage class represents an XMPP message.">QXmppMessage</a>(<span class="keyword">const</span> QString&amp; <a class="code" href="classQXmppStanza.html#a2e68644ae328ff374ffc5115597a525e" title="Returns the stanza&amp;#39;s sender JID.">from</a> = <span class="stringliteral">&quot;&quot;</span>, <span class="keyword">const</span> QString&amp; <a class="code" href="classQXmppStanza.html#a45ab4c2f04d712ee93df5d0e4b2c03a4">to</a> = <span class="stringliteral">&quot;&quot;</span>,
<a name="l00062"></a>00062                  <span class="keyword">const</span> QString&amp; <a class="code" href="classQXmppMessage.html#aac3e82974ab462b12b4de2493dc2467c">body</a> = <span class="stringliteral">&quot;&quot;</span>, <span class="keyword">const</span> QString&amp; <a class="code" href="classQXmppMessage.html#a048b9b4a4d768e00dd54d731678ae6b1" title="Returns the message&amp;#39;s thread.">thread</a> = <span class="stringliteral">&quot;&quot;</span>);
<a name="l00063"></a>00063     ~<a class="code" href="classQXmppMessage.html" title="The QXmppMessage class represents an XMPP message.">QXmppMessage</a>();
<a name="l00064"></a>00064     
<a name="l00065"></a>00065     QString <a class="code" href="classQXmppMessage.html#aac3e82974ab462b12b4de2493dc2467c">body</a>() <span class="keyword">const</span>;
<a name="l00066"></a>00066     <span class="keywordtype">void</span> <a class="code" href="classQXmppMessage.html#adfc1b70b910079c76c93ba472fc4e9e7">setBody</a>(<span class="keyword">const</span> QString&amp;);
<a name="l00067"></a>00067 
<a name="l00068"></a>00068     QDateTime <a class="code" href="classQXmppMessage.html#a75532528f320e94dc030f4a6e7ea9fbc" title="Returns the message&amp;#39;s timestamp (if any).">stamp</a>() <span class="keyword">const</span>;
<a name="l00069"></a>00069     <span class="keywordtype">void</span> <a class="code" href="classQXmppMessage.html#a9f2a9f5b56fa023f649c372f95fbf1af">setStamp</a>(<span class="keyword">const</span> QDateTime &amp;<a class="code" href="classQXmppMessage.html#a75532528f320e94dc030f4a6e7ea9fbc" title="Returns the message&amp;#39;s timestamp (if any).">stamp</a>);
<a name="l00070"></a>00070 
<a name="l00071"></a>00071     <a class="code" href="classQXmppMessage.html#aeaa3cc5ccb7d451067a80dd1f3c7099a">QXmppMessage::State</a> <a class="code" href="classQXmppMessage.html#af90654a174ae92bb7904ed01b4d81dc4">state</a>() <span class="keyword">const</span>;
<a name="l00072"></a>00072     <span class="keywordtype">void</span> <a class="code" href="classQXmppMessage.html#a3859bd7236f3bc19f908cec612c295d2">setState</a>(<a class="code" href="classQXmppMessage.html#aeaa3cc5ccb7d451067a80dd1f3c7099a">QXmppMessage::State</a>);
<a name="l00073"></a>00073 
<a name="l00074"></a>00074     QString <a class="code" href="classQXmppMessage.html#a4f7723d2f97362965151e32f666d4739">subject</a>() <span class="keyword">const</span>;
<a name="l00075"></a>00075     <span class="keywordtype">void</span> <a class="code" href="classQXmppMessage.html#a4b2b4eb5c07495d28c70ebf660bf32fd">setSubject</a>(<span class="keyword">const</span> QString&amp;);
<a name="l00076"></a>00076 
<a name="l00077"></a>00077     QString <a class="code" href="classQXmppMessage.html#a048b9b4a4d768e00dd54d731678ae6b1" title="Returns the message&amp;#39;s thread.">thread</a>() <span class="keyword">const</span>;
<a name="l00078"></a>00078     <span class="keywordtype">void</span> <a class="code" href="classQXmppMessage.html#a36ed8d1190f50b78af05ce806c1e90a6">setThread</a>(<span class="keyword">const</span> QString&amp;);
<a name="l00079"></a>00079 
<a name="l00080"></a>00080     <a class="code" href="classQXmppMessage.html#ac91ae4671526e44e51b18449005b224b" title="This enum described a message type.">QXmppMessage::Type</a> <a class="code" href="classQXmppMessage.html#a4a2f12c298b498489077b120855a96b0">type</a>() <span class="keyword">const</span>;
<a name="l00081"></a>00081     <span class="keywordtype">void</span> <a class="code" href="classQXmppMessage.html#a794cd10f4265b4b7d9ef5e9fb6e0c9f0">setType</a>(<a class="code" href="classQXmppMessage.html#ac91ae4671526e44e51b18449005b224b" title="This enum described a message type.">QXmppMessage::Type</a>);
<a name="l00082"></a>00082 
<a name="l00084"></a>00084     <span class="keywordtype">void</span> parse(<span class="keyword">const</span> QDomElement &amp;element);
<a name="l00085"></a>00085     <span class="keywordtype">void</span> toXml(QXmlStreamWriter *writer) <span class="keyword">const</span>;
<a name="l00086"></a>00086 
<a name="l00087"></a>00087     <span class="comment">// deprecated accessors, use the form without &quot;get&quot; instead</span>
<a name="l00088"></a>00088     <a class="code" href="classQXmppMessage.html#ac91ae4671526e44e51b18449005b224b" title="This enum described a message type.">QXmppMessage::Type</a> Q_DECL_DEPRECATED getType() <span class="keyword">const</span>;
<a name="l00089"></a>00089     <a class="code" href="classQXmppMessage.html#aeaa3cc5ccb7d451067a80dd1f3c7099a">QXmppMessage::State</a> Q_DECL_DEPRECATED getState() <span class="keyword">const</span>;
<a name="l00090"></a>00090     QString Q_DECL_DEPRECATED getBody() <span class="keyword">const</span>;
<a name="l00091"></a>00091     QString Q_DECL_DEPRECATED getSubject() <span class="keyword">const</span>;
<a name="l00092"></a>00092     QString Q_DECL_DEPRECATED getThread() <span class="keyword">const</span>;
<a name="l00094"></a>00094 
<a name="l00095"></a>00095 <span class="keyword">private</span>:
<a name="l00097"></a>00097     <span class="keyword">enum</span> StampType
<a name="l00098"></a>00098     {
<a name="l00099"></a>00099         LegacyDelayedDelivery,  
<a name="l00100"></a>00100         DelayedDelivery,        
<a name="l00101"></a>00101     };
<a name="l00102"></a>00102 
<a name="l00103"></a>00103     QString getTypeStr() <span class="keyword">const</span>;
<a name="l00104"></a>00104     <span class="keywordtype">void</span> setTypeFromStr(<span class="keyword">const</span> QString&amp;);
<a name="l00105"></a>00105 
<a name="l00106"></a>00106     <a class="code" href="classQXmppMessage.html#ac91ae4671526e44e51b18449005b224b" title="This enum described a message type.">Type</a> m_type;
<a name="l00107"></a>00107     QDateTime m_stamp;
<a name="l00108"></a>00108     StampType m_stampType;
<a name="l00109"></a>00109     State m_state;
<a name="l00110"></a>00110 
<a name="l00111"></a>00111     QString m_body;
<a name="l00112"></a>00112     QString m_subject;
<a name="l00113"></a>00113     QString m_thread;
<a name="l00114"></a>00114 };
<a name="l00115"></a>00115 
<a name="l00116"></a>00116 <span class="preprocessor">#endif // QXMPPMESSAGE_H</span>
</pre></div></div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Enumerator</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 22 00:44:23 2010 for QXmpp by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>