1 |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 |
|
5 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
6 <head> |
|
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|
8 <title>PyAMS viewlets — PyAMS User Guide 0.1.0 documentation</title> |
|
9 <link rel="stylesheet" href="_static/pyramid.css" type="text/css" /> |
|
10 <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
|
11 <script type="text/javascript"> |
|
12 var DOCUMENTATION_OPTIONS = { |
|
13 URL_ROOT: './', |
|
14 VERSION: '0.1.0', |
|
15 COLLAPSE_INDEX: false, |
|
16 FILE_SUFFIX: '.html', |
|
17 HAS_SOURCE: true, |
|
18 SOURCELINK_SUFFIX: '.txt' |
|
19 }; |
|
20 </script> |
|
21 <script type="text/javascript" src="_static/jquery.js"></script> |
|
22 <script type="text/javascript" src="_static/underscore.js"></script> |
|
23 <script type="text/javascript" src="_static/doctools.js"></script> |
|
24 <link rel="index" title="Index" href="genindex.html" /> |
|
25 <link rel="search" title="Search" href="search.html" /> |
|
26 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
27 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
28 <!--[if lte IE 6]> |
|
29 <link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" /> |
|
30 <![endif]--> |
|
31 |
|
32 </head> |
|
33 <body> |
|
34 |
|
35 <div class="related" role="navigation" aria-label="related navigation"> |
|
36 <h3>Navigation</h3> |
|
37 <ul> |
|
38 <li class="right" style="margin-right: 10px"> |
|
39 <a href="genindex.html" title="General Index" |
|
40 accesskey="I">index</a></li> |
|
41 <li class="right" > |
|
42 <a href="py-modindex.html" title="Python Module Index" |
|
43 >modules</a> |</li> |
|
44 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
45 </ul> |
|
46 </div> |
|
47 |
|
48 <div class="document"> |
|
49 <div class="documentwrapper"> |
|
50 <div class="bodywrapper"> |
|
51 <div class="body" role="main"> |
|
52 |
|
53 <div class="section" id="pyams-viewlets"> |
|
54 <span id="pyams-viewlet"></span><h1>PyAMS viewlets<a class="headerlink" href="#pyams-viewlets" title="Permalink to this headline">¶</a></h1> |
|
55 <div class="section" id="module-pyams_viewlet"> |
|
56 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_viewlet" title="Permalink to this headline">¶</a></h2> |
|
57 <dl class="function"> |
|
58 <dt id="pyams_viewlet.includeme"> |
|
59 <code class="descclassname">pyams_viewlet.</code><code class="descname">includeme</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.includeme" title="Permalink to this definition">¶</a></dt> |
|
60 <dd><p>Pyramid include</p> |
|
61 </dd></dl> |
|
62 |
|
63 </div> |
|
64 <div class="section" id="subpackages"> |
|
65 <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> |
|
66 <div class="toctree-wrapper compound"> |
|
67 <ul> |
|
68 <li class="toctree-l1"><a class="reference internal" href="pyams_viewlet.interfaces.html">pyams_viewlet.interfaces package</a><ul> |
|
69 <li class="toctree-l2"><a class="reference internal" href="pyams_viewlet.interfaces.html#module-pyams_viewlet.interfaces">Module contents</a></li> |
|
70 </ul> |
|
71 </li> |
|
72 <li class="toctree-l1"><a class="reference internal" href="pyams_viewlet.tests.html">pyams_viewlet.tests package</a><ul> |
|
73 <li class="toctree-l2"><a class="reference internal" href="pyams_viewlet.tests.html#submodules">Submodules</a></li> |
|
74 <li class="toctree-l2"><a class="reference internal" href="pyams_viewlet.tests.html#module-pyams_viewlet.tests.test_utilsdocs">pyams_viewlet.tests.test_utilsdocs module</a></li> |
|
75 <li class="toctree-l2"><a class="reference internal" href="pyams_viewlet.tests.html#module-pyams_viewlet.tests.test_utilsdocstrings">pyams_viewlet.tests.test_utilsdocstrings module</a></li> |
|
76 <li class="toctree-l2"><a class="reference internal" href="pyams_viewlet.tests.html#module-pyams_viewlet.tests">Module contents</a></li> |
|
77 </ul> |
|
78 </li> |
|
79 </ul> |
|
80 </div> |
|
81 </div> |
|
82 <div class="section" id="submodules"> |
|
83 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
84 <div class="section" id="module-pyams_viewlet.manager"> |
|
85 <span id="pyams-viewlet-manager-module"></span><h3>pyams_viewlet.manager module<a class="headerlink" href="#module-pyams_viewlet.manager" title="Permalink to this headline">¶</a></h3> |
|
86 <dl class="class"> |
|
87 <dt id="pyams_viewlet.manager.ConditionalViewletManager"> |
|
88 <em class="property">class </em><code class="descclassname">pyams_viewlet.manager.</code><code class="descname">ConditionalViewletManager</code><span class="sig-paren">(</span><em>context</em>, <em>request</em>, <em>view</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.manager.ConditionalViewletManager" title="Permalink to this definition">¶</a></dt> |
|
89 <dd><p>Bases: <a class="reference internal" href="#pyams_viewlet.manager.WeightOrderedViewletManager" title="pyams_viewlet.manager.WeightOrderedViewletManager"><code class="xref py py-class docutils literal"><span class="pre">pyams_viewlet.manager.WeightOrderedViewletManager</span></code></a></p> |
|
90 <p>Conditional weight ordered viewlet managers.</p> |
|
91 <dl class="method"> |
|
92 <dt id="pyams_viewlet.manager.ConditionalViewletManager.filter"> |
|
93 <code class="descname">filter</code><span class="sig-paren">(</span><em>viewlets</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.manager.ConditionalViewletManager.filter" title="Permalink to this definition">¶</a></dt> |
|
94 <dd><p>Sort out all viewlets which are explicit not available</p> |
|
95 <p><code class="docutils literal"><span class="pre">viewlets</span></code> is a list of tuples of the form (name, viewlet).</p> |
|
96 </dd></dl> |
|
97 |
|
98 </dd></dl> |
|
99 |
|
100 <dl class="class"> |
|
101 <dt id="pyams_viewlet.manager.TemplateBasedViewletManager"> |
|
102 <em class="property">class </em><code class="descclassname">pyams_viewlet.manager.</code><code class="descname">TemplateBasedViewletManager</code><a class="headerlink" href="#pyams_viewlet.manager.TemplateBasedViewletManager" title="Permalink to this definition">¶</a></dt> |
|
103 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
104 <p>Template based viewlet manager mixin class</p> |
|
105 <dl class="attribute"> |
|
106 <dt id="pyams_viewlet.manager.TemplateBasedViewletManager.template"> |
|
107 <code class="descname">template</code><em class="property"> = <BoundViewTemplate of None></em><a class="headerlink" href="#pyams_viewlet.manager.TemplateBasedViewletManager.template" title="Permalink to this definition">¶</a></dt> |
|
108 <dd></dd></dl> |
|
109 |
|
110 </dd></dl> |
|
111 |
|
112 <dl class="class"> |
|
113 <dt id="pyams_viewlet.manager.ViewletManager"> |
|
114 <em class="property">class </em><code class="descclassname">pyams_viewlet.manager.</code><code class="descname">ViewletManager</code><span class="sig-paren">(</span><em>context</em>, <em>request</em>, <em>view</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.manager.ViewletManager" title="Permalink to this definition">¶</a></dt> |
|
115 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
116 <p>The Viewlet Manager base</p> |
|
117 <p>A generic manager class which can be instantiated</p> |
|
118 <dl class="method"> |
|
119 <dt id="pyams_viewlet.manager.ViewletManager.filter"> |
|
120 <code class="descname">filter</code><span class="sig-paren">(</span><em>viewlets</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.manager.ViewletManager.filter" title="Permalink to this definition">¶</a></dt> |
|
121 <dd><p>Sort out all content providers</p> |
|
122 <p><code class="docutils literal"><span class="pre">viewlets</span></code> is a list of tuples of the form (name, viewlet).</p> |
|
123 </dd></dl> |
|
124 |
|
125 <dl class="method"> |
|
126 <dt id="pyams_viewlet.manager.ViewletManager.get"> |
|
127 <code class="descname">get</code><span class="sig-paren">(</span><em>name</em>, <em>default=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.manager.ViewletManager.get" title="Permalink to this definition">¶</a></dt> |
|
128 <dd><p>See zope.interface.common.mapping.IReadMapping</p> |
|
129 </dd></dl> |
|
130 |
|
131 <dl class="attribute"> |
|
132 <dt id="pyams_viewlet.manager.ViewletManager.permission"> |
|
133 <code class="descname">permission</code><em class="property"> = None</em><a class="headerlink" href="#pyams_viewlet.manager.ViewletManager.permission" title="Permalink to this definition">¶</a></dt> |
|
134 <dd></dd></dl> |
|
135 |
|
136 <dl class="method"> |
|
137 <dt id="pyams_viewlet.manager.ViewletManager.render"> |
|
138 <code class="descname">render</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.manager.ViewletManager.render" title="Permalink to this definition">¶</a></dt> |
|
139 <dd><p>See zope.contentprovider.interfaces.IContentProvider</p> |
|
140 </dd></dl> |
|
141 |
|
142 <dl class="method"> |
|
143 <dt id="pyams_viewlet.manager.ViewletManager.sort"> |
|
144 <code class="descname">sort</code><span class="sig-paren">(</span><em>viewlets</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.manager.ViewletManager.sort" title="Permalink to this definition">¶</a></dt> |
|
145 <dd><p>Sort the viewlets.</p> |
|
146 <p><code class="docutils literal"><span class="pre">viewlets</span></code> is a list of tuples of the form (name, viewlet).</p> |
|
147 </dd></dl> |
|
148 |
|
149 <dl class="attribute"> |
|
150 <dt id="pyams_viewlet.manager.ViewletManager.template"> |
|
151 <code class="descname">template</code><em class="property"> = None</em><a class="headerlink" href="#pyams_viewlet.manager.ViewletManager.template" title="Permalink to this definition">¶</a></dt> |
|
152 <dd></dd></dl> |
|
153 |
|
154 <dl class="method"> |
|
155 <dt id="pyams_viewlet.manager.ViewletManager.update"> |
|
156 <code class="descname">update</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.manager.ViewletManager.update" title="Permalink to this definition">¶</a></dt> |
|
157 <dd><p>See zope.contentprovider.interfaces.IContentProvider</p> |
|
158 </dd></dl> |
|
159 |
|
160 </dd></dl> |
|
161 |
|
162 <dl class="function"> |
|
163 <dt id="pyams_viewlet.manager.ViewletManagerFactory"> |
|
164 <code class="descclassname">pyams_viewlet.manager.</code><code class="descname">ViewletManagerFactory</code><span class="sig-paren">(</span><em>name</em>, <em>interface</em>, <em>bases=()</em>, <em>cdict=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.manager.ViewletManagerFactory" title="Permalink to this definition">¶</a></dt> |
|
165 <dd><p>Viewlet manager factory</p> |
|
166 </dd></dl> |
|
167 |
|
168 <dl class="class"> |
|
169 <dt id="pyams_viewlet.manager.WeightOrderedViewletManager"> |
|
170 <em class="property">class </em><code class="descclassname">pyams_viewlet.manager.</code><code class="descname">WeightOrderedViewletManager</code><span class="sig-paren">(</span><em>context</em>, <em>request</em>, <em>view</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.manager.WeightOrderedViewletManager" title="Permalink to this definition">¶</a></dt> |
|
171 <dd><p>Bases: <a class="reference internal" href="#pyams_viewlet.manager.ViewletManager" title="pyams_viewlet.manager.ViewletManager"><code class="xref py py-class docutils literal"><span class="pre">pyams_viewlet.manager.ViewletManager</span></code></a></p> |
|
172 <p>Weight ordered viewlet managers.</p> |
|
173 <dl class="method"> |
|
174 <dt id="pyams_viewlet.manager.WeightOrderedViewletManager.sort"> |
|
175 <code class="descname">sort</code><span class="sig-paren">(</span><em>viewlets</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.manager.WeightOrderedViewletManager.sort" title="Permalink to this definition">¶</a></dt> |
|
176 <dd></dd></dl> |
|
177 |
|
178 </dd></dl> |
|
179 |
|
180 <dl class="function"> |
|
181 <dt id="pyams_viewlet.manager.get_weight"> |
|
182 <code class="descclassname">pyams_viewlet.manager.</code><code class="descname">get_weight</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.manager.get_weight" title="Permalink to this definition">¶</a></dt> |
|
183 <dd></dd></dl> |
|
184 |
|
185 <dl class="function"> |
|
186 <dt id="pyams_viewlet.manager.is_available"> |
|
187 <code class="descclassname">pyams_viewlet.manager.</code><code class="descname">is_available</code><span class="sig-paren">(</span><em>viewlet</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.manager.is_available" title="Permalink to this definition">¶</a></dt> |
|
188 <dd></dd></dl> |
|
189 |
|
190 <dl class="class"> |
|
191 <dt id="pyams_viewlet.manager.viewletmanager_config"> |
|
192 <em class="property">class </em><code class="descclassname">pyams_viewlet.manager.</code><code class="descname">viewletmanager_config</code><span class="sig-paren">(</span><em>**settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.manager.viewletmanager_config" title="Permalink to this definition">¶</a></dt> |
|
193 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
194 <p>Class or interface decorator used to declare a viewlet manager</p> |
|
195 <p>You can provide same arguments as in ‘viewletManager’ ZCML directive: |
|
196 @name = name of the viewlet; may be unique for a given viewlet manager |
|
197 @view = the view class or interface for which viewlet is displayed |
|
198 @for_ = the context class or interface for which viewlet is displayed |
|
199 @permission = name of a permission required to display the viewlet |
|
200 @layer = request interface required to display the viewlet |
|
201 @class_ = the class handling the viewlet manager; if the decorator is applied</p> |
|
202 <blockquote> |
|
203 <div>on an interface and if this argument is not provided, the viewlet manager |
|
204 will be handled by a default ViewletManager class</div></blockquote> |
|
205 <dl class="docutils"> |
|
206 <dt>@provides = an interface the viewlet manager provides; if the decorator is</dt> |
|
207 <dd>applied on an Interface, this will be the decorated interface; if the |
|
208 decorated is applied on a class and if this argument is not specified, |
|
209 the manager will provide IViewletManager interface.</dd> |
|
210 </dl> |
|
211 <dl class="attribute"> |
|
212 <dt id="pyams_viewlet.manager.viewletmanager_config.venusian"> |
|
213 <code class="descname">venusian</code><em class="property"> = <module 'venusian' from '/var/local/env/pycharm/lib/python3.5/site-packages/venusian/__init__.py'></em><a class="headerlink" href="#pyams_viewlet.manager.viewletmanager_config.venusian" title="Permalink to this definition">¶</a></dt> |
|
214 <dd></dd></dl> |
|
215 |
|
216 </dd></dl> |
|
217 |
|
218 </div> |
|
219 <div class="section" id="module-pyams_viewlet.metaconfigure"> |
|
220 <span id="pyams-viewlet-metaconfigure-module"></span><h3>pyams_viewlet.metaconfigure module<a class="headerlink" href="#module-pyams_viewlet.metaconfigure" title="Permalink to this headline">¶</a></h3> |
|
221 <dl class="function"> |
|
222 <dt id="pyams_viewlet.metaconfigure.ViewletDirective"> |
|
223 <code class="descclassname">pyams_viewlet.metaconfigure.</code><code class="descname">ViewletDirective</code><span class="sig-paren">(</span><em>_context</em>, <em>name</em>, <em>class_</em>, <em>context=<InterfaceClass zope.interface.Interface></em>, <em>layer=<InterfaceClass pyramid.interfaces.IRequest></em>, <em>view=<InterfaceClass pyramid.interfaces.IView></em>, <em>manager=<InterfaceClass pyams_viewlet.interfaces.IViewletManager></em>, <em>attribute='render'</em>, <em>permission=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.metaconfigure.ViewletDirective" title="Permalink to this definition">¶</a></dt> |
|
224 <dd></dd></dl> |
|
225 |
|
226 <dl class="function"> |
|
227 <dt id="pyams_viewlet.metaconfigure.ViewletManagerDirective"> |
|
228 <code class="descclassname">pyams_viewlet.metaconfigure.</code><code class="descname">ViewletManagerDirective</code><span class="sig-paren">(</span><em>_context</em>, <em>name</em>, <em>context=<InterfaceClass zope.interface.Interface></em>, <em>layer=<InterfaceClass pyramid.interfaces.IRequest></em>, <em>view=<InterfaceClass pyramid.interfaces.IView></em>, <em>provides=<InterfaceClass pyams_viewlet.interfaces.IViewletManager></em>, <em>class_=None</em>, <em>permission=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.metaconfigure.ViewletManagerDirective" title="Permalink to this definition">¶</a></dt> |
|
229 <dd></dd></dl> |
|
230 |
|
231 </div> |
|
232 <div class="section" id="module-pyams_viewlet.metadirectives"> |
|
233 <span id="pyams-viewlet-metadirectives-module"></span><h3>pyams_viewlet.metadirectives module<a class="headerlink" href="#module-pyams_viewlet.metadirectives" title="Permalink to this headline">¶</a></h3> |
|
234 </div> |
|
235 <div class="section" id="module-pyams_viewlet.provider"> |
|
236 <span id="pyams-viewlet-provider-module"></span><h3>pyams_viewlet.provider module<a class="headerlink" href="#module-pyams_viewlet.provider" title="Permalink to this headline">¶</a></h3> |
|
237 <dl class="class"> |
|
238 <dt id="pyams_viewlet.provider.ProviderExpr"> |
|
239 <em class="property">class </em><code class="descclassname">pyams_viewlet.provider.</code><code class="descname">ProviderExpr</code><span class="sig-paren">(</span><em>expression</em>, <em>braces_required=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.provider.ProviderExpr" title="Permalink to this definition">¶</a></dt> |
|
240 <dd><p>Bases: <a class="reference internal" href="pyams_utils.html#pyams_utils.tales.ContextExprMixin" title="pyams_utils.tales.ContextExprMixin"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.tales.ContextExprMixin</span></code></a>, <code class="xref py py-class docutils literal"><span class="pre">chameleon.tales.StringExpr</span></code></p> |
|
241 <p>provider: TALES expression</p> |
|
242 <dl class="attribute"> |
|
243 <dt id="pyams_viewlet.provider.ProviderExpr.transform"> |
|
244 <code class="descname">transform</code><em class="property"> = <Symbol value=<function render_content_provider> at 7fe785bf55c0></em><a class="headerlink" href="#pyams_viewlet.provider.ProviderExpr.transform" title="Permalink to this definition">¶</a></dt> |
|
245 <dd></dd></dl> |
|
246 |
|
247 </dd></dl> |
|
248 |
|
249 <dl class="function"> |
|
250 <dt id="pyams_viewlet.provider.render_content_provider"> |
|
251 <code class="descclassname">pyams_viewlet.provider.</code><code class="descname">render_content_provider</code><span class="sig-paren">(</span><em>econtext</em>, <em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.provider.render_content_provider" title="Permalink to this definition">¶</a></dt> |
|
252 <dd></dd></dl> |
|
253 |
|
254 </div> |
|
255 <div class="section" id="module-pyams_viewlet.viewlet"> |
|
256 <span id="pyams-viewlet-viewlet-module"></span><h3>pyams_viewlet.viewlet module<a class="headerlink" href="#module-pyams_viewlet.viewlet" title="Permalink to this headline">¶</a></h3> |
|
257 <dl class="class"> |
|
258 <dt id="pyams_viewlet.viewlet.BaseContentProvider"> |
|
259 <em class="property">class </em><code class="descclassname">pyams_viewlet.viewlet.</code><code class="descname">BaseContentProvider</code><span class="sig-paren">(</span><em>context</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.viewlet.BaseContentProvider" title="Permalink to this definition">¶</a></dt> |
|
260 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
261 <p>Base template based content provider</p> |
|
262 <dl class="attribute"> |
|
263 <dt id="pyams_viewlet.viewlet.BaseContentProvider.permission"> |
|
264 <code class="descname">permission</code><em class="property"> = None</em><a class="headerlink" href="#pyams_viewlet.viewlet.BaseContentProvider.permission" title="Permalink to this definition">¶</a></dt> |
|
265 <dd></dd></dl> |
|
266 |
|
267 <dl class="attribute"> |
|
268 <dt id="pyams_viewlet.viewlet.BaseContentProvider.render"> |
|
269 <code class="descname">render</code><em class="property"> = <BoundViewTemplate of None></em><a class="headerlink" href="#pyams_viewlet.viewlet.BaseContentProvider.render" title="Permalink to this definition">¶</a></dt> |
|
270 <dd></dd></dl> |
|
271 |
|
272 <dl class="method"> |
|
273 <dt id="pyams_viewlet.viewlet.BaseContentProvider.update"> |
|
274 <code class="descname">update</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.viewlet.BaseContentProvider.update" title="Permalink to this definition">¶</a></dt> |
|
275 <dd></dd></dl> |
|
276 |
|
277 </dd></dl> |
|
278 |
|
279 <dl class="class"> |
|
280 <dt id="pyams_viewlet.viewlet.ViewContentProvider"> |
|
281 <em class="property">class </em><code class="descclassname">pyams_viewlet.viewlet.</code><code class="descname">ViewContentProvider</code><span class="sig-paren">(</span><em>context</em>, <em>request</em>, <em>view</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.viewlet.ViewContentProvider" title="Permalink to this definition">¶</a></dt> |
|
282 <dd><p>Bases: <a class="reference internal" href="#pyams_viewlet.viewlet.BaseContentProvider" title="pyams_viewlet.viewlet.BaseContentProvider"><code class="xref py py-class docutils literal"><span class="pre">pyams_viewlet.viewlet.BaseContentProvider</span></code></a></p> |
|
283 <p>Template based content provider</p> |
|
284 </dd></dl> |
|
285 |
|
286 <dl class="class"> |
|
287 <dt id="pyams_viewlet.viewlet.Viewlet"> |
|
288 <em class="property">class </em><code class="descclassname">pyams_viewlet.viewlet.</code><code class="descname">Viewlet</code><span class="sig-paren">(</span><em>context</em>, <em>request</em>, <em>view</em>, <em>manager</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.viewlet.Viewlet" title="Permalink to this definition">¶</a></dt> |
|
289 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
290 <p>Viewlet adapter class used in meta directive as a mixin class.</p> |
|
291 <dl class="attribute"> |
|
292 <dt id="pyams_viewlet.viewlet.Viewlet.permission"> |
|
293 <code class="descname">permission</code><em class="property"> = None</em><a class="headerlink" href="#pyams_viewlet.viewlet.Viewlet.permission" title="Permalink to this definition">¶</a></dt> |
|
294 <dd></dd></dl> |
|
295 |
|
296 <dl class="attribute"> |
|
297 <dt id="pyams_viewlet.viewlet.Viewlet.render"> |
|
298 <code class="descname">render</code><em class="property"> = <BoundViewTemplate of None></em><a class="headerlink" href="#pyams_viewlet.viewlet.Viewlet.render" title="Permalink to this definition">¶</a></dt> |
|
299 <dd></dd></dl> |
|
300 |
|
301 <dl class="method"> |
|
302 <dt id="pyams_viewlet.viewlet.Viewlet.update"> |
|
303 <code class="descname">update</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.viewlet.Viewlet.update" title="Permalink to this definition">¶</a></dt> |
|
304 <dd></dd></dl> |
|
305 |
|
306 </dd></dl> |
|
307 |
|
308 <dl class="class"> |
|
309 <dt id="pyams_viewlet.viewlet.contentprovider_config"> |
|
310 <em class="property">class </em><code class="descclassname">pyams_viewlet.viewlet.</code><code class="descname">contentprovider_config</code><span class="sig-paren">(</span><em>**settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.viewlet.contentprovider_config" title="Permalink to this definition">¶</a></dt> |
|
311 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
312 <p>Class decorator used to declare a content provider</p> |
|
313 <p>You can provide same arguments as in ‘viewlet’ ZCML directive: |
|
314 @name = name of the viewlet; may be unique for a given viewlet manager |
|
315 @view = the view class or interface for which viewlet is displayed |
|
316 @for = the context class or interface for which viewlet is displayed |
|
317 @permission = name of a permission required to display the viewlet |
|
318 @layer = request interface required to display the viewlet</p> |
|
319 <dl class="attribute"> |
|
320 <dt id="pyams_viewlet.viewlet.contentprovider_config.venusian"> |
|
321 <code class="descname">venusian</code><em class="property"> = <module 'venusian' from '/var/local/env/pycharm/lib/python3.5/site-packages/venusian/__init__.py'></em><a class="headerlink" href="#pyams_viewlet.viewlet.contentprovider_config.venusian" title="Permalink to this definition">¶</a></dt> |
|
322 <dd></dd></dl> |
|
323 |
|
324 </dd></dl> |
|
325 |
|
326 <dl class="class"> |
|
327 <dt id="pyams_viewlet.viewlet.viewlet_config"> |
|
328 <em class="property">class </em><code class="descclassname">pyams_viewlet.viewlet.</code><code class="descname">viewlet_config</code><span class="sig-paren">(</span><em>**settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_viewlet.viewlet.viewlet_config" title="Permalink to this definition">¶</a></dt> |
|
329 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
330 <p>Class decorator used to declare a viewlet</p> |
|
331 <p>You can provide same arguments as in ‘viewlet’ ZCML directive: |
|
332 @name = name of the viewlet; may be unique for a given viewlet manager |
|
333 @manager = manager class or interface holding the viewlet |
|
334 @view = the view class or interface for which viewlet is displayed |
|
335 @for = the context class or interface for which viewlet is displayed |
|
336 @permission = name of a permission required to display the viewlet |
|
337 @layer = request interface required to display the viewlet |
|
338 @weight = weight of the viewlet when using a weight ordered viewlet manager</p> |
|
339 <dl class="attribute"> |
|
340 <dt id="pyams_viewlet.viewlet.viewlet_config.venusian"> |
|
341 <code class="descname">venusian</code><em class="property"> = <module 'venusian' from '/var/local/env/pycharm/lib/python3.5/site-packages/venusian/__init__.py'></em><a class="headerlink" href="#pyams_viewlet.viewlet.viewlet_config.venusian" title="Permalink to this definition">¶</a></dt> |
|
342 <dd></dd></dl> |
|
343 |
|
344 </dd></dl> |
|
345 |
|
346 </div> |
|
347 </div> |
|
348 </div> |
|
349 |
|
350 |
|
351 </div> |
|
352 </div> |
|
353 </div> |
|
354 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
355 <div class="sphinxsidebarwrapper"> |
|
356 <h3><a href="index.html">Table Of Contents</a></h3> |
|
357 <ul> |
|
358 <li><a class="reference internal" href="#">PyAMS viewlets</a><ul> |
|
359 <li><a class="reference internal" href="#module-pyams_viewlet">Module contents</a></li> |
|
360 <li><a class="reference internal" href="#subpackages">Subpackages</a></li> |
|
361 <li><a class="reference internal" href="#submodules">Submodules</a><ul> |
|
362 <li><a class="reference internal" href="#module-pyams_viewlet.manager">pyams_viewlet.manager module</a></li> |
|
363 <li><a class="reference internal" href="#module-pyams_viewlet.metaconfigure">pyams_viewlet.metaconfigure module</a></li> |
|
364 <li><a class="reference internal" href="#module-pyams_viewlet.metadirectives">pyams_viewlet.metadirectives module</a></li> |
|
365 <li><a class="reference internal" href="#module-pyams_viewlet.provider">pyams_viewlet.provider module</a></li> |
|
366 <li><a class="reference internal" href="#module-pyams_viewlet.viewlet">pyams_viewlet.viewlet module</a></li> |
|
367 </ul> |
|
368 </li> |
|
369 </ul> |
|
370 </li> |
|
371 </ul> |
|
372 |
|
373 <div id="searchbox" style="display: none" role="search"> |
|
374 <h3>Quick search</h3> |
|
375 <form class="search" action="search.html" method="get"> |
|
376 <div><input type="text" name="q" /></div> |
|
377 <div><input type="submit" value="Go" /></div> |
|
378 <input type="hidden" name="check_keywords" value="yes" /> |
|
379 <input type="hidden" name="area" value="default" /> |
|
380 </form> |
|
381 </div> |
|
382 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
383 </div> |
|
384 </div> |
|
385 <div class="clearer"></div> |
|
386 </div> |
|
387 <div class="related" role="navigation" aria-label="related navigation"> |
|
388 <h3>Navigation</h3> |
|
389 <ul> |
|
390 <li class="right" style="margin-right: 10px"> |
|
391 <a href="genindex.html" title="General Index" |
|
392 >index</a></li> |
|
393 <li class="right" > |
|
394 <a href="py-modindex.html" title="Python Module Index" |
|
395 >modules</a> |</li> |
|
396 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
397 </ul> |
|
398 </div> |
|
399 <div class="footer" role="contentinfo"> |
|
400 © Copyright 2017, Thierry Florac. |
|
401 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
402 </div> |
|
403 </body> |
|
404 </html> |
|