~oif-team/ubuntu/natty/qt4-x11/xi2.1

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="annotated.html"><font color="#004faf">Annotated</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>

<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">QHttpHeader Class Reference</h1>

<p>The QHttpHeader class contains header information for HTTP. <a href="#details">More...</a></p>

<pre>#include <QHttpHeader></pre><p>Part of the <a href="qtnetwork.html">QtNetwork</a> module.</p>

<p>Inherited by <a href="qhttprequestheader.html">QHttpRequestHeader</a> and <a href="qhttpresponseheader.html">QHttpResponseHeader</a>.</p>

<ul>

<li><a href="qhttpheader-members.html">List of all members, including inherited members</a></li>

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/><b><a href="qhttpheader.html#QHttpHeader">QHttpHeader</a></b> ()</li>

<li><div class="fn"/><b><a href="qhttpheader.html#QHttpHeader-2">QHttpHeader</a></b> ( const QHttpHeader & <i>header</i> )</li>

<li><div class="fn"/><b><a href="qhttpheader.html#QHttpHeader-3">QHttpHeader</a></b> ( const QString & <i>str</i> )</li>

<li><div class="fn"/>virtual <b><a href="qhttpheader.html#dtor.QHttpHeader">~QHttpHeader</a></b> ()</li>

<li><div class="fn"/>uint <b><a href="qhttpheader.html#contentLength">contentLength</a></b> () const</li>

<li><div class="fn"/>QString <b><a href="qhttpheader.html#contentType">contentType</a></b> () const</li>

<li><div class="fn"/>bool <b><a href="qhttpheader.html#hasContentLength">hasContentLength</a></b> () const</li>

<li><div class="fn"/>bool <b><a href="qhttpheader.html#hasContentType">hasContentType</a></b> () const</li>

<li><div class="fn"/>bool <b><a href="qhttpheader.html#hasKey">hasKey</a></b> ( const QString & <i>key</i> ) const</li>

<li><div class="fn"/>bool <b><a href="qhttpheader.html#isValid">isValid</a></b> () const</li>

<li><div class="fn"/>QStringList <b><a href="qhttpheader.html#keys">keys</a></b> () const</li>

<li><div class="fn"/>virtual int <b><a href="qhttpheader.html#majorVersion">majorVersion</a></b> () const = 0</li>

<li><div class="fn"/>virtual int <b><a href="qhttpheader.html#minorVersion">minorVersion</a></b> () const = 0</li>

<li><div class="fn"/>void <b><a href="qhttpheader.html#removeValue">removeValue</a></b> ( const QString & <i>key</i> )</li>

<li><div class="fn"/>void <b><a href="qhttpheader.html#setContentLength">setContentLength</a></b> ( int <i>len</i> )</li>

<li><div class="fn"/>void <b><a href="qhttpheader.html#setContentType">setContentType</a></b> ( const QString & <i>type</i> )</li>

<li><div class="fn"/>void <b><a href="qhttpheader.html#setValue">setValue</a></b> ( const QString & <i>key</i>, const QString & <i>value</i> )</li>

<li><div class="fn"/>virtual QString <b><a href="qhttpheader.html#toString">toString</a></b> () const</li>

<li><div class="fn"/>QString <b><a href="qhttpheader.html#value">value</a></b> ( const QString & <i>key</i> ) const</li>

<li><div class="fn"/>QHttpHeader & <b><a href="qhttpheader.html#operator-eq">operator=</a></b> ( const QHttpHeader & <i>h</i> )</li>

</ul>

<hr />

<h2>Detailed Description</h2>

<p>The QHttpHeader class contains header information for HTTP.</p>

<p>In most cases you should use the more specialized derivatives of this class, <a href="qhttpresponseheader.html">QHttpResponseHeader</a> and <a href="qhttprequestheader.html">QHttpRequestHeader</a>, rather than directly using QHttpHeader.</p>

<p>QHttpHeader provides the HTTP header fields. A HTTP header field consists of a name followed by a colon, a single space, and the field value. (See RFC 1945.) Field names are case-insensitive. A typical header field looks like this:</p>

<pre>  content-type: text/html</pre>

