|
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_security.widget package — 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-security-widget-package"> |
|
54 <h1>pyams_security.widget package<a class="headerlink" href="#pyams-security-widget-package" title="Permalink to this headline">¶</a></h1> |
|
55 <div class="section" id="submodules"> |
|
56 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
57 </div> |
|
58 <div class="section" id="module-pyams_security.widget.interfaces"> |
|
59 <span id="pyams-security-widget-interfaces-module"></span><h2>pyams_security.widget.interfaces module<a class="headerlink" href="#module-pyams_security.widget.interfaces" title="Permalink to this headline">¶</a></h2> |
|
60 </div> |
|
61 <div class="section" id="module-pyams_security.widget"> |
|
62 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_security.widget" title="Permalink to this headline">¶</a></h2> |
|
63 <dl class="class"> |
|
64 <dt id="pyams_security.widget.PermissionDataConverter"> |
|
65 <em class="property">class </em><code class="descclassname">pyams_security.widget.</code><code class="descname">PermissionDataConverter</code><span class="sig-paren">(</span><em>field</em>, <em>widget</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PermissionDataConverter" title="Permalink to this definition">¶</a></dt> |
|
66 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">z3c.form.converter.BaseDataConverter</span></code></p> |
|
67 <p>Permission data converter</p> |
|
68 <dl class="method"> |
|
69 <dt id="pyams_security.widget.PermissionDataConverter.toFieldValue"> |
|
70 <code class="descname">toFieldValue</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PermissionDataConverter.toFieldValue" title="Permalink to this definition">¶</a></dt> |
|
71 <dd></dd></dl> |
|
72 |
|
73 <dl class="method"> |
|
74 <dt id="pyams_security.widget.PermissionDataConverter.toWidgetValue"> |
|
75 <code class="descname">toWidgetValue</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PermissionDataConverter.toWidgetValue" title="Permalink to this definition">¶</a></dt> |
|
76 <dd></dd></dl> |
|
77 |
|
78 </dd></dl> |
|
79 |
|
80 <dl class="function"> |
|
81 <dt id="pyams_security.widget.PermissionFieldWidget"> |
|
82 <code class="descclassname">pyams_security.widget.</code><code class="descname">PermissionFieldWidget</code><span class="sig-paren">(</span><em>field</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PermissionFieldWidget" title="Permalink to this definition">¶</a></dt> |
|
83 <dd><p>Permission field widget factory</p> |
|
84 </dd></dl> |
|
85 |
|
86 <dl class="class"> |
|
87 <dt id="pyams_security.widget.PermissionWidget"> |
|
88 <em class="property">class </em><code class="descclassname">pyams_security.widget.</code><code class="descname">PermissionWidget</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PermissionWidget" title="Permalink to this definition">¶</a></dt> |
|
89 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">z3c.form.browser.select.SelectWidget</span></code></p> |
|
90 <p>Principal widget</p> |
|
91 <dl class="method"> |
|
92 <dt id="pyams_security.widget.PermissionWidget.extract"> |
|
93 <code class="descname">extract</code><span class="sig-paren">(</span><em>default=<NO_VALUE></em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PermissionWidget.extract" title="Permalink to this definition">¶</a></dt> |
|
94 <dd></dd></dl> |
|
95 |
|
96 <dl class="method"> |
|
97 <dt id="pyams_security.widget.PermissionWidget.isSelected"> |
|
98 <code class="descname">isSelected</code><span class="sig-paren">(</span><em>term</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PermissionWidget.isSelected" title="Permalink to this definition">¶</a></dt> |
|
99 <dd></dd></dl> |
|
100 |
|
101 <dl class="method"> |
|
102 <dt id="pyams_security.widget.PermissionWidget.items"> |
|
103 <code class="descname">items</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PermissionWidget.items" title="Permalink to this definition">¶</a></dt> |
|
104 <dd></dd></dl> |
|
105 |
|
106 <dl class="attribute"> |
|
107 <dt id="pyams_security.widget.PermissionWidget.value_map"> |
|
108 <code class="descname">value_map</code><a class="headerlink" href="#pyams_security.widget.PermissionWidget.value_map" title="Permalink to this definition">¶</a></dt> |
|
109 <dd></dd></dl> |
|
110 |
|
111 </dd></dl> |
|
112 |
|
113 <dl class="class"> |
|
114 <dt id="pyams_security.widget.PermissionsSetDataConverter"> |
|
115 <em class="property">class </em><code class="descclassname">pyams_security.widget.</code><code class="descname">PermissionsSetDataConverter</code><span class="sig-paren">(</span><em>field</em>, <em>widget</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PermissionsSetDataConverter" title="Permalink to this definition">¶</a></dt> |
|
116 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">z3c.form.converter.BaseDataConverter</span></code></p> |
|
117 <p>Permissions set data converter</p> |
|
118 <dl class="method"> |
|
119 <dt id="pyams_security.widget.PermissionsSetDataConverter.toFieldValue"> |
|
120 <code class="descname">toFieldValue</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PermissionsSetDataConverter.toFieldValue" title="Permalink to this definition">¶</a></dt> |
|
121 <dd></dd></dl> |
|
122 |
|
123 <dl class="method"> |
|
124 <dt id="pyams_security.widget.PermissionsSetDataConverter.toWidgetValue"> |
|
125 <code class="descname">toWidgetValue</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PermissionsSetDataConverter.toWidgetValue" title="Permalink to this definition">¶</a></dt> |
|
126 <dd></dd></dl> |
|
127 |
|
128 </dd></dl> |
|
129 |
|
130 <dl class="function"> |
|
131 <dt id="pyams_security.widget.PermissionsSetFieldWidget"> |
|
132 <code class="descclassname">pyams_security.widget.</code><code class="descname">PermissionsSetFieldWidget</code><span class="sig-paren">(</span><em>field</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PermissionsSetFieldWidget" title="Permalink to this definition">¶</a></dt> |
|
133 <dd><p>Permissions set field widget factory</p> |
|
134 </dd></dl> |
|
135 |
|
136 <dl class="class"> |
|
137 <dt id="pyams_security.widget.PermissionsSetWidget"> |
|
138 <em class="property">class </em><code class="descclassname">pyams_security.widget.</code><code class="descname">PermissionsSetWidget</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PermissionsSetWidget" title="Permalink to this definition">¶</a></dt> |
|
139 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">z3c.form.browser.widget.HTMLInputWidget</span></code>, <code class="xref py py-class docutils literal"><span class="pre">z3c.form.widget.Widget</span></code></p> |
|
140 <p>Permissions set widget</p> |
|
141 <dl class="attribute"> |
|
142 <dt id="pyams_security.widget.PermissionsSetWidget.values_data"> |
|
143 <code class="descname">values_data</code><a class="headerlink" href="#pyams_security.widget.PermissionsSetWidget.values_data" title="Permalink to this definition">¶</a></dt> |
|
144 <dd></dd></dl> |
|
145 |
|
146 <dl class="attribute"> |
|
147 <dt id="pyams_security.widget.PermissionsSetWidget.values_map"> |
|
148 <code class="descname">values_map</code><a class="headerlink" href="#pyams_security.widget.PermissionsSetWidget.values_map" title="Permalink to this definition">¶</a></dt> |
|
149 <dd></dd></dl> |
|
150 |
|
151 <dl class="attribute"> |
|
152 <dt id="pyams_security.widget.PermissionsSetWidget.values_str"> |
|
153 <code class="descname">values_str</code><a class="headerlink" href="#pyams_security.widget.PermissionsSetWidget.values_str" title="Permalink to this definition">¶</a></dt> |
|
154 <dd></dd></dl> |
|
155 |
|
156 </dd></dl> |
|
157 |
|
158 <dl class="class"> |
|
159 <dt id="pyams_security.widget.PrincipalDataConverter"> |
|
160 <em class="property">class </em><code class="descclassname">pyams_security.widget.</code><code class="descname">PrincipalDataConverter</code><span class="sig-paren">(</span><em>field</em>, <em>widget</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PrincipalDataConverter" title="Permalink to this definition">¶</a></dt> |
|
161 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">z3c.form.converter.BaseDataConverter</span></code></p> |
|
162 <p>Principal data converter</p> |
|
163 <dl class="method"> |
|
164 <dt id="pyams_security.widget.PrincipalDataConverter.toFieldValue"> |
|
165 <code class="descname">toFieldValue</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PrincipalDataConverter.toFieldValue" title="Permalink to this definition">¶</a></dt> |
|
166 <dd></dd></dl> |
|
167 |
|
168 <dl class="method"> |
|
169 <dt id="pyams_security.widget.PrincipalDataConverter.toWidgetValue"> |
|
170 <code class="descname">toWidgetValue</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PrincipalDataConverter.toWidgetValue" title="Permalink to this definition">¶</a></dt> |
|
171 <dd></dd></dl> |
|
172 |
|
173 </dd></dl> |
|
174 |
|
175 <dl class="function"> |
|
176 <dt id="pyams_security.widget.PrincipalFieldWidget"> |
|
177 <code class="descclassname">pyams_security.widget.</code><code class="descname">PrincipalFieldWidget</code><span class="sig-paren">(</span><em>field</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PrincipalFieldWidget" title="Permalink to this definition">¶</a></dt> |
|
178 <dd><p>Principal field widget factory</p> |
|
179 </dd></dl> |
|
180 |
|
181 <dl class="class"> |
|
182 <dt id="pyams_security.widget.PrincipalWidget"> |
|
183 <em class="property">class </em><code class="descclassname">pyams_security.widget.</code><code class="descname">PrincipalWidget</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PrincipalWidget" title="Permalink to this definition">¶</a></dt> |
|
184 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">z3c.form.browser.widget.HTMLInputWidget</span></code>, <code class="xref py py-class docutils literal"><span class="pre">z3c.form.widget.Widget</span></code></p> |
|
185 <p>Principal widget</p> |
|
186 <dl class="attribute"> |
|
187 <dt id="pyams_security.widget.PrincipalWidget.value_map"> |
|
188 <code class="descname">value_map</code><a class="headerlink" href="#pyams_security.widget.PrincipalWidget.value_map" title="Permalink to this definition">¶</a></dt> |
|
189 <dd></dd></dl> |
|
190 |
|
191 </dd></dl> |
|
192 |
|
193 <dl class="class"> |
|
194 <dt id="pyams_security.widget.PrincipalsSetDataConverter"> |
|
195 <em class="property">class </em><code class="descclassname">pyams_security.widget.</code><code class="descname">PrincipalsSetDataConverter</code><span class="sig-paren">(</span><em>field</em>, <em>widget</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PrincipalsSetDataConverter" title="Permalink to this definition">¶</a></dt> |
|
196 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">z3c.form.converter.BaseDataConverter</span></code></p> |
|
197 <p>Principals set data converter</p> |
|
198 <dl class="method"> |
|
199 <dt id="pyams_security.widget.PrincipalsSetDataConverter.toFieldValue"> |
|
200 <code class="descname">toFieldValue</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PrincipalsSetDataConverter.toFieldValue" title="Permalink to this definition">¶</a></dt> |
|
201 <dd></dd></dl> |
|
202 |
|
203 <dl class="method"> |
|
204 <dt id="pyams_security.widget.PrincipalsSetDataConverter.toWidgetValue"> |
|
205 <code class="descname">toWidgetValue</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PrincipalsSetDataConverter.toWidgetValue" title="Permalink to this definition">¶</a></dt> |
|
206 <dd></dd></dl> |
|
207 |
|
208 </dd></dl> |
|
209 |
|
210 <dl class="function"> |
|
211 <dt id="pyams_security.widget.PrincipalsSetFieldWidget"> |
|
212 <code class="descclassname">pyams_security.widget.</code><code class="descname">PrincipalsSetFieldWidget</code><span class="sig-paren">(</span><em>field</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PrincipalsSetFieldWidget" title="Permalink to this definition">¶</a></dt> |
|
213 <dd><p>Principals set field widget factory</p> |
|
214 </dd></dl> |
|
215 |
|
216 <dl class="class"> |
|
217 <dt id="pyams_security.widget.PrincipalsSetWidget"> |
|
218 <em class="property">class </em><code class="descclassname">pyams_security.widget.</code><code class="descname">PrincipalsSetWidget</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.widget.PrincipalsSetWidget" title="Permalink to this definition">¶</a></dt> |
|
219 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">z3c.form.browser.widget.HTMLInputWidget</span></code>, <code class="xref py py-class docutils literal"><span class="pre">z3c.form.widget.Widget</span></code></p> |
|
220 <p>Principals set widget</p> |
|
221 <dl class="attribute"> |
|
222 <dt id="pyams_security.widget.PrincipalsSetWidget.values_map"> |
|
223 <code class="descname">values_map</code><a class="headerlink" href="#pyams_security.widget.PrincipalsSetWidget.values_map" title="Permalink to this definition">¶</a></dt> |
|
224 <dd></dd></dl> |
|
225 |
|
226 </dd></dl> |
|
227 |
|
228 </div> |
|
229 </div> |
|
230 |
|
231 |
|
232 </div> |
|
233 </div> |
|
234 </div> |
|
235 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
236 <div class="sphinxsidebarwrapper"> |
|
237 <h3><a href="index.html">Table Of Contents</a></h3> |
|
238 <ul> |
|
239 <li><a class="reference internal" href="#">pyams_security.widget package</a><ul> |
|
240 <li><a class="reference internal" href="#submodules">Submodules</a></li> |
|
241 <li><a class="reference internal" href="#module-pyams_security.widget.interfaces">pyams_security.widget.interfaces module</a></li> |
|
242 <li><a class="reference internal" href="#module-pyams_security.widget">Module contents</a></li> |
|
243 </ul> |
|
244 </li> |
|
245 </ul> |
|
246 |
|
247 <div id="searchbox" style="display: none" role="search"> |
|
248 <h3>Quick search</h3> |
|
249 <form class="search" action="search.html" method="get"> |
|
250 <div><input type="text" name="q" /></div> |
|
251 <div><input type="submit" value="Go" /></div> |
|
252 <input type="hidden" name="check_keywords" value="yes" /> |
|
253 <input type="hidden" name="area" value="default" /> |
|
254 </form> |
|
255 </div> |
|
256 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
257 </div> |
|
258 </div> |
|
259 <div class="clearer"></div> |
|
260 </div> |
|
261 <div class="related" role="navigation" aria-label="related navigation"> |
|
262 <h3>Navigation</h3> |
|
263 <ul> |
|
264 <li class="right" style="margin-right: 10px"> |
|
265 <a href="genindex.html" title="General Index" |
|
266 >index</a></li> |
|
267 <li class="right" > |
|
268 <a href="py-modindex.html" title="Python Module Index" |
|
269 >modules</a> |</li> |
|
270 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
271 </ul> |
|
272 </div> |
|
273 <div class="footer" role="contentinfo"> |
|
274 © Copyright 2017, Thierry Florac. |
|
275 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
276 </div> |
|
277 </body> |
|
278 </html> |