root/trunk/infrastructure/pyd/doc/class_wrap.html

Revision 25, 11.9 kB (checked in by KirkMcDonald, 2 years ago)

Fleshed out the docs a little.

Line 
1 <html><head>
2 <meta http-equiv="content-type" content="text/html; charset=utf-8">
3 <meta content="text/javascript" http-equiv="content-script-type">
4 <title>pyd.class_wrap</title>
5 <link rel="stylesheet" type="text/css" href="candydoc/style.css">
6 <!--[if lt IE 7]><link rel="stylesheet" type="text/css" href="candydoc/ie56hack.css"><![endif]-->
7 <script language="JavaScript" src="candydoc/util.js" type="text/javascript"></script>
8 <script language="JavaScript" src="candydoc/tree.js" type="text/javascript"></script>
9 <script language="JavaScript" src="candydoc/explorer.js" type="text/javascript"></script>
10 </head><body>
11 <div id="tabarea"></div><div id="explorerclient"></div>
12 <div id="content"><script>explorer.initialize("pyd.class_wrap");</script>
13     <table class="content">
14         <tr><td id="docbody"><h1>pyd.class_wrap</h1><!-- Generated by Ddoc from pyd\class_wrap.d -->
15 <br><br>
16
17 <script>explorer.outline.incSymbolLevel();</script>
18 <dl>
19 <script>explorer.outline.writeEnabled = true;</script>
20 <dt><span class="decl">struct
21 <span class="currsymbol">
22 <span class="currsymbol">wrapped_class_object</span>
23 <script>explorer.outline.addDecl('wrapped_class_object');</script>
24
25 </span>
26 <script>explorer.outline.addDecl('
27 <span class="currsymbol">wrapped_class_object</span>
28 <script>explorer.outline.addDecl('wrapped_class_object');</script>
29
30 ');</script>
31
32 ;
33 </span></dt>
34 <script>explorer.outline.writeEnabled = false;</script>
35
36
37 <dd>The class object, a subtype of PyObject
38 <br><br>
39
40
41 <script>explorer.outline.incSymbolLevel();</script>
42 <dl></dl>
43 <script>explorer.outline.decSymbolLevel();</script>
44
45
46 </dd>
47
48 <script>explorer.outline.writeEnabled = true;</script>
49 <dt><span class="decl">template
50 <span class="currsymbol">wrapped_class_type</span>
51 <script>explorer.outline.addDecl('wrapped_class_type');</script>
52
53 (T)</span></dt>
54 <script>explorer.outline.writeEnabled = false;</script>
55
56
57 <dd><br><br>
58
59 <script>explorer.outline.incSymbolLevel();</script>
60 <dl>
61 <script>explorer.outline.writeEnabled = true;</script>
62 <dt><span class="decl">PyTypeObject
63 <span class="currsymbol">wrapped_class_type</span>
64 <script>explorer.outline.addDecl('wrapped_class_type');</script>
65
66 ;
67 </span></dt>
68 <script>explorer.outline.writeEnabled = false;</script>
69
70
71 <dd>The type object, an instance of PyType_Type
72 <br><br>
73
74 </dd>
75 </dl>
76 <script>explorer.outline.decSymbolLevel();</script>
77
78
79 </dd>
80
81 <script>explorer.outline.writeEnabled = true;</script>
82 <dt><span class="decl">template
83 <span class="currsymbol">wrapped_methods</span>
84 <script>explorer.outline.addDecl('wrapped_methods');</script>
85
86 (T)</span></dt>
87 <script>explorer.outline.writeEnabled = false;</script>
88
89
90 <dd>Various wrapped methods
91 <br><br>
92
93
94 <script>explorer.outline.incSymbolLevel();</script>
95 <dl>
96 <script>explorer.outline.writeEnabled = true;</script>
97 <dt><span class="decl">PyObject*
98 <span class="currsymbol">wrapped_new</span>
99 <script>explorer.outline.addDecl('wrapped_new');</script>
100
101 (PyTypeObject* <span class="funcparam">type</span>, PyObject* <span class="funcparam">args</span>, PyObject* <span class="funcparam">kwds</span>);
102 </span></dt>
103 <script>explorer.outline.writeEnabled = false;</script>
104
105
106 <dd>The generic "_new__" method
107 <br><br>
108
109 </dd>
110
111 <script>explorer.outline.writeEnabled = true;</script>
112 <dt><span class="decl">void
113 <span class="currsymbol">wrapped_dealloc</span>
114 <script>explorer.outline.addDecl('wrapped_dealloc');</script>
115
116 (PyObject* <span class="funcparam">_self</span>);
117 </span></dt>
118 <script>explorer.outline.writeEnabled = false;</script>
119
120
121 <dd>The generic dealloc method.
122 <br><br>
123
124 </dd>
125
126 <script>explorer.outline.writeEnabled = true;</script>
127 <dt><span class="decl">PyObject*
128 <span class="currsymbol">wrapped_repr</span>
129 <script>explorer.outline.addDecl('wrapped_repr');</script>
130
131 (PyObject* <span class="funcparam">_self</span>);
132 </span></dt>
133 <script>explorer.outline.writeEnabled = false;</script>
134
135
136 <dd>The default repr method calls the class's toString.
137 <br><br>
138
139 </dd>
140 </dl>
141 <script>explorer.outline.decSymbolLevel();</script>
142
143
144 </dd>
145
146 <script>explorer.outline.writeEnabled = true;</script>
147 <dt><span class="decl">template
148 <span class="currsymbol">wrapped_init</span>
149 <script>explorer.outline.addDecl('wrapped_init');</script>
150
151 (T)</span></dt>
152 <script>explorer.outline.writeEnabled = false;</script>
153
154
155 <dd><br><br>
156
157 <script>explorer.outline.incSymbolLevel();</script>
158 <dl>
159 <script>explorer.outline.writeEnabled = true;</script>
160 <dt><span class="decl">int
161 <span class="currsymbol">init</span>
162 <script>explorer.outline.addDecl('init');</script>
163
164 (PyObject* <span class="funcparam">self</span>, PyObject* <span class="funcparam">args</span>, PyObject* <span class="funcparam">kwds</span>);
165 </span></dt>
166 <script>explorer.outline.writeEnabled = false;</script>
167
168
169 <dd>The default init method calls the class's zero-argument constructor.
170 <br><br>
171
172 </dd>
173 </dl>
174 <script>explorer.outline.decSymbolLevel();</script>
175
176
177 </dd>
178
179 <script>explorer.outline.writeEnabled = true;</script>
180 <dt><span class="decl">template
181 <span class="currsymbol">wrapped_get</span>
182 <script>explorer.outline.addDecl('wrapped_get');</script>
183
184 (T,alias Fn)</span></dt>
185 <script>explorer.outline.writeEnabled = false;</script>
186
187
188 <dd><br><br>
189
190 <script>explorer.outline.incSymbolLevel();</script>
191 <dl>
192 <script>explorer.outline.writeEnabled = true;</script>
193 <dt><span class="decl">PyObject*
194 <span class="currsymbol">func</span>
195 <script>explorer.outline.addDecl('func');</script>
196
197 (PyObject* <span class="funcparam">self</span>, void* <span class="funcparam">closure</span>);
198 </span></dt>
199 <script>explorer.outline.writeEnabled = false;</script>
200
201
202 <dd>A generic wrapper around a "getter" property.
203 <br><br>
204
205 </dd>
206 </dl>
207 <script>explorer.outline.decSymbolLevel();</script>
208
209
210 </dd>
211
212 <script>explorer.outline.writeEnabled = true;</script>
213 <dt><span class="decl">template
214 <span class="currsymbol">wrapped_set</span>
215 <script>explorer.outline.addDecl('wrapped_set');</script>
216
217 (T,alias Fn)</span></dt>
218 <script>explorer.outline.writeEnabled = false;</script>
219
220
221 <dd><br><br>
222
223 <script>explorer.outline.incSymbolLevel();</script>
224 <dl>
225 <script>explorer.outline.writeEnabled = true;</script>
226 <dt><span class="decl">int
227 <span class="currsymbol">func</span>
228 <script>explorer.outline.addDecl('func');</script>
229
230 (PyObject* <span class="funcparam">self</span>, PyObject* <span class="funcparam">value</span>, void* <span class="funcparam">closure</span>);
231 </span></dt>
232 <script>explorer.outline.writeEnabled = false;</script>
233
234
235 <dd>A generic wrapper around a "setter" property.
236 <br><br>
237
238 </dd>
239 </dl>
240 <script>explorer.outline.decSymbolLevel();</script>
241
242
243 </dd>
244
245 <script>explorer.outline.writeEnabled = true;</script>
246 <dt><span class="decl">template
247 <span class="currsymbol">is_wrapped</span>
248 <script>explorer.outline.addDecl('is_wrapped');</script>
249
250 (T)</span></dt>
251 <script>explorer.outline.writeEnabled = false;</script>
252
253
254 <dd>A useful check for whether a given class has been wrapped. Mainly used by
255  the conversion functions (see make_object.d), but possibly useful elsewhere.
256  
257 <br><br>
258
259
260 <script>explorer.outline.incSymbolLevel();</script>
261 <dl></dl>
262 <script>explorer.outline.decSymbolLevel();</script>
263
264
265 </dd>
266
267 <script>explorer.outline.writeEnabled = true;</script>
268 <dt><span class="decl">struct
269 <span class="currsymbol">
270 <span class="currsymbol">wrapped_class</span>
271 <script>explorer.outline.addDecl('wrapped_class');</script>
272
273 </span>
274 <script>explorer.outline.addDecl('
275 <span class="currsymbol">wrapped_class</span>
276 <script>explorer.outline.addDecl('wrapped_class');</script>
277
278 ');</script>
279
280 ;
281 </span></dt>
282 <script>explorer.outline.writeEnabled = false;</script>
283
284
285 <dd>This struct wraps a D class. Its member functions are the primary way of
286  wrapping the specific parts of the class.
287  
288 <br><br>
289
290
291 <script>explorer.outline.incSymbolLevel();</script>
292 <dl>
293 <script>explorer.outline.writeEnabled = true;</script>
294 <dt><span class="decl">template
295 <span class="currsymbol">def</span>
296 <script>explorer.outline.addDecl('def');</script>
297
298 (char[] name,alias fn,uint MIN_ARGS = NumberOfArgs!(typeof(&amp;fn)),fn_t = typeof(&amp;fn))</span></dt>
299 <script>explorer.outline.writeEnabled = false;</script>
300
301
302 <dd>Wraps a member function of the class.
303 <br><br>
304 <b>Params:</b><br>
305 <table><tr>
306 <td nowrap valign="top" style="padding-right: 8px">name</td>
307
308                
309 <td>The name of the function as it will appear in Python.</td></tr>
310 <tr>
311 <td nowrap valign="top" style="padding-right: 8px">fn</td>
312
313                
314 <td>The member function to wrap.</td></tr>
315 <tr>
316 <td nowrap valign="top" style="padding-right: 8px">MIN_ARGS</td>
317
318                
319 <td>The minimum number of arguments this function can accept.</td></tr>
320 <tr>
321 <td nowrap valign="top" style="padding-right: 8px">fn_t</td>
322
323                
324 <td>The type of the function. It is only useful to specify this
325         if more than one function has the same name as this one.</td></tr>
326 </table><br>
327
328
329 <script>explorer.outline.incSymbolLevel();</script>
330 <dl></dl>
331 <script>explorer.outline.decSymbolLevel();</script>
332
333
334 </dd>
335
336 <script>explorer.outline.writeEnabled = true;</script>
337 <dt><span class="decl">template
338 <span class="currsymbol">prop</span>
339 <script>explorer.outline.addDecl('prop');</script>
340
341 (char[] name,alias fn,bool RO = false)</span></dt>
342 <script>explorer.outline.writeEnabled = false;</script>
343
344
345 <dd>Wraps a property of the class.
346 <br><br>
347 <b>Params:</b><br>
348 <table><tr>
349 <td nowrap valign="top" style="padding-right: 8px">name</td>
350
351                
352 <td>The name of the property as it will appear in Python.</td></tr>
353 <tr>
354 <td nowrap valign="top" style="padding-right: 8px">fn</td>
355
356                
357 <td>The property to wrap.</td></tr>
358 <tr>
359 <td nowrap valign="top" style="padding-right: 8px">RO</td>
360
361                
362 <td>Whether this is a read-only property.</td></tr>
363 </table><br>
364
365
366 <script>explorer.outline.incSymbolLevel();</script>
367 <dl></dl>
368 <script>explorer.outline.decSymbolLevel();</script>
369
370
371 </dd>
372
373 <script>explorer.outline.writeEnabled = true;</script>
374 <dt><span class="decl">template
375 <span class="currsymbol">init</span>
376 <script>explorer.outline.addDecl('init');</script>
377
378 (alias C1 = undefined,alias C2 = undefined,alias C3 = undefined,alias C4 = undefined,alias C5 = undefined,alias C6 = undefined,alias C7 = undefined,alias C8 = undefined,alias C9 = undefined,alias C10 = undefined)</span></dt>
379 <script>explorer.outline.writeEnabled = false;</script>
380
381
382 <dd>Wraps the constructors of the class.
383 <br><br>
384 This template takes a series of specializations of the ctor template
385  (see ctor_wrap.d), each of which describes a different constructor
386  that the class supports. The default constructor need not be
387  specified, and will always be available if the class supports it.
388
389 <br><br>
390 <font color=red>BUGS:</font><br>
391 This currently does not support having multiple constructors with
392  the same number of arguments.
393          
394 <br><br>
395
396
397 <script>explorer.outline.incSymbolLevel();</script>
398 <dl></dl>
399 <script>explorer.outline.decSymbolLevel();</script>
400
401
402 </dd>
403 </dl>
404 <script>explorer.outline.decSymbolLevel();</script>
405
406
407 </dd>
408 </dl>
409 <script>explorer.outline.decSymbolLevel();</script>
410
411
412 </td></tr>
413         <tr><td id="docfooter">
414             Page was generated with
415             <img src="candydoc/img/candydoc.gif" style="vertical-align:middle; position:relative; top:-1px">
416             on Sat Jul  1 22:14:02 2006
417
418         </td></tr>
419     </table>
420 </div>
421 <script>
422     explorer.packageExplorer.addModule("pyd.class_wrap");
423     explorer.packageExplorer.addModule("pyd.ctor_wrap");
424     explorer.packageExplorer.addModule("pyd.def");
425     explorer.packageExplorer.addModule("pyd.dg_convert");
426     explorer.packageExplorer.addModule("pyd.exception");
427     explorer.packageExplorer.addModule("pyd.ftype");
428     explorer.packageExplorer.addModule("pyd.make_object");
429     explorer.packageExplorer.addModule("pyd.object");
430     explorer.packageExplorer.addModule("pyd.pyd");</script>
431 </body></html>
Note: See TracBrowser for help on using the browser.