diff options
| author | Manjeet Dahiya <manjeetdahiya@gmail.com> | 2010-08-21 19:15:30 +0000 |
|---|---|---|
| committer | Manjeet Dahiya <manjeetdahiya@gmail.com> | 2010-08-21 19:15:30 +0000 |
| commit | 93adc6aec9ba4671884d9692308b239d3064e553 (patch) | |
| tree | a5906e560045c841577473a9118ef06a39950a73 /doc/html/QXmppStanza_8h_source.html | |
| parent | ef6125a784d3b5205e92d01edf3c348cc4a473a4 (diff) | |
| download | qxmpp-93adc6aec9ba4671884d9692308b239d3064e553.tar.gz | |
add doc html
Diffstat (limited to 'doc/html/QXmppStanza_8h_source.html')
| -rw-r--r-- | doc/html/QXmppStanza_8h_source.html | 230 |
1 files changed, 230 insertions, 0 deletions
diff --git a/doc/html/QXmppStanza_8h_source.html b/doc/html/QXmppStanza_8h_source.html new file mode 100644 index 00000000..01623209 --- /dev/null +++ b/doc/html/QXmppStanza_8h_source.html @@ -0,0 +1,230 @@ +<!-- 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: QXmppStanza.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 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 List</span></a></li> + </ul> + </div> +<h1>QXmppStanza.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 QXMPPSTANZA_H</span> +<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define QXMPPSTANZA_H</span> +<a name="l00027"></a>00027 <span class="preprocessor"></span> +<a name="l00028"></a>00028 <span class="preprocessor">#include "QXmppElement.h"</span> +<a name="l00029"></a>00029 <span class="preprocessor">#include "QXmppPacket.h"</span> +<a name="l00030"></a>00030 <span class="preprocessor">#include <QString></span> +<a name="l00031"></a>00031 +<a name="l00032"></a>00032 <span class="comment">// forward declarations of QXmlStream* classes will not work on Mac, we need to</span> +<a name="l00033"></a>00033 <span class="comment">// include the whole header.</span> +<a name="l00034"></a>00034 <span class="comment">// See http://lists.trolltech.com/qt-interest/2008-07/thread00798-0.html</span> +<a name="l00035"></a>00035 <span class="comment">// for an explanation.</span> +<a name="l00036"></a>00036 <span class="preprocessor">#include <QXmlStreamWriter></span> +<a name="l00037"></a>00037 +<a name="l00039"></a>00039 +<a name="l00043"></a>00043 +<a name="l00044"></a><a class="code" href="classQXmppStanza.html">00044</a> <span class="keyword">class </span><a class="code" href="classQXmppStanza.html" title="The QXmppStanza class is the base class for all XMPP stanzas.">QXmppStanza</a> : <span class="keyword">public</span> QXmppPacket +<a name="l00045"></a>00045 { +<a name="l00046"></a>00046 <span class="keyword">public</span>: +<a name="l00047"></a>00047 <span class="keyword">class </span>Error +<a name="l00048"></a>00048 { +<a name="l00049"></a>00049 <span class="keyword">public</span>: +<a name="l00050"></a>00050 <span class="keyword">enum</span> Type +<a name="l00051"></a>00051 { +<a name="l00052"></a>00052 Cancel, +<a name="l00053"></a>00053 Continue, +<a name="l00054"></a>00054 Modify, +<a name="l00055"></a>00055 Auth, +<a name="l00056"></a>00056 Wait +<a name="l00057"></a>00057 }; +<a name="l00058"></a>00058 +<a name="l00059"></a>00059 <span class="keyword">enum</span> Condition +<a name="l00060"></a>00060 { +<a name="l00061"></a>00061 BadRequest, +<a name="l00062"></a>00062 Conflict, +<a name="l00063"></a>00063 FeatureNotImplemented, +<a name="l00064"></a>00064 Forbidden, +<a name="l00065"></a>00065 Gone, +<a name="l00066"></a>00066 InternalServerError, +<a name="l00067"></a>00067 ItemNotFound, +<a name="l00068"></a>00068 JidMalformed, +<a name="l00069"></a>00069 NotAcceptable, +<a name="l00070"></a>00070 NotAllowed, +<a name="l00071"></a>00071 NotAuthorized, +<a name="l00072"></a>00072 PaymentRequired, +<a name="l00073"></a>00073 RecipientUnavailable, +<a name="l00074"></a>00074 Redirect, +<a name="l00075"></a>00075 RegistrationRequired, +<a name="l00076"></a>00076 RemoteServerNotFound, +<a name="l00077"></a>00077 RemoteServerTimeout, +<a name="l00078"></a>00078 ResourceConstraint, +<a name="l00079"></a>00079 ServiceUnavailable, +<a name="l00080"></a>00080 SubscriptionRequired, +<a name="l00081"></a>00081 UndefinedCondition, +<a name="l00082"></a>00082 UnexpectedRequest +<a name="l00083"></a>00083 }; +<a name="l00084"></a>00084 +<a name="l00085"></a>00085 Error(); +<a name="l00086"></a>00086 Error(Type type, Condition cond, <span class="keyword">const</span> QString& text=<span class="stringliteral">""</span>); +<a name="l00087"></a>00087 Error(<span class="keyword">const</span> QString& type, <span class="keyword">const</span> QString& cond, <span class="keyword">const</span> QString& text=<span class="stringliteral">""</span>); +<a name="l00088"></a>00088 +<a name="l00089"></a>00089 <span class="keywordtype">int</span> code() <span class="keyword">const</span>; +<a name="l00090"></a>00090 <span class="keywordtype">void</span> setCode(<span class="keywordtype">int</span> code); +<a name="l00091"></a>00091 +<a name="l00092"></a>00092 QString text() <span class="keyword">const</span>; +<a name="l00093"></a>00093 <span class="keywordtype">void</span> setText(<span class="keyword">const</span> QString& text); +<a name="l00094"></a>00094 +<a name="l00095"></a>00095 Condition condition() <span class="keyword">const</span>; +<a name="l00096"></a>00096 <span class="keywordtype">void</span> setCondition(Condition cond); +<a name="l00097"></a>00097 +<a name="l00098"></a>00098 <span class="keywordtype">void</span> setType(Type type); +<a name="l00099"></a>00099 Type type() <span class="keyword">const</span>; +<a name="l00100"></a>00100 +<a name="l00101"></a>00101 <span class="comment">// FIXME : remove this once is gone</span> +<a name="l00102"></a>00102 <span class="keywordtype">bool</span> isValid(); +<a name="l00103"></a>00103 +<a name="l00105"></a>00105 <span class="keywordtype">void</span> parse(<span class="keyword">const</span> QDomElement &element); +<a name="l00106"></a>00106 <span class="keywordtype">void</span> toXml(QXmlStreamWriter *writer) <span class="keyword">const</span>; +<a name="l00107"></a>00107 +<a name="l00108"></a>00108 <span class="comment">// deprecated accessors, use the form without "get" instead</span> +<a name="l00109"></a>00109 <span class="keywordtype">int</span> Q_DECL_DEPRECATED getCode() <span class="keyword">const</span>; +<a name="l00110"></a>00110 QString Q_DECL_DEPRECATED getText() <span class="keyword">const</span>; +<a name="l00111"></a>00111 Condition Q_DECL_DEPRECATED getCondition() <span class="keyword">const</span>; +<a name="l00112"></a>00112 Type Q_DECL_DEPRECATED getType() <span class="keyword">const</span>; +<a name="l00114"></a>00114 +<a name="l00115"></a>00115 <span class="keyword">private</span>: +<a name="l00116"></a>00116 QString getConditionStr() <span class="keyword">const</span>; +<a name="l00117"></a>00117 <span class="keywordtype">void</span> setConditionFromStr(<span class="keyword">const</span> QString& cond); +<a name="l00118"></a>00118 +<a name="l00119"></a>00119 QString getTypeStr() <span class="keyword">const</span>; +<a name="l00120"></a>00120 <span class="keywordtype">void</span> setTypeFromStr(<span class="keyword">const</span> QString& type); +<a name="l00121"></a>00121 +<a name="l00122"></a>00122 <span class="keywordtype">int</span> m_code; +<a name="l00123"></a>00123 Type m_type; +<a name="l00124"></a>00124 Condition m_condition; +<a name="l00125"></a>00125 QString m_text; +<a name="l00126"></a>00126 }; +<a name="l00127"></a>00127 +<a name="l00128"></a>00128 <a class="code" href="classQXmppStanza.html" title="The QXmppStanza class is the base class for all XMPP stanzas.">QXmppStanza</a>(<span class="keyword">const</span> QString& <a class="code" href="classQXmppStanza.html#a2e68644ae328ff374ffc5115597a525e" title="Returns the stanza&#39;s sender JID.">from</a> = <span class="stringliteral">""</span>, <span class="keyword">const</span> QString& <a class="code" href="classQXmppStanza.html#a45ab4c2f04d712ee93df5d0e4b2c03a4">to</a> = <span class="stringliteral">""</span>); +<a name="l00129"></a>00129 ~<a class="code" href="classQXmppStanza.html" title="The QXmppStanza class is the base class for all XMPP stanzas.">QXmppStanza</a>(); +<a name="l00130"></a>00130 +<a name="l00131"></a>00131 QString <a class="code" href="classQXmppStanza.html#a45ab4c2f04d712ee93df5d0e4b2c03a4">to</a>() <span class="keyword">const</span>; +<a name="l00132"></a>00132 <span class="keywordtype">void</span> <a class="code" href="classQXmppStanza.html#a8296bac9c1821141bb67fae87910b8e0">setTo</a>(<span class="keyword">const</span> QString&); +<a name="l00133"></a>00133 +<a name="l00134"></a>00134 QString <a class="code" href="classQXmppStanza.html#a2e68644ae328ff374ffc5115597a525e" title="Returns the stanza&#39;s sender JID.">from</a>() <span class="keyword">const</span>; +<a name="l00135"></a>00135 <span class="keywordtype">void</span> <a class="code" href="classQXmppStanza.html#a320ae1faad87e443277a36260cefb85a">setFrom</a>(<span class="keyword">const</span> QString&); +<a name="l00136"></a>00136 +<a name="l00137"></a>00137 QString <a class="code" href="classQXmppStanza.html#ab9c0dbe7f86f9f222be28882617f8451" title="Returns the stanza&#39;s identifier.">id</a>() <span class="keyword">const</span>; +<a name="l00138"></a>00138 <span class="keywordtype">void</span> <a class="code" href="classQXmppStanza.html#aee06ffcdc8c7b7d67b2da536640e188d">setId</a>(<span class="keyword">const</span> QString&); +<a name="l00139"></a>00139 +<a name="l00140"></a>00140 QString lang() <span class="keyword">const</span>; +<a name="l00141"></a>00141 <span class="keywordtype">void</span> setLang(<span class="keyword">const</span> QString&); +<a name="l00142"></a>00142 +<a name="l00143"></a>00143 QXmppStanza::Error error() <span class="keyword">const</span>; +<a name="l00144"></a>00144 <span class="keywordtype">void</span> setError(QXmppStanza::Error& error); +<a name="l00145"></a>00145 +<a name="l00146"></a>00146 QXmppElementList extensions() <span class="keyword">const</span>; +<a name="l00147"></a>00147 <span class="keywordtype">void</span> setExtensions(<span class="keyword">const</span> QXmppElementList &elements); +<a name="l00148"></a>00148 +<a name="l00150"></a>00150 <span class="comment">// FIXME : why is this needed?</span> +<a name="l00151"></a>00151 <span class="keywordtype">bool</span> isErrorStanza(); +<a name="l00152"></a>00152 +<a name="l00153"></a>00153 <span class="comment">// deprecated accessors, use the form without "get" instead</span> +<a name="l00154"></a>00154 QString Q_DECL_DEPRECATED getTo() <span class="keyword">const</span>; +<a name="l00155"></a>00155 QString Q_DECL_DEPRECATED getFrom() <span class="keyword">const</span>; +<a name="l00156"></a>00156 QString Q_DECL_DEPRECATED getId() <span class="keyword">const</span>; +<a name="l00157"></a>00157 QString Q_DECL_DEPRECATED getLang() <span class="keyword">const</span>; +<a name="l00158"></a>00158 QXmppStanza::Error Q_DECL_DEPRECATED getError() <span class="keyword">const</span>; +<a name="l00159"></a>00159 +<a name="l00160"></a>00160 <span class="keyword">protected</span>: +<a name="l00161"></a>00161 <span class="keywordtype">void</span> generateAndSetNextId(); +<a name="l00162"></a>00162 <span class="keywordtype">void</span> parse(<span class="keyword">const</span> QDomElement &element); +<a name="l00164"></a>00164 +<a name="l00165"></a>00165 <span class="keyword">private</span>: +<a name="l00166"></a>00166 <span class="keyword">static</span> uint s_uniqeIdNo; +<a name="l00167"></a>00167 QString m_to; +<a name="l00168"></a>00168 QString m_from; +<a name="l00169"></a>00169 QString m_id; +<a name="l00170"></a>00170 QString m_lang; +<a name="l00171"></a>00171 QXmppStanza::Error m_error; +<a name="l00172"></a>00172 QXmppElementList m_extensions; +<a name="l00173"></a>00173 }; +<a name="l00174"></a>00174 +<a name="l00175"></a>00175 <span class="preprocessor">#endif // QXMPPSTANZA_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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </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 +<a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> |