aboutsummaryrefslogtreecommitdiff
path: root/doc/html/QXmppDataForm_8h_source.html
blob: 78c6c8168f62bb4105a945fe7686ec0169f0fa00 (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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<!-- 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: QXmppDataForm.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>QXmppDataForm.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"> *  Jeremy Lainé</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 <span class="preprocessor">#ifndef QXMPPDATAFORM_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define QXMPPDATAFORM_H</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;QPair&gt;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;QString&gt;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;QVariant&gt;</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;QXmlStreamWriter&gt;</span>
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 <span class="keyword">class </span>QDomElement;
<a name="l00033"></a>00033 
<a name="l00037"></a>00037 
<a name="l00038"></a><a class="code" href="classQXmppDataForm.html">00038</a> <span class="keyword">class </span><a class="code" href="classQXmppDataForm.html" title="The QXmppDataForm class represents a data form as defined by XEP-0004: Data Forms...">QXmppDataForm</a>
<a name="l00039"></a>00039 {
<a name="l00040"></a>00040 <span class="keyword">public</span>:
<a name="l00041"></a>00041     <span class="keyword">class </span>Field
<a name="l00042"></a>00042     {
<a name="l00043"></a>00043     <span class="keyword">public</span>:
<a name="l00044"></a>00044         <span class="keyword">enum</span> Type
<a name="l00045"></a>00045         {
<a name="l00046"></a>00046             BooleanField,
<a name="l00047"></a>00047             FixedField,
<a name="l00048"></a>00048             HiddenField,
<a name="l00049"></a>00049             JidMultiField,
<a name="l00050"></a>00050             JidSingleField,
<a name="l00051"></a>00051             ListMultiField,
<a name="l00052"></a>00052             ListSingleField,
<a name="l00053"></a>00053             TextMultiField,
<a name="l00054"></a>00054             TextPrivateField,
<a name="l00055"></a>00055             TextSingleField,
<a name="l00056"></a>00056         };
<a name="l00057"></a>00057 
<a name="l00058"></a>00058         Field(QXmppDataForm::Field::Type type = QXmppDataForm::Field::TextSingleField);
<a name="l00059"></a>00059 
<a name="l00060"></a>00060         QString description() <span class="keyword">const</span>;
<a name="l00061"></a>00061         <span class="keywordtype">void</span> setDescription(<span class="keyword">const</span> QString &amp;description);
<a name="l00062"></a>00062 
<a name="l00063"></a>00063         QString key() <span class="keyword">const</span>;
<a name="l00064"></a>00064         <span class="keywordtype">void</span> setKey(<span class="keyword">const</span> QString &amp;key);
<a name="l00065"></a>00065 
<a name="l00066"></a>00066         QString label() <span class="keyword">const</span>;
<a name="l00067"></a>00067         <span class="keywordtype">void</span> setLabel(<span class="keyword">const</span> QString &amp;label);
<a name="l00068"></a>00068 
<a name="l00069"></a>00069         QList&lt;QPair&lt;QString, QString&gt; &gt; options() <span class="keyword">const</span>;
<a name="l00070"></a>00070         <span class="keywordtype">void</span> setOptions(<span class="keyword">const</span> QList&lt;QPair&lt;QString, QString&gt; &gt; &amp;options);
<a name="l00071"></a>00071 
<a name="l00072"></a>00072         <span class="keywordtype">bool</span> isRequired() <span class="keyword">const</span>;
<a name="l00073"></a>00073         <span class="keywordtype">void</span> setRequired(<span class="keywordtype">bool</span> required);
<a name="l00074"></a>00074 
<a name="l00075"></a>00075         QXmppDataForm::Field::Type type() <span class="keyword">const</span>;
<a name="l00076"></a>00076         <span class="keywordtype">void</span> setType(QXmppDataForm::Field::Type type);
<a name="l00077"></a>00077 
<a name="l00078"></a>00078         QVariant value() <span class="keyword">const</span>;
<a name="l00079"></a>00079         <span class="keywordtype">void</span> setValue(<span class="keyword">const</span> QVariant &amp;value);
<a name="l00080"></a>00080 
<a name="l00081"></a>00081     <span class="keyword">private</span>:
<a name="l00082"></a>00082         QString m_description;
<a name="l00083"></a>00083         QString m_key;
<a name="l00084"></a>00084         QString m_label;
<a name="l00085"></a>00085         QList&lt;QPair&lt;QString, QString&gt; &gt; m_options;
<a name="l00086"></a>00086         <span class="keywordtype">bool</span> m_required;
<a name="l00087"></a>00087         QXmppDataForm::Field::Type m_type;
<a name="l00088"></a>00088         QVariant m_value;
<a name="l00089"></a>00089     };
<a name="l00090"></a>00090 
<a name="l00091"></a>00091     <span class="keyword">enum</span> Type
<a name="l00092"></a>00092     {
<a name="l00093"></a>00093         None,
<a name="l00094"></a>00094         Form,
<a name="l00095"></a>00095         Submit,
<a name="l00096"></a>00096         Cancel,
<a name="l00097"></a>00097         Result,
<a name="l00098"></a>00098     };
<a name="l00099"></a>00099 
<a name="l00100"></a>00100     <a class="code" href="classQXmppDataForm.html" title="The QXmppDataForm class represents a data form as defined by XEP-0004: Data Forms...">QXmppDataForm</a>(QXmppDataForm::Type type = QXmppDataForm::None);
<a name="l00101"></a>00101 
<a name="l00102"></a>00102     QString instructions() <span class="keyword">const</span>;
<a name="l00103"></a>00103     <span class="keywordtype">void</span> setInstructions(<span class="keyword">const</span> QString &amp;instructions);
<a name="l00104"></a>00104 
<a name="l00105"></a>00105     QList&lt;Field&gt; fields() <span class="keyword">const</span>;
<a name="l00106"></a>00106     QList&lt;Field&gt; &amp;fields();
<a name="l00107"></a>00107     <span class="keywordtype">void</span> setFields(<span class="keyword">const</span> QList&lt;QXmppDataForm::Field&gt; &amp;fields);
<a name="l00108"></a>00108 
<a name="l00109"></a>00109     QString title() <span class="keyword">const</span>;
<a name="l00110"></a>00110     <span class="keywordtype">void</span> setTitle(<span class="keyword">const</span> QString &amp;title);
<a name="l00111"></a>00111 
<a name="l00112"></a>00112     QXmppDataForm::Type type() <span class="keyword">const</span>;
<a name="l00113"></a>00113     <span class="keywordtype">void</span> setType(QXmppDataForm::Type type);
<a name="l00114"></a>00114 
<a name="l00115"></a>00115     <span class="keywordtype">bool</span> isNull() <span class="keyword">const</span>;
<a name="l00116"></a>00116 
<a name="l00117"></a>00117     <span class="keywordtype">void</span> parse(<span class="keyword">const</span> QDomElement &amp;element);
<a name="l00118"></a>00118     <span class="keywordtype">void</span> toXml(QXmlStreamWriter *writer) <span class="keyword">const</span>;
<a name="l00119"></a>00119 
<a name="l00120"></a>00120 <span class="keyword">private</span>:
<a name="l00121"></a>00121     QString m_instructions;
<a name="l00122"></a>00122     QList&lt;Field&gt; m_fields;
<a name="l00123"></a>00123     QString m_title;
<a name="l00124"></a>00124     QXmppDataForm::Type m_type;
<a name="l00125"></a>00125 };
<a name="l00126"></a>00126 
<a name="l00127"></a>00127 <span class="preprocessor">#endif</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>