<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /builddir/build/BUILD/libqxt/src/web/qxtwebevent.cpp -->
<head>
<title>QxtWebPageEvent Class Reference</title>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://libqxt.org"><img src="images/qxt-logo.png" width="50" height="40" align="left" border="0" /></a></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a> · <a href="classes.html"><font color="#004faf">Classes</font></a> · <a href="namespaces.html"><font color="#004faf">Namespaces</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">QxtWebPageEvent Class Reference<br /><span class="small-subtitle">[<a href="qxtweb.html">QxtWeb</a> module]</span>
</h1>
<p>The QxtWebPageEvent class describes a web page or other content to be sent to a web browser <a href="#details">More...</a></p>
<pre> #include <QxtWebPageEvent></pre><p>Inherits <a href="qxtwebevent.html">QxtWebEvent</a>.</p>
<p>Inherited by <a href="qxtweberrorevent.html">QxtWebErrorEvent</a> and <a href="qxtwebredirectevent.html">QxtWebRedirectEvent</a>.</p>
<ul>
<li><a href="qxtwebpageevent-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"></div><b><a href="qxtwebpageevent.html#QxtWebPageEvent">QxtWebPageEvent</a></b> ( int <i>sessionID</i>, int <i>requestID</i>, QIODevice * <i>source</i> = 0 )</li>
<li><div class="fn"></div><b><a href="qxtwebpageevent.html#QxtWebPageEvent-2">QxtWebPageEvent</a></b> ( int <i>sessionID</i>, int <i>requestID</i>, QByteArray <i>source</i> )</li>
<li><div class="fn"></div>virtual <b><a href="qxtwebpageevent.html#dtor.QxtWebPageEvent">~QxtWebPageEvent</a></b> ()</li>
</ul>
<ul>
<li><div class="fn"></div>1 public function inherited from <a href="qxtwebevent.html#public-functions">QxtWebEvent</a></li>
</ul>
<a name="public-variables"></a>
<h3>Public Variables</h3>
<ul>
<li><div class="fn"></div>bool <b><a href="qxtwebpageevent.html#chunked-var">chunked</a></b></li>
<li><div class="fn"></div>QByteArray <b><a href="qxtwebpageevent.html#contentType-var">contentType</a></b></li>
<li><div class="fn"></div>QPointer<QIODevice> <b><a href="qxtwebpageevent.html#dataSource-var">dataSource</a></b></li>
<li><div class="fn"></div>QMultiHash<QString, QString> <b><a href="qxtwebpageevent.html#headers-var">headers</a></b></li>
<li><div class="fn"></div>const int <b><a href="qxtwebpageevent.html#requestID-var">requestID</a></b></li>
<li><div class="fn"></div>int <b><a href="qxtwebpageevent.html#status-var">status</a></b></li>
<li><div class="fn"></div>QByteArray <b><a href="qxtwebpageevent.html#statusMessage-var">statusMessage</a></b></li>
<li><div class="fn"></div>bool <b><a href="qxtwebpageevent.html#streaming-var">streaming</a></b></li>
</ul>
<ul>
<li><div class="fn"></div>1 public type inherited from <a href="qxtwebevent.html#public-variables">QxtWebEvent</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QxtWebPageEvent class describes a web page or other content to be sent to a web browser</p>
<p>The QxtWebPageEvent class contains information about a web page or other similar content that will be sent to a web browser.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QxtWebPageEvent"></a>QxtWebPageEvent::QxtWebPageEvent ( int <i>sessionID</i>, int <i>requestID</i>, <a href="http://doc.qtsoftware.com/4.5/qiodevice.html">QIODevice</a> * <i>source</i> = 0 )</h3>
<p>Constructs a <a href="qxtwebpageevent.html">QxtWebPageEvent</a> for the specified <i>sessionID</i> and <i>requestID</i> that will use the data from <i>source</i> as the content to be sent to the web browser.</p>
<p>The <a href="qxtwebpageevent.html#requestID-var">requestID</a> is an opaque value generated by the session manager; services will receive this value via <a href="qxtwebrequestevent.html">QxtWebRequestEvent</a> and must use it in every event that responds to that request.</p>
<p><a href="qxtweb.html">QxtWeb</a> takes ownership of the source and will delete it when the response is completed.</p>
<h3 class="fn"><a name="QxtWebPageEvent-2"></a>QxtWebPageEvent::QxtWebPageEvent ( int <i>sessionID</i>, int <i>requestID</i>, <a href="http://doc.qtsoftware.com/4.5/qbytearray.html">QByteArray</a> <i>source</i> )</h3>
<p>Constructs a <a href="qxtwebpageevent.html">QxtWebPageEvent</a> for the specified <i>sessionID</i> and <i>requestID</i> that will use <i>source</i> as the content to be sent to the web browser.</p>
<p>The <a href="qxtwebpageevent.html#requestID-var">requestID</a> is an opaque value generated by the session manager; services will receive this value via <a href="qxtwebrequestevent.html">QxtWebRequestEvent</a> and must use it in every event that responds to that request.</p>
<h3 class="fn"><a name="dtor.QxtWebPageEvent"></a>QxtWebPageEvent::~QxtWebPageEvent () <tt> [virtual]</tt></h3>
<p>Destroys the event and any data source attached to it.</p>
<hr />
<h2>Member Variable Documentation</h2>
<h3 class="fn"><a name="chunked-var"></a>bool QxtWebPageEvent::chunked</h3>
<p>If true, and if the web browser supports "chunked" encoding, the content will be sent using "chunked" encoding. If false, or if the browser does not support this encoding (for instance, HTTP/0.9 and HTTP/1.0 user agents), HTTP keep-alive will be disabled.</p>
<p>The default value is true when using the <a href="http://doc.qtsoftware.com/4.5/qiodevice.html">QIODevice</a>* constructor and false when using the <a href="http://doc.qtsoftware.com/4.5/qbytearray.html">QByteArray</a> constructor.</p>
<h3 class="fn"><a name="contentType-var"></a><a href="http://doc.qtsoftware.com/4.5/qbytearray.html">QByteArray</a> QxtWebPageEvent::contentType</h3>
<p>Contains the MIME type of the content being sent to the web browser.</p>
<p>The default value is "text/html".</p>
<h3 class="fn"><a name="dataSource-var"></a><a href="http://doc.qtsoftware.com/4.5/qpointer.html">QPointer</a><<a href="http://doc.qtsoftware.com/4.5/qiodevice.html">QIODevice</a>> QxtWebPageEvent::dataSource</h3>
<p>Data will be read from this device and relayed to the web browser.</p>
<h3 class="fn"><a name="headers-var"></a><a href="http://doc.qtsoftware.com/4.5/qmultihash.html">QMultiHash</a><<a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a>, <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a>> QxtWebPageEvent::headers</h3>
<p>Contains custom headers to be sent to the web browser.</p>
<p>It is empty by default.</p>
<h3 class="fn"><a name="requestID-var"></a>const int QxtWebPageEvent::requestID</h3>
<p>Contains the opaque requestID provided by <a href="qxtwebrequestevent.html">QxtWebRequestEvent</a>.</p>
<h3 class="fn"><a name="status-var"></a>int QxtWebPageEvent::status</h3>
<p>Contains the HTTP status code that will be sent with the response.</p>
<p>The default value is 200 ("OK").</p>
<h3 class="fn"><a name="statusMessage-var"></a><a href="http://doc.qtsoftware.com/4.5/qbytearray.html">QByteArray</a> QxtWebPageEvent::statusMessage</h3>
<p>Contains the human-readable message associated with the HTTP status code that will be sent with the response.</p>
<p>The default value is "OK".</p>
<h3 class="fn"><a name="streaming-var"></a>bool QxtWebPageEvent::streaming</h3>
<p>If true, the data source is considered to be a source of streaming data. The <a href="http://doc.qtsoftware.com/4.5/qiodevice.html">QIODevice</a> must emit the readyRead() signal when data is available and must emit aboutToClose() after all data has been transferred. (This can be accomplished by invoking <a href="http://doc.qtsoftware.com/4.5/qiodevice.html#close">QIODevice::close</a>() on it after all data is determined to have been transferred.)</p>
<p>The default value is true when using the <a href="http://doc.qtsoftware.com/4.5/qiodevice.html">QIODevice</a>* constructor and false when using the <a href="http://doc.qtsoftware.com/4.5/qbytearray.html">QByteArray</a> constructor. If using a <a href="http://doc.qtsoftware.com/4.5/qiodevice.html">QIODevice</a> that does not produce streaming data, such as <a href="http://doc.qtsoftware.com/4.5/qfile.html">QFile</a>, this <i>must</i> be set to false to ensure correct behavior.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright © 2007-2010
<a href="mailto:foundation@libqxt.org">Qxt Foundation</a></td>
<td align="right"><div align="right">
<a href="http://libqxt.org">Qxt</a> 0.6.1</div></td>
</tr></table></div></address></body>
</html>
