|
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_thesaurus.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-thesaurus-widget-package"> |
|
54 <h1>pyams_thesaurus.widget package<a class="headerlink" href="#pyams-thesaurus-widget-package" title="Permalink to this headline">¶</a></h1> |
|
55 <div class="section" id="module-pyams_thesaurus.widget"> |
|
56 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_thesaurus.widget" title="Permalink to this headline">¶</a></h2> |
|
57 <dl class="class"> |
|
58 <dt id="pyams_thesaurus.widget.ThesaurusTermDataConverter"> |
|
59 <em class="property">class </em><code class="descclassname">pyams_thesaurus.widget.</code><code class="descname">ThesaurusTermDataConverter</code><span class="sig-paren">(</span><em>field</em>, <em>widget</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermDataConverter" title="Permalink to this definition">¶</a></dt> |
|
60 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">z3c.form.converter.BaseDataConverter</span></code></p> |
|
61 <p>Thesaurus term data converter</p> |
|
62 <dl class="method"> |
|
63 <dt id="pyams_thesaurus.widget.ThesaurusTermDataConverter.toFieldValue"> |
|
64 <code class="descname">toFieldValue</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermDataConverter.toFieldValue" title="Permalink to this definition">¶</a></dt> |
|
65 <dd></dd></dl> |
|
66 |
|
67 <dl class="method"> |
|
68 <dt id="pyams_thesaurus.widget.ThesaurusTermDataConverter.toWidgetValue"> |
|
69 <code class="descname">toWidgetValue</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermDataConverter.toWidgetValue" title="Permalink to this definition">¶</a></dt> |
|
70 <dd></dd></dl> |
|
71 |
|
72 </dd></dl> |
|
73 |
|
74 <dl class="function"> |
|
75 <dt id="pyams_thesaurus.widget.ThesaurusTermFieldWidget"> |
|
76 <code class="descclassname">pyams_thesaurus.widget.</code><code class="descname">ThesaurusTermFieldWidget</code><span class="sig-paren">(</span><em>field</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermFieldWidget" title="Permalink to this definition">¶</a></dt> |
|
77 <dd><p>Thesaurus term field widget factory</p> |
|
78 </dd></dl> |
|
79 |
|
80 <dl class="class"> |
|
81 <dt id="pyams_thesaurus.widget.ThesaurusTermWidget"> |
|
82 <em class="property">class </em><code class="descclassname">pyams_thesaurus.widget.</code><code class="descname">ThesaurusTermWidget</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermWidget" title="Permalink to this definition">¶</a></dt> |
|
83 <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> |
|
84 <p>Thesaurus term widget</p> |
|
85 <dl class="attribute"> |
|
86 <dt id="pyams_thesaurus.widget.ThesaurusTermWidget.extract_name"> |
|
87 <code class="descname">extract_name</code><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermWidget.extract_name" title="Permalink to this definition">¶</a></dt> |
|
88 <dd><p>Computed attributes based on schema fields</p> |
|
89 <p>Field properties provide default values, data validation and error messages |
|
90 based on data found in field meta-data.</p> |
|
91 <p>Note that FieldProperties cannot be used with slots. They can only |
|
92 be used for attributes stored in instance dictionaries.</p> |
|
93 </dd></dl> |
|
94 |
|
95 <dl class="attribute"> |
|
96 <dt id="pyams_thesaurus.widget.ThesaurusTermWidget.query_params"> |
|
97 <code class="descname">query_params</code><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermWidget.query_params" title="Permalink to this definition">¶</a></dt> |
|
98 <dd></dd></dl> |
|
99 |
|
100 <dl class="attribute"> |
|
101 <dt id="pyams_thesaurus.widget.ThesaurusTermWidget.thesaurus_name"> |
|
102 <code class="descname">thesaurus_name</code><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermWidget.thesaurus_name" title="Permalink to this definition">¶</a></dt> |
|
103 <dd><p>Computed attributes based on schema fields</p> |
|
104 <p>Field properties provide default values, data validation and error messages |
|
105 based on data found in field meta-data.</p> |
|
106 <p>Note that FieldProperties cannot be used with slots. They can only |
|
107 be used for attributes stored in instance dictionaries.</p> |
|
108 </dd></dl> |
|
109 |
|
110 <dl class="attribute"> |
|
111 <dt id="pyams_thesaurus.widget.ThesaurusTermWidget.values_map"> |
|
112 <code class="descname">values_map</code><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermWidget.values_map" title="Permalink to this definition">¶</a></dt> |
|
113 <dd></dd></dl> |
|
114 |
|
115 </dd></dl> |
|
116 |
|
117 <dl class="class"> |
|
118 <dt id="pyams_thesaurus.widget.ThesaurusTermsListDataConverter"> |
|
119 <em class="property">class </em><code class="descclassname">pyams_thesaurus.widget.</code><code class="descname">ThesaurusTermsListDataConverter</code><span class="sig-paren">(</span><em>field</em>, <em>widget</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermsListDataConverter" title="Permalink to this definition">¶</a></dt> |
|
120 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">z3c.form.converter.BaseDataConverter</span></code></p> |
|
121 <p>Thesaurus terms list data converter</p> |
|
122 <dl class="method"> |
|
123 <dt id="pyams_thesaurus.widget.ThesaurusTermsListDataConverter.toFieldValue"> |
|
124 <code class="descname">toFieldValue</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermsListDataConverter.toFieldValue" title="Permalink to this definition">¶</a></dt> |
|
125 <dd></dd></dl> |
|
126 |
|
127 <dl class="method"> |
|
128 <dt id="pyams_thesaurus.widget.ThesaurusTermsListDataConverter.toWidgetValue"> |
|
129 <code class="descname">toWidgetValue</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermsListDataConverter.toWidgetValue" title="Permalink to this definition">¶</a></dt> |
|
130 <dd></dd></dl> |
|
131 |
|
132 </dd></dl> |
|
133 |
|
134 <dl class="function"> |
|
135 <dt id="pyams_thesaurus.widget.ThesaurusTermsListFieldWidget"> |
|
136 <code class="descclassname">pyams_thesaurus.widget.</code><code class="descname">ThesaurusTermsListFieldWidget</code><span class="sig-paren">(</span><em>field</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermsListFieldWidget" title="Permalink to this definition">¶</a></dt> |
|
137 <dd><p>Thesaurus terms list field widget factory</p> |
|
138 </dd></dl> |
|
139 |
|
140 <dl class="function"> |
|
141 <dt id="pyams_thesaurus.widget.ThesaurusTermsListSelectorFieldWidget"> |
|
142 <code class="descclassname">pyams_thesaurus.widget.</code><code class="descname">ThesaurusTermsListSelectorFieldWidget</code><span class="sig-paren">(</span><em>field</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermsListSelectorFieldWidget" title="Permalink to this definition">¶</a></dt> |
|
143 <dd><p>Thesaurus terms list field widget with selector factory</p> |
|
144 </dd></dl> |
|
145 |
|
146 <dl class="class"> |
|
147 <dt id="pyams_thesaurus.widget.ThesaurusTermsListSelectorWidget"> |
|
148 <em class="property">class </em><code class="descclassname">pyams_thesaurus.widget.</code><code class="descname">ThesaurusTermsListSelectorWidget</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermsListSelectorWidget" title="Permalink to this definition">¶</a></dt> |
|
149 <dd><p>Bases: <a class="reference internal" href="#pyams_thesaurus.widget.ThesaurusTermsListWidget" title="pyams_thesaurus.widget.ThesaurusTermsListWidget"><code class="xref py py-class docutils literal"><span class="pre">pyams_thesaurus.widget.ThesaurusTermsListWidget</span></code></a></p> |
|
150 <p>Thesaurus terms list widget with selector</p> |
|
151 </dd></dl> |
|
152 |
|
153 <dl class="class"> |
|
154 <dt id="pyams_thesaurus.widget.ThesaurusTermsListWidget"> |
|
155 <em class="property">class </em><code class="descclassname">pyams_thesaurus.widget.</code><code class="descname">ThesaurusTermsListWidget</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermsListWidget" title="Permalink to this definition">¶</a></dt> |
|
156 <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> |
|
157 <p>Thesaurus terms list widget</p> |
|
158 <dl class="attribute"> |
|
159 <dt id="pyams_thesaurus.widget.ThesaurusTermsListWidget.extract_name"> |
|
160 <code class="descname">extract_name</code><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermsListWidget.extract_name" title="Permalink to this definition">¶</a></dt> |
|
161 <dd><p>Computed attributes based on schema fields</p> |
|
162 <p>Field properties provide default values, data validation and error messages |
|
163 based on data found in field meta-data.</p> |
|
164 <p>Note that FieldProperties cannot be used with slots. They can only |
|
165 be used for attributes stored in instance dictionaries.</p> |
|
166 </dd></dl> |
|
167 |
|
168 <dl class="attribute"> |
|
169 <dt id="pyams_thesaurus.widget.ThesaurusTermsListWidget.query_params"> |
|
170 <code class="descname">query_params</code><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermsListWidget.query_params" title="Permalink to this definition">¶</a></dt> |
|
171 <dd></dd></dl> |
|
172 |
|
173 <dl class="attribute"> |
|
174 <dt id="pyams_thesaurus.widget.ThesaurusTermsListWidget.thesaurus_name"> |
|
175 <code class="descname">thesaurus_name</code><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermsListWidget.thesaurus_name" title="Permalink to this definition">¶</a></dt> |
|
176 <dd><p>Computed attributes based on schema fields</p> |
|
177 <p>Field properties provide default values, data validation and error messages |
|
178 based on data found in field meta-data.</p> |
|
179 <p>Note that FieldProperties cannot be used with slots. They can only |
|
180 be used for attributes stored in instance dictionaries.</p> |
|
181 </dd></dl> |
|
182 |
|
183 <dl class="attribute"> |
|
184 <dt id="pyams_thesaurus.widget.ThesaurusTermsListWidget.values_map"> |
|
185 <code class="descname">values_map</code><a class="headerlink" href="#pyams_thesaurus.widget.ThesaurusTermsListWidget.values_map" title="Permalink to this definition">¶</a></dt> |
|
186 <dd></dd></dl> |
|
187 |
|
188 </dd></dl> |
|
189 |
|
190 </div> |
|
191 <div class="section" id="submodules"> |
|
192 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
193 <div class="section" id="module-pyams_thesaurus.widget.interfaces"> |
|
194 <span id="pyams-thesaurus-widget-interfaces-module"></span><h3>pyams_thesaurus.widget.interfaces module<a class="headerlink" href="#module-pyams_thesaurus.widget.interfaces" title="Permalink to this headline">¶</a></h3> |
|
195 </div> |
|
196 </div> |
|
197 </div> |
|
198 |
|
199 |
|
200 </div> |
|
201 </div> |
|
202 </div> |
|
203 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
204 <div class="sphinxsidebarwrapper"> |
|
205 <h3><a href="index.html">Table Of Contents</a></h3> |
|
206 <ul> |
|
207 <li><a class="reference internal" href="#">pyams_thesaurus.widget package</a><ul> |
|
208 <li><a class="reference internal" href="#module-pyams_thesaurus.widget">Module contents</a></li> |
|
209 <li><a class="reference internal" href="#submodules">Submodules</a><ul> |
|
210 <li><a class="reference internal" href="#module-pyams_thesaurus.widget.interfaces">pyams_thesaurus.widget.interfaces module</a></li> |
|
211 </ul> |
|
212 </li> |
|
213 </ul> |
|
214 </li> |
|
215 </ul> |
|
216 |
|
217 <div id="searchbox" style="display: none" role="search"> |
|
218 <h3>Quick search</h3> |
|
219 <form class="search" action="search.html" method="get"> |
|
220 <div><input type="text" name="q" /></div> |
|
221 <div><input type="submit" value="Go" /></div> |
|
222 <input type="hidden" name="check_keywords" value="yes" /> |
|
223 <input type="hidden" name="area" value="default" /> |
|
224 </form> |
|
225 </div> |
|
226 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
227 </div> |
|
228 </div> |
|
229 <div class="clearer"></div> |
|
230 </div> |
|
231 <div class="related" role="navigation" aria-label="related navigation"> |
|
232 <h3>Navigation</h3> |
|
233 <ul> |
|
234 <li class="right" style="margin-right: 10px"> |
|
235 <a href="genindex.html" title="General Index" |
|
236 >index</a></li> |
|
237 <li class="right" > |
|
238 <a href="py-modindex.html" title="Python Module Index" |
|
239 >modules</a> |</li> |
|
240 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
241 </ul> |
|
242 </div> |
|
243 <div class="footer" role="contentinfo"> |
|
244 © Copyright 2017, Thierry Florac. |
|
245 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
246 </div> |
|
247 </body> |
|
248 </html> |