diff options
Diffstat (limited to 'docs/html/api/Cheetah.Tools.CGITemplate.html')
| -rw-r--r-- | docs/html/api/Cheetah.Tools.CGITemplate.html | 158 |
1 files changed, 158 insertions, 0 deletions
diff --git a/docs/html/api/Cheetah.Tools.CGITemplate.html b/docs/html/api/Cheetah.Tools.CGITemplate.html new file mode 100644 index 0000000..1ee292f --- /dev/null +++ b/docs/html/api/Cheetah.Tools.CGITemplate.html @@ -0,0 +1,158 @@ + +<!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/html; charset=utf-8" /> + <title>Cheetah.Tools.CGITemplate module — Cheetah3 - The Python-Powered Template Engine</title> + <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../', + VERSION: '3.1.0', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + </head> + <body> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="../py-modindex.html" title="Python Module Index" + >modules</a> |</li> + <li class="nav-item nav-item-0"><a href="../index.html">Cheetah3 - The Python-Powered Template Engine</a> »</li> + </ul> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> + <div role="note" aria-label="source link"> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="../_sources/api/Cheetah.Tools.CGITemplate.rst.txt" + rel="nofollow">Show Source</a></li> + </ul> + </div> +<div id="searchbox" style="display: none" role="search"> + <h3>Quick search</h3> + <form class="search" action="../search.html" method="get"> + <div><input type="text" name="q" /></div> + <div><input type="submit" value="Go" /></div> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> +<script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <div class="section" id="module-Cheetah.Tools.CGITemplate"> +<span id="cheetah-tools-cgitemplate-module"></span><h1>Cheetah.Tools.CGITemplate module<a class="headerlink" href="#module-Cheetah.Tools.CGITemplate" title="Permalink to this headline">¶</a></h1> +<p>A subclass of Cheetah.Template for use in CGI scripts.</p> +<dl class="docutils"> +<dt>Usage in a template:</dt> +<dd>#extends Cheetah.Tools.CGITemplate +#implements respond +$cgiHeaders#slurp</dd> +</dl> +<p>Usage in a template inheriting a Python class: +1. The template</p> +<blockquote> +<div>#extends MyPythonClass +#implements respond +$cgiHeaders#slurp</div></blockquote> +<ol class="arabic" start="2"> +<li><dl class="first docutils"> +<dt>The Python class</dt> +<dd><p class="first">from Cheetah.Tools import CGITemplate +class MyPythonClass(CGITemplate):</p> +<blockquote class="last"> +<div><dl class="docutils"> +<dt>def cgiHeadersHook(self):</dt> +<dd><p class="first last">return “Content-Type: text/html; charset=koi8-r</p> +</dd> +</dl> +</div></blockquote> +</dd> +</dl> +</li> +</ol> +<p>“</p> +<p>To read GET/POST variables, use the .webInput method defined in +Cheetah.Utils.WebInputMixin (available in all templates without importing +anything), use Python’s ‘cgi’ module, or make your own arrangements.</p> +<p>This class inherits from Cheetah.Template to make it usable in Cheetah’s +single-inheritance model.</p> +<dl class="class"> +<dt id="Cheetah.Tools.CGITemplate.CGITemplate"> +<em class="property">class </em><code class="descclassname">Cheetah.Tools.CGITemplate.</code><code class="descname">CGITemplate</code><span class="sig-paren">(</span><em>source=None</em>, <em>namespaces=None</em>, <em>searchList=None</em>, <em>file=None</em>, <em>filter='RawOrEncodedUnicode'</em>, <em>filtersLib=<module 'Cheetah.Filters' from '/home/phd/current/projects/cheetah3/cheetah3/Cheetah/Filters.py'></em>, <em>errorCatcher=None</em>, <em>compilerSettings=Unspecified</em>, <em>_globalSetVars=None</em>, <em>_preBuiltSearchList=None</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Tools.CGITemplate.CGITemplate" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="Cheetah.Template.html#Cheetah.Template.Template" title="Cheetah.Template.Template"><code class="xref py py-class docutils literal"><span class="pre">Cheetah.Template.Template</span></code></a></p> +<p>Methods useful in CGI scripts.</p> +<p>Any class that inherits this mixin must also inherit Cheetah.Servlet.</p> +<dl class="method"> +<dt id="Cheetah.Tools.CGITemplate.CGITemplate.cgiHeaders"> +<code class="descname">cgiHeaders</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Tools.CGITemplate.CGITemplate.cgiHeaders" title="Permalink to this definition">¶</a></dt> +<dd><p>Outputs the CGI headers if this is a CGI script.</p> +<p>Usage: $cgiHeaders#slurp +Override .cgiHeadersHook() if you want to customize the headers.</p> +</dd></dl> + +<dl class="method"> +<dt id="Cheetah.Tools.CGITemplate.CGITemplate.cgiHeadersHook"> +<code class="descname">cgiHeadersHook</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Tools.CGITemplate.CGITemplate.cgiHeadersHook" title="Permalink to this definition">¶</a></dt> +<dd><p>Override if you want to customize the CGI headers.</p> +</dd></dl> + +<dl class="method"> +<dt id="Cheetah.Tools.CGITemplate.CGITemplate.isCgi"> +<code class="descname">isCgi</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Tools.CGITemplate.CGITemplate.isCgi" title="Permalink to this definition">¶</a></dt> +<dd><p>Is this a CGI script?</p> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + >index</a></li> + <li class="right" > + <a href="../py-modindex.html" title="Python Module Index" + >modules</a> |</li> + <li class="nav-item nav-item-0"><a href="../index.html">Cheetah3 - The Python-Powered Template Engine</a> »</li> + </ul> + </div> + <div class="footer" role="contentinfo"> + © Copyright 2017, Oleg Broytman; 2009-2012, R. Tyler Croy; 2001-2008, The Cheetah Development Team.. + Last updated on Mar 03, 2018. + Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. + </div> + </body> +</html>
\ No newline at end of file |