src/build/html/pyams_utils.interfaces.html
changeset 0 d153941bb745
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/build/html/pyams_utils.interfaces.html	Sun Jan 14 11:48:51 2018 +0100
@@ -0,0 +1,237 @@
+
+<!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>pyams_utils.interfaces package &#8212; PyAMS User Guide 0.1.0 documentation</title>
+    <link rel="stylesheet" href="_static/pyramid.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    './',
+        VERSION:     '0.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" />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
+<!--[if lte IE 6]>
+<link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
+<![endif]-->
+
+  </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">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <div class="section" id="pyams-utils-interfaces-package">
+<h1>pyams_utils.interfaces package<a class="headerlink" href="#pyams-utils-interfaces-package" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="module-pyams_utils.interfaces">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_utils.interfaces" title="Permalink to this headline">¶</a></h2>
+<dl class="data">
+<dt id="pyams_utils.interfaces.FORBIDDEN_PERMISSION">
+<code class="descclassname">pyams_utils.interfaces.</code><code class="descname">FORBIDDEN_PERMISSION</code><em class="property"> = 'system.forbidden'</em><a class="headerlink" href="#pyams_utils.interfaces.FORBIDDEN_PERMISSION" title="Permalink to this definition">¶</a></dt>
+<dd><p>Custom permission which is never granted to any user</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="pyams_utils.interfaces.MANAGE_PERMISSION">
+<code class="descclassname">pyams_utils.interfaces.</code><code class="descname">MANAGE_PERMISSION</code><em class="property"> = 'manage'</em><a class="headerlink" href="#pyams_utils.interfaces.MANAGE_PERMISSION" title="Permalink to this definition">¶</a></dt>
+<dd><p>Permission used to manage basic information; this permission is generally not used by custom contents</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="pyams_utils.interfaces.MANAGE_ROLES_PERMISSION">
+<code class="descclassname">pyams_utils.interfaces.</code><code class="descname">MANAGE_ROLES_PERMISSION</code><em class="property"> = 'pyams.ManageRoles'</em><a class="headerlink" href="#pyams_utils.interfaces.MANAGE_ROLES_PERMISSION" title="Permalink to this definition">¶</a></dt>
+<dd><p>Permission used to manage roles</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="pyams_utils.interfaces.MANAGE_SECURITY_PERMISSION">
+<code class="descclassname">pyams_utils.interfaces.</code><code class="descname">MANAGE_SECURITY_PERMISSION</code><em class="property"> = 'pyams.ManageSecurity'</em><a class="headerlink" href="#pyams_utils.interfaces.MANAGE_SECURITY_PERMISSION" title="Permalink to this definition">¶</a></dt>
+<dd><p>Permission used to manage security settings</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="pyams_utils.interfaces.MANAGE_SKIN_PERMISSION">
+<code class="descclassname">pyams_utils.interfaces.</code><code class="descname">MANAGE_SKIN_PERMISSION</code><em class="property"> = 'pyams.ManageSkin'</em><a class="headerlink" href="#pyams_utils.interfaces.MANAGE_SKIN_PERMISSION" title="Permalink to this definition">¶</a></dt>
+<dd><p>Permission used to manage skin</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="pyams_utils.interfaces.MANAGE_SYSTEM_PERMISSION">
+<code class="descclassname">pyams_utils.interfaces.</code><code class="descname">MANAGE_SYSTEM_PERMISSION</code><em class="property"> = 'pyams.ManageSystem'</em><a class="headerlink" href="#pyams_utils.interfaces.MANAGE_SYSTEM_PERMISSION" title="Permalink to this definition">¶</a></dt>
+<dd><p>Permission used to manage system settings</p>
+</dd></dl>
+
+<dl class="exception">
+<dt id="pyams_utils.interfaces.MissingRequestError">
+<em class="property">exception </em><code class="descclassname">pyams_utils.interfaces.</code><code class="descname">MissingRequestError</code><a class="headerlink" href="#pyams_utils.interfaces.MissingRequestError" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></p>
+<p>Error raised when no request is available</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="pyams_utils.interfaces.PUBLIC_PERMISSION">
+<code class="descclassname">pyams_utils.interfaces.</code><code class="descname">PUBLIC_PERMISSION</code><em class="property"> = 'public'</em><a class="headerlink" href="#pyams_utils.interfaces.PUBLIC_PERMISSION" title="Permalink to this definition">¶</a></dt>
+<dd><p>Public permission which is granted to every principal</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="pyams_utils.interfaces.PYAMS_APPLICATION_DEFAULT_NAME">
+<code class="descclassname">pyams_utils.interfaces.</code><code class="descname">PYAMS_APPLICATION_DEFAULT_NAME</code><em class="property"> = 'application'</em><a class="headerlink" href="#pyams_utils.interfaces.PYAMS_APPLICATION_DEFAULT_NAME" title="Permalink to this definition">¶</a></dt>
+<dd><p>ZODB default application name</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="pyams_utils.interfaces.PYAMS_APPLICATION_FACTORY_KEY">
+<code class="descclassname">pyams_utils.interfaces.</code><code class="descname">PYAMS_APPLICATION_FACTORY_KEY</code><em class="property"> = 'pyams.application_factory'</em><a class="headerlink" href="#pyams_utils.interfaces.PYAMS_APPLICATION_FACTORY_KEY" title="Permalink to this definition">¶</a></dt>
+<dd><p>Settings key to define site root factory</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="pyams_utils.interfaces.PYAMS_APPLICATION_SETTINGS_KEY">
+<code class="descclassname">pyams_utils.interfaces.</code><code class="descname">PYAMS_APPLICATION_SETTINGS_KEY</code><em class="property"> = 'pyams.application_name'</em><a class="headerlink" href="#pyams_utils.interfaces.PYAMS_APPLICATION_SETTINGS_KEY" title="Permalink to this definition">¶</a></dt>
+<dd><p>ZODB application name settings key</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="pyams_utils.interfaces.VIEW_PERMISSION">
+<code class="descclassname">pyams_utils.interfaces.</code><code class="descname">VIEW_PERMISSION</code><em class="property"> = 'view'</em><a class="headerlink" href="#pyams_utils.interfaces.VIEW_PERMISSION" title="Permalink to this definition">¶</a></dt>
+<dd><p>View permission is a custom permission used to view contents</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="pyams_utils.interfaces.VIEW_SYSTEM_PERMISSION">
+<code class="descclassname">pyams_utils.interfaces.</code><code class="descname">VIEW_SYSTEM_PERMISSION</code><em class="property"> = 'pyams.ViewSystem'</em><a class="headerlink" href="#pyams_utils.interfaces.VIEW_SYSTEM_PERMISSION" title="Permalink to this definition">¶</a></dt>
+<dd><p>Permission used to access management screens</p>
+</dd></dl>
+
+</div>
+<div class="section" id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="module-pyams_utils.interfaces.data">
+<span id="pyams-utils-interfaces-data-module"></span><h3>pyams_utils.interfaces.data module<a class="headerlink" href="#module-pyams_utils.interfaces.data" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="module-pyams_utils.interfaces.intids">
+<span id="pyams-utils-interfaces-intids-module"></span><h3>pyams_utils.interfaces.intids module<a class="headerlink" href="#module-pyams_utils.interfaces.intids" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="module-pyams_utils.interfaces.site">
+<span id="pyams-utils-interfaces-site-module"></span><h3>pyams_utils.interfaces.site module<a class="headerlink" href="#module-pyams_utils.interfaces.site" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="module-pyams_utils.interfaces.size">
+<span id="pyams-utils-interfaces-size-module"></span><h3>pyams_utils.interfaces.size module<a class="headerlink" href="#module-pyams_utils.interfaces.size" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="module-pyams_utils.interfaces.tales">
+<span id="pyams-utils-interfaces-tales-module"></span><h3>pyams_utils.interfaces.tales module<a class="headerlink" href="#module-pyams_utils.interfaces.tales" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="module-pyams_utils.interfaces.text">
+<span id="pyams-utils-interfaces-text-module"></span><h3>pyams_utils.interfaces.text module<a class="headerlink" href="#module-pyams_utils.interfaces.text" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="module-pyams_utils.interfaces.timezone">
+<span id="pyams-utils-interfaces-timezone-module"></span><h3>pyams_utils.interfaces.timezone module<a class="headerlink" href="#module-pyams_utils.interfaces.timezone" title="Permalink to this headline">¶</a></h3>
+<dl class="class">
+<dt id="pyams_utils.interfaces.timezone.Timezone">
+<em class="property">class </em><code class="descclassname">pyams_utils.interfaces.timezone.</code><code class="descname">Timezone</code><span class="sig-paren">(</span><em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.interfaces.timezone.Timezone" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema._field.Choice</span></code></p>
+<p>Timezone choice field</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_utils.interfaces.traversing">
+<span id="pyams-utils-interfaces-traversing-module"></span><h3>pyams_utils.interfaces.traversing module<a class="headerlink" href="#module-pyams_utils.interfaces.traversing" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="module-pyams_utils.interfaces.tree">
+<span id="pyams-utils-interfaces-tree-module"></span><h3>pyams_utils.interfaces.tree module<a class="headerlink" href="#module-pyams_utils.interfaces.tree" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="module-pyams_utils.interfaces.zeo">
+<span id="pyams-utils-interfaces-zeo-module"></span><h3>pyams_utils.interfaces.zeo module<a class="headerlink" href="#module-pyams_utils.interfaces.zeo" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">pyams_utils.interfaces package</a><ul>
+<li><a class="reference internal" href="#module-pyams_utils.interfaces">Module contents</a></li>
+<li><a class="reference internal" href="#submodules">Submodules</a><ul>
+<li><a class="reference internal" href="#module-pyams_utils.interfaces.data">pyams_utils.interfaces.data module</a></li>
+<li><a class="reference internal" href="#module-pyams_utils.interfaces.intids">pyams_utils.interfaces.intids module</a></li>
+<li><a class="reference internal" href="#module-pyams_utils.interfaces.site">pyams_utils.interfaces.site module</a></li>
+<li><a class="reference internal" href="#module-pyams_utils.interfaces.size">pyams_utils.interfaces.size module</a></li>
+<li><a class="reference internal" href="#module-pyams_utils.interfaces.tales">pyams_utils.interfaces.tales module</a></li>
+<li><a class="reference internal" href="#module-pyams_utils.interfaces.text">pyams_utils.interfaces.text module</a></li>
+<li><a class="reference internal" href="#module-pyams_utils.interfaces.timezone">pyams_utils.interfaces.timezone module</a></li>
+<li><a class="reference internal" href="#module-pyams_utils.interfaces.traversing">pyams_utils.interfaces.traversing module</a></li>
+<li><a class="reference internal" href="#module-pyams_utils.interfaces.tree">pyams_utils.interfaces.tree module</a></li>
+<li><a class="reference internal" href="#module-pyams_utils.interfaces.zeo">pyams_utils.interfaces.zeo module</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+<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="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">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+        &#169; Copyright 2017, Thierry Florac.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
+    </div>
+  </body>
+</html>
\ No newline at end of file