<p>In the API the header field name is called the "key" and the content is called the "value". You can get and set a header field's value by using its key with <a href="qhttpheader.html#value">value</a>() and <a href="qhttpheader.html#setValue">setValue</a>(), e.g.</p>

<pre>  header.setValue("content-type", "text/html");

QString contentType = header.value("content-type");</pre>

<p>Some fields are so common that getters and setters are provided for them as a convenient alternative to using <a href="qhttpheader.html#value">value</a>() and <a href="qhttpheader.html#setValue">setValue</a>(), e.g. <a href="qhttpheader.html#contentLength">contentLength</a>() and <a href="qhttpheader.html#contentType">contentType</a>(), <a href="qhttpheader.html#setContentLength">setContentLength</a>() and <a href="qhttpheader.html#setContentType">setContentType</a>().</p>

<p>Each header key has a <i>single</i> value associated with it. If you set the value for a key which already exists the previous value will be discarded.</p>

<p>See also <a href="qhttprequestheader.html">QHttpRequestHeader</a> and <a href="qhttpresponseheader.html">QHttpResponseHeader</a>.</p>

<hr />

<h2>Member Function Documentation</h2>

<h3 class="fn"><a name="QHttpHeader"></a>QHttpHeader::QHttpHeader ()</h3>

<p>Constructs an empty HTTP header.</p>

<h3 class="fn"><a name="QHttpHeader-2"></a>QHttpHeader::QHttpHeader ( const QHttpHeader & <i>header</i> )</h3>

<p>Constructs a copy of <i>header</i>.</p>

<h3 class="fn"><a name="QHttpHeader-3"></a>QHttpHeader::QHttpHeader ( const <a href="qstring.html">QString</a> & <i>str</i> )</h3>

<p>Constructs a HTTP header for <i>str</i>.</p>

<p>This constructor parses the string <i>str</i> for header fields and adds this information. The <i>str</i> should consist of one or more "\r\n" delimited lines; each of these lines should have the format key, colon, space, value.</p>

<h3 class="fn"><a name="dtor.QHttpHeader"></a>QHttpHeader::~QHttpHeader ()  <tt> [virtual]</tt></h3>

<p>Destructor.</p>

<h3 class="fn"><a name="contentLength"></a><a href="qtglobal.html#uint-typedef">uint</a> QHttpHeader::contentLength () const</h3>

<p>Returns the value of the special HTTP header field <tt>content-length</tt>.</p>

<p>See also <a href="qhttpheader.html#setContentLength">setContentLength</a>() and <a href="qhttpheader.html#hasContentLength">hasContentLength</a>().</p>

<h3 class="fn"><a name="contentType"></a><a href="qstring.html">QString</a> QHttpHeader::contentType () const</h3>

<p>Returns the value of the special HTTP header field <tt>content-type</tt>.</p>

<p>See also <a href="qhttpheader.html#setContentType">setContentType</a>() and <a href="qhttpheader.html#hasContentType">hasContentType</a>().</p>

<h3 class="fn"><a name="hasContentLength"></a>bool QHttpHeader::hasContentLength () const</h3>

<p>Returns true if the header has an entry for the special HTTP header field <tt>content-length</tt>; otherwise returns false.</p>

<p>See also <a href="qhttpheader.html#contentLength">contentLength</a>() and <a href="qhttpheader.html#setContentLength">setContentLength</a>().</p>

<h3 class="fn"><a name="hasContentType"></a>bool QHttpHeader::hasContentType () const</h3>

<p>Returns true if the header has an entry for the the special HTTP header field <tt>content-type</tt>; otherwise returns false.</p>

<p>See also <a href="qhttpheader.html#contentType">contentType</a>() and <a href="qhttpheader.html#setContentType">setContentType</a>().</p>

<h3 class="fn"><a name="hasKey"></a>bool QHttpHeader::hasKey ( const <a href="qstring.html">QString</a> & <i>key</i> ) const</h3>

<p>Returns true if the HTTP header has an entry with the given <i>key</i>; otherwise returns false.</p>

<p>See also <a href="qhttpheader.html#value">value</a>(), <a href="qhttpheader.html#setValue">setValue</a>(), and <a href="qhttpheader.html#keys">keys</a>().</p>

<h3 class="fn"><a name="isValid"></a>bool QHttpHeader::isValid () const</h3>

<p>Returns true if the HTTP header is valid; otherwise returns false.</p>

<p>A <a href="qhttpheader.html">QHttpHeader</a> is invalid if it was created by parsing a malformed string.</p>

<h3 class="fn"><a name="keys"></a><a href="qstringlist.html">QStringList</a> QHttpHeader::keys () const</h3>

<p>Returns a list of the keys in the HTTP header.</p>

<p>See also <a href="qhttpheader.html#hasKey">hasKey</a>().</p>

<h3 class="fn"><a name="majorVersion"></a>int QHttpHeader::majorVersion () const  <tt> [pure virtual]</tt></h3>

<p>Returns the major protocol-version of the HTTP header.</p>

<h3 class="fn"><a name="minorVersion"></a>int QHttpHeader::minorVersion () const  <tt> [pure virtual]</tt></h3>

<p>Returns the minor protocol-version of the HTTP header.</p>

100

<h3 class="fn"><a name="removeValue"></a>void QHttpHeader::removeValue ( const <a href="qstring.html">QString</a> & <i>key</i> )</h3>

101

<p>Removes the entry with the key <i>key</i> from the HTTP header.</p>

102

<p>See also <a href="qhttpheader.html#value">value</a>() and <a href="qhttpheader.html#setValue">setValue</a>().</p>

103

<h3 class="fn"><a name="setContentLength"></a>void QHttpHeader::setContentLength ( int <i>len</i> )</h3>

104

<p>Sets the value of the special HTTP header field <tt>content-length</tt> to <i>len</i>.</p>

105

<p>See also <a href="qhttpheader.html#contentLength">contentLength</a>() and <a href="qhttpheader.html#hasContentLength">hasContentLength</a>().</p>

106

<h3 class="fn"><a name="setContentType"></a>void QHttpHeader::setContentType ( const <a href="qstring.html">QString</a> & <i>type</i> )</h3>

107

<p>Sets the value of the special HTTP header field <tt>content-type</tt> to <i>type</i>.</p>

108

<p>See also <a href="qhttpheader.html#contentType">contentType</a>() and <a href="qhttpheader.html#hasContentType">hasContentType</a>().</p>

109

<h3 class="fn"><a name="setValue"></a>void QHttpHeader::setValue ( const <a href="qstring.html">QString</a> & <i>key</i>, const <a href="qstring.html">QString</a> & <i>value</i> )</h3>

110

<p>Sets the value of the entry with the <i>key</i> to <i>value</i>.</p>

111

<p>If no entry with <i>key</i> exists, a new entry with the given <i>key</i> and <i>value</i> is created. If an entry with the <i>key</i> already exists, its value is discarded and replaced with the given <i>value</i>.</p>

112

<p>See also <a href="qhttpheader.html#value">value</a>(), <a href="qhttpheader.html#hasKey">hasKey</a>(), and <a href="qhttpheader.html#removeValue">removeValue</a>().</p>

113

<h3 class="fn"><a name="toString"></a><a href="qstring.html">QString</a> QHttpHeader::toString () const  <tt> [virtual]</tt></h3>

114

<p>Returns a string representation of the HTTP header.</p>

115

<p>The string is suitable for use by the constructor that takes a <a href="qstring.html">QString</a>. It consists of lines with the format: key, colon, space, value, "\r\n".</p>

116

<h3 class="fn"><a name="value"></a><a href="qstring.html">QString</a> QHttpHeader::value ( const <a href="qstring.html">QString</a> & <i>key</i> ) const</h3>

117

<p>Returns the value for the entry with the given <i>key</i>. If no entry has this <i>key</i>, an empty string is returned.</p>

118

<p>See also <a href="qhttpheader.html#setValue">setValue</a>(), <a href="qhttpheader.html#removeValue">removeValue</a>(), <a href="qhttpheader.html#hasKey">hasKey</a>(), and <a href="qhttpheader.html#keys">keys</a>().</p>

119

<h3 class="fn"><a name="operator-eq"></a>QHttpHeader & QHttpHeader::operator= ( const QHttpHeader & <i>h</i> )</h3>

120

<p>Assigns <i>h</i> and returns a reference to this http header.</p>

121

122

123

124

<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>

125

126

</tr></table></div></address></body>

127

</html>

Older »