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 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
|
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>QDjango: QDjangoHttpController Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">QDjango
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.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)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">QDjangoHttpController Class Reference<div class="ingroups"><a class="el" href="group__Http.html">Http</a></div></div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QDjangoHttpController" -->
<p>The <a class="el" href="classQDjangoHttpController.html" title="The QDjangoHttpController class provides static methods for replying to HTTP requests.">QDjangoHttpController</a> class provides static methods for replying to HTTP requests.
<a href="classQDjangoHttpController.html#details">More...</a></p>
<p><code>#include <<a class="el" href="QDjangoHttpController_8h_source.html">QDjangoHttpController.h</a>></code></p>
<p><a href="classQDjangoHttpController-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoHttpController.html#a5d16038304e7b60c9060d0ec48b78ac7">getBasicAuth</a> (const <a class="el" href="classQDjangoHttpRequest.html">QDjangoHttpRequest</a> &request, QString &username, QString &password)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoHttpController.html#af3be408a12824b6ba0eb85567e6c476b">httpDateTime</a> (const QDateTime &dt)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static QDateTime </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoHttpController.html#ab0493f45d2a0ee5845078ba907695803">httpDateTime</a> (const QString &str)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classQDjangoHttpResponse.html">QDjangoHttpResponse</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoHttpController.html#a04620a6102bf86d6ca87131c6621278b">serveAuthorizationRequired</a> (const <a class="el" href="classQDjangoHttpRequest.html">QDjangoHttpRequest</a> &request, const QString &realm=QString("Secure Area"))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classQDjangoHttpResponse.html">QDjangoHttpResponse</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoHttpController.html#a6bf1064236afe030b94fe779676cbbc8">serveBadRequest</a> (const <a class="el" href="classQDjangoHttpRequest.html">QDjangoHttpRequest</a> &request)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classQDjangoHttpResponse.html">QDjangoHttpResponse</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoHttpController.html#a0b5b7ec8be16b1012f9d09f95fc0469a">serveInternalServerError</a> (const <a class="el" href="classQDjangoHttpRequest.html">QDjangoHttpRequest</a> &request)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classQDjangoHttpResponse.html">QDjangoHttpResponse</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoHttpController.html#adbc2c527604240c1c23ad417533c81ae">serveNotFound</a> (const <a class="el" href="classQDjangoHttpRequest.html">QDjangoHttpRequest</a> &request)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classQDjangoHttpResponse.html">QDjangoHttpResponse</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoHttpController.html#a5aaa6c9a7fa7b925a60d6127c92e47e2">serveRedirect</a> (const <a class="el" href="classQDjangoHttpRequest.html">QDjangoHttpRequest</a> &request, const QUrl &url, bool permanent=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classQDjangoHttpResponse.html">QDjangoHttpResponse</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoHttpController.html#aff791959526b022f5f33d0e092d779c5">serveStatic</a> (const <a class="el" href="classQDjangoHttpRequest.html">QDjangoHttpRequest</a> &request, const QString &filePath, const QDateTime &expires=QDateTime())</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classQDjangoHttpController.html" title="The QDjangoHttpController class provides static methods for replying to HTTP requests.">QDjangoHttpController</a> class provides static methods for replying to HTTP requests. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5d16038304e7b60c9060d0ec48b78ac7"></a><!-- doxytag: member="QDjangoHttpController::getBasicAuth" ref="a5d16038304e7b60c9060d0ec48b78ac7" args="(const QDjangoHttpRequest &request, QString &username, QString &password)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classQDjangoHttpController.html#a5d16038304e7b60c9060d0ec48b78ac7">QDjangoHttpController::getBasicAuth</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classQDjangoHttpRequest.html">QDjangoHttpRequest</a> & </td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString & </td>
<td class="paramname"><em>username</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString & </td>
<td class="paramname"><em>password</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extract basic credentials from an HTTP <em>request</em>.</p>
<p>Returns <b>true</b> if credentials were provider, <b>false</b> otherwise. </p>
</div>
</div>
<a class="anchor" id="af3be408a12824b6ba0eb85567e6c476b"></a><!-- doxytag: member="QDjangoHttpController::httpDateTime" ref="af3be408a12824b6ba0eb85567e6c476b" args="(const QDateTime &dt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString <a class="el" href="classQDjangoHttpController.html#af3be408a12824b6ba0eb85567e6c476b">QDjangoHttpController::httpDateTime</a> </td>
<td>(</td>
<td class="paramtype">const QDateTime & </td>
<td class="paramname"><em>dt</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Converts a QDateTime to an HTTP datetime string. </p>
</div>
</div>
<a class="anchor" id="ab0493f45d2a0ee5845078ba907695803"></a><!-- doxytag: member="QDjangoHttpController::httpDateTime" ref="ab0493f45d2a0ee5845078ba907695803" args="(const QString &str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QDateTime <a class="el" href="classQDjangoHttpController.html#af3be408a12824b6ba0eb85567e6c476b">QDjangoHttpController::httpDateTime</a> </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Converts an HTTP datetime string to a QDateTime. </p>
</div>
</div>
<a class="anchor" id="a04620a6102bf86d6ca87131c6621278b"></a><!-- doxytag: member="QDjangoHttpController::serveAuthorizationRequired" ref="a04620a6102bf86d6ca87131c6621278b" args="(const QDjangoHttpRequest &request, const QString &realm=QString("Secure Area"))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQDjangoHttpResponse.html">QDjangoHttpResponse</a> * <a class="el" href="classQDjangoHttpController.html#a04620a6102bf86d6ca87131c6621278b">QDjangoHttpController::serveAuthorizationRequired</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classQDjangoHttpRequest.html">QDjangoHttpRequest</a> & </td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>realm</em> = <code>QString("Secure Area")</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Respond to an HTTP <em>request</em> with an authorization error.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td></td></tr>
<tr><td class="paramname">realm</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6bf1064236afe030b94fe779676cbbc8"></a><!-- doxytag: member="QDjangoHttpController::serveBadRequest" ref="a6bf1064236afe030b94fe779676cbbc8" args="(const QDjangoHttpRequest &request)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQDjangoHttpResponse.html">QDjangoHttpResponse</a> * <a class="el" href="classQDjangoHttpController.html#a6bf1064236afe030b94fe779676cbbc8">QDjangoHttpController::serveBadRequest</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classQDjangoHttpRequest.html">QDjangoHttpRequest</a> & </td>
<td class="paramname"><em>request</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Respond to a malformed HTTP request.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0b5b7ec8be16b1012f9d09f95fc0469a"></a><!-- doxytag: member="QDjangoHttpController::serveInternalServerError" ref="a0b5b7ec8be16b1012f9d09f95fc0469a" args="(const QDjangoHttpRequest &request)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQDjangoHttpResponse.html">QDjangoHttpResponse</a> * <a class="el" href="classQDjangoHttpController.html#a0b5b7ec8be16b1012f9d09f95fc0469a">QDjangoHttpController::serveInternalServerError</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classQDjangoHttpRequest.html">QDjangoHttpRequest</a> & </td>
<td class="paramname"><em>request</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Respond to an HTTP <em>request</em> with an internal server error.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="adbc2c527604240c1c23ad417533c81ae"></a><!-- doxytag: member="QDjangoHttpController::serveNotFound" ref="adbc2c527604240c1c23ad417533c81ae" args="(const QDjangoHttpRequest &request)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQDjangoHttpResponse.html">QDjangoHttpResponse</a> * <a class="el" href="classQDjangoHttpController.html#adbc2c527604240c1c23ad417533c81ae">QDjangoHttpController::serveNotFound</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classQDjangoHttpRequest.html">QDjangoHttpRequest</a> & </td>
<td class="paramname"><em>request</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Respond to an HTTP <em>request</em> with a not found error.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5aaa6c9a7fa7b925a60d6127c92e47e2"></a><!-- doxytag: member="QDjangoHttpController::serveRedirect" ref="a5aaa6c9a7fa7b925a60d6127c92e47e2" args="(const QDjangoHttpRequest &request, const QUrl &url, bool permanent=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQDjangoHttpResponse.html">QDjangoHttpResponse</a> * <a class="el" href="classQDjangoHttpController.html#a5aaa6c9a7fa7b925a60d6127c92e47e2">QDjangoHttpController::serveRedirect</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classQDjangoHttpRequest.html">QDjangoHttpRequest</a> & </td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QUrl & </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>permanent</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Respond to an HTTP <em>request</em> with a redirect.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td></td></tr>
<tr><td class="paramname">url</td><td>The URL to which the user is redirected. </td></tr>
<tr><td class="paramname">permanent</td><td>Whether the redirect is permanent. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aff791959526b022f5f33d0e092d779c5"></a><!-- doxytag: member="QDjangoHttpController::serveStatic" ref="aff791959526b022f5f33d0e092d779c5" args="(const QDjangoHttpRequest &request, const QString &filePath, const QDateTime &expires=QDateTime())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQDjangoHttpResponse.html">QDjangoHttpResponse</a> * <a class="el" href="classQDjangoHttpController.html#aff791959526b022f5f33d0e092d779c5">QDjangoHttpController::serveStatic</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classQDjangoHttpRequest.html">QDjangoHttpRequest</a> & </td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>docPath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QDateTime & </td>
<td class="paramname"><em>expires</em> = <code>QDateTime()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Respond to an HTTP <em>request</em> for a static file.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td></td></tr>
<tr><td class="paramname">docPath</td><td>The path to the document, such that it can be opened using a QFile. </td></tr>
<tr><td class="paramname">expires</td><td>An optional expiry date. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="QDjangoHttpController_8h_source.html">QDjangoHttpController.h</a></li>
<li>QDjangoHttpController.cpp</li>
</ul>
</div><!-- contents -->
<!-- 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>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Properties</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Wed May 16 2012 18:11:23 for QDjango by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>
|