Imported Upstream version 2.3.5
[platform/upstream/python-lxml.git] / doc / html / api / lxml.cssselect.Function-class.html
1 <?xml version="1.0" encoding="ascii"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3           "DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6   <title>lxml.cssselect.Function</title>
7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
8   <script type="text/javascript" src="epydoc.js"></script>
9 </head>
10
11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
12       alink="#204080">
13 <!-- ==================== NAVIGATION BAR ==================== -->
14 <table class="navbar" border="0" width="100%" cellpadding="0"
15        bgcolor="#a0c0ff" cellspacing="0">
16   <tr valign="middle">
17   <!-- Home link -->
18       <th>&nbsp;&nbsp;&nbsp;<a
19         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21   <!-- Tree link -->
22       <th>&nbsp;&nbsp;&nbsp;<a
23         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25   <!-- Index link -->
26       <th>&nbsp;&nbsp;&nbsp;<a
27         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29   <!-- Help link -->
30       <th>&nbsp;&nbsp;&nbsp;<a
31         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33   <!-- Project homepage -->
34       <th class="navbar" align="right" width="100%">
35         <table border="0" cellpadding="0" cellspacing="0">
36           <tr><th class="navbar" align="center"
37             ><a class="navbar" target="_top" href="/">lxml API</a></th>
38           </tr></table></th>
39   </tr>
40 </table>
41 <table width="100%" cellpadding="0" cellspacing="0">
42   <tr valign="top">
43     <td width="100%">
44       <span class="breadcrumbs">
45         <a href="lxml-module.html">Package&nbsp;lxml</a> ::
46         <a href="lxml.cssselect-module.html">Module&nbsp;cssselect</a> ::
47         Class&nbsp;Function
48       </span>
49     </td>
50     <td>
51       <table cellpadding="0" cellspacing="0">
52         <!-- hide/show private -->
53         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
54     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
55         <tr><td align="right"><span class="options"
56             >[<a href="frames.html" target="_top">frames</a
57             >]&nbsp;|&nbsp;<a href="lxml.cssselect.Function-class.html"
58             target="_top">no&nbsp;frames</a>]</span></td></tr>
59       </table>
60     </td>
61   </tr>
62 </table>
63 <!-- ==================== CLASS DESCRIPTION ==================== -->
64 <h1 class="epydoc">Class Function</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.cssselect-pysrc.html#Function">source&nbsp;code</a></span></p>
65 <pre class="base-tree">
66 object --+
67          |
68         <strong class="uidshort">Function</strong>
69 </pre>
70
71 <hr />
72 Represents selector:name(expr)
73
74 <!-- ==================== INSTANCE METHODS ==================== -->
75 <a name="section-InstanceMethods"></a>
76 <table class="summary" border="1" cellpadding="3"
77        cellspacing="0" width="100%" bgcolor="white">
78 <tr bgcolor="#70b0f0" class="table-header">
79   <td colspan="2" class="table-header">
80     <table border="0" cellpadding="0" cellspacing="0" width="100%">
81       <tr valign="top">
82         <td align="left"><span class="table-header">Instance Methods</span></td>
83         <td align="right" valign="top"
84          ><span class="options">[<a href="#section-InstanceMethods"
85          class="privatelink" onclick="toggle_private();"
86          >hide private</a>]</span></td>
87       </tr>
88     </table>
89   </td>
90 </tr>
91 <tr>
92     <td width="15%" align="right" valign="top" class="summary">
93       <span class="summary-type">&nbsp;</span>
94     </td><td class="summary">
95       <table width="100%" cellpadding="0" cellspacing="0" border="0">
96         <tr>
97           <td><span class="summary-sig"><a href="lxml.cssselect.Function-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
98         <span class="summary-sig-arg">selector</span>,
99         <span class="summary-sig-arg">type</span>,
100         <span class="summary-sig-arg">name</span>,
101         <span class="summary-sig-arg">expr</span>)</span><br />
102       x.__init__(...) initializes x; see help(type(x)) for signature</td>
103           <td align="right" valign="top">
104             <span class="codelink"><a href="lxml.cssselect-pysrc.html#Function.__init__">source&nbsp;code</a></span>
105             
106           </td>
107         </tr>
108       </table>
109       
110     </td>
111   </tr>
112 <tr>
113     <td width="15%" align="right" valign="top" class="summary">
114       <span class="summary-type">&nbsp;</span>
115     </td><td class="summary">
116       <table width="100%" cellpadding="0" cellspacing="0" border="0">
117         <tr>
118           <td><span class="summary-sig"><a href="lxml.cssselect.Function-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
119       repr(x)</td>
120           <td align="right" valign="top">
121             <span class="codelink"><a href="lxml.cssselect-pysrc.html#Function.__repr__">source&nbsp;code</a></span>
122             
123           </td>
124         </tr>
125       </table>
126       
127     </td>
128   </tr>
129 <tr>
130     <td width="15%" align="right" valign="top" class="summary">
131       <span class="summary-type">&nbsp;</span>
132     </td><td class="summary">
133       <table width="100%" cellpadding="0" cellspacing="0" border="0">
134         <tr>
135           <td><span class="summary-sig"><a name="xpath"></a><span class="summary-sig-name">xpath</span>(<span class="summary-sig-arg">self</span>)</span></td>
136           <td align="right" valign="top">
137             <span class="codelink"><a href="lxml.cssselect-pysrc.html#Function.xpath">source&nbsp;code</a></span>
138             
139           </td>
140         </tr>
141       </table>
142       
143     </td>
144   </tr>
145 <tr class="private">
146     <td width="15%" align="right" valign="top" class="summary">
147       <span class="summary-type">&nbsp;</span>
148     </td><td class="summary">
149       <table width="100%" cellpadding="0" cellspacing="0" border="0">
150         <tr>
151           <td><span class="summary-sig"><a name="_xpath_nth_child"></a><span class="summary-sig-name">_xpath_nth_child</span>(<span class="summary-sig-arg">self</span>,
152         <span class="summary-sig-arg">xpath</span>,
153         <span class="summary-sig-arg">expr</span>,
154         <span class="summary-sig-arg">last</span>=<span class="summary-sig-default">False</span>,
155         <span class="summary-sig-arg">add_name_test</span>=<span class="summary-sig-default">True</span>)</span></td>
156           <td align="right" valign="top">
157             <span class="codelink"><a href="lxml.cssselect-pysrc.html#Function._xpath_nth_child">source&nbsp;code</a></span>
158             
159           </td>
160         </tr>
161       </table>
162       
163     </td>
164   </tr>
165 <tr class="private">
166     <td width="15%" align="right" valign="top" class="summary">
167       <span class="summary-type">&nbsp;</span>
168     </td><td class="summary">
169       <table width="100%" cellpadding="0" cellspacing="0" border="0">
170         <tr>
171           <td><span class="summary-sig"><a name="_xpath_nth_last_child"></a><span class="summary-sig-name">_xpath_nth_last_child</span>(<span class="summary-sig-arg">self</span>,
172         <span class="summary-sig-arg">xpath</span>,
173         <span class="summary-sig-arg">expr</span>)</span></td>
174           <td align="right" valign="top">
175             <span class="codelink"><a href="lxml.cssselect-pysrc.html#Function._xpath_nth_last_child">source&nbsp;code</a></span>
176             
177           </td>
178         </tr>
179       </table>
180       
181     </td>
182   </tr>
183 <tr class="private">
184     <td width="15%" align="right" valign="top" class="summary">
185       <span class="summary-type">&nbsp;</span>
186     </td><td class="summary">
187       <table width="100%" cellpadding="0" cellspacing="0" border="0">
188         <tr>
189           <td><span class="summary-sig"><a name="_xpath_nth_of_type"></a><span class="summary-sig-name">_xpath_nth_of_type</span>(<span class="summary-sig-arg">self</span>,
190         <span class="summary-sig-arg">xpath</span>,
191         <span class="summary-sig-arg">expr</span>)</span></td>
192           <td align="right" valign="top">
193             <span class="codelink"><a href="lxml.cssselect-pysrc.html#Function._xpath_nth_of_type">source&nbsp;code</a></span>
194             
195           </td>
196         </tr>
197       </table>
198       
199     </td>
200   </tr>
201 <tr class="private">
202     <td width="15%" align="right" valign="top" class="summary">
203       <span class="summary-type">&nbsp;</span>
204     </td><td class="summary">
205       <table width="100%" cellpadding="0" cellspacing="0" border="0">
206         <tr>
207           <td><span class="summary-sig"><a name="_xpath_nth_last_of_type"></a><span class="summary-sig-name">_xpath_nth_last_of_type</span>(<span class="summary-sig-arg">self</span>,
208         <span class="summary-sig-arg">xpath</span>,
209         <span class="summary-sig-arg">expr</span>)</span></td>
210           <td align="right" valign="top">
211             <span class="codelink"><a href="lxml.cssselect-pysrc.html#Function._xpath_nth_last_of_type">source&nbsp;code</a></span>
212             
213           </td>
214         </tr>
215       </table>
216       
217     </td>
218   </tr>
219 <tr class="private">
220     <td width="15%" align="right" valign="top" class="summary">
221       <span class="summary-type">&nbsp;</span>
222     </td><td class="summary">
223       <table width="100%" cellpadding="0" cellspacing="0" border="0">
224         <tr>
225           <td><span class="summary-sig"><a name="_xpath_contains"></a><span class="summary-sig-name">_xpath_contains</span>(<span class="summary-sig-arg">self</span>,
226         <span class="summary-sig-arg">xpath</span>,
227         <span class="summary-sig-arg">expr</span>)</span></td>
228           <td align="right" valign="top">
229             <span class="codelink"><a href="lxml.cssselect-pysrc.html#Function._xpath_contains">source&nbsp;code</a></span>
230             
231           </td>
232         </tr>
233       </table>
234       
235     </td>
236   </tr>
237 <tr class="private">
238     <td width="15%" align="right" valign="top" class="summary">
239       <span class="summary-type">&nbsp;</span>
240     </td><td class="summary">
241       <table width="100%" cellpadding="0" cellspacing="0" border="0">
242         <tr>
243           <td><span class="summary-sig"><a name="_xpath_not"></a><span class="summary-sig-name">_xpath_not</span>(<span class="summary-sig-arg">self</span>,
244         <span class="summary-sig-arg">xpath</span>,
245         <span class="summary-sig-arg">expr</span>)</span></td>
246           <td align="right" valign="top">
247             <span class="codelink"><a href="lxml.cssselect-pysrc.html#Function._xpath_not">source&nbsp;code</a></span>
248             
249           </td>
250         </tr>
251       </table>
252       
253     </td>
254   </tr>
255   <tr>
256     <td colspan="2" class="summary">
257     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
258       <code>__delattr__</code>,
259       <code>__format__</code>,
260       <code>__getattribute__</code>,
261       <code>__hash__</code>,
262       <code>__new__</code>,
263       <code>__reduce__</code>,
264       <code>__reduce_ex__</code>,
265       <code>__setattr__</code>,
266       <code>__sizeof__</code>,
267       <code>__str__</code>,
268       <code>__subclasshook__</code>
269       </p>
270     </td>
271   </tr>
272 </table>
273 <!-- ==================== CLASS VARIABLES ==================== -->
274 <a name="section-ClassVariables"></a>
275 <table class="summary" border="1" cellpadding="3"
276        cellspacing="0" width="100%" bgcolor="white">
277 <tr bgcolor="#70b0f0" class="table-header">
278   <td colspan="2" class="table-header">
279     <table border="0" cellpadding="0" cellspacing="0" width="100%">
280       <tr valign="top">
281         <td align="left"><span class="table-header">Class Variables</span></td>
282         <td align="right" valign="top"
283          ><span class="options">[<a href="#section-ClassVariables"
284          class="privatelink" onclick="toggle_private();"
285          >hide private</a>]</span></td>
286       </tr>
287     </table>
288   </td>
289 </tr>
290 <tr>
291     <td width="15%" align="right" valign="top" class="summary">
292       <span class="summary-type">&nbsp;</span>
293     </td><td class="summary">
294         <a name="unsupported"></a><span class="summary-name">unsupported</span> = <code title="['target', 'lang', 'enabled', 'disabled']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">target</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">lang</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">enabled</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">disabled</code><code class="variable-quote">'</code><code class="variable-group">]</code></code>
295     </td>
296   </tr>
297 </table>
298 <!-- ==================== PROPERTIES ==================== -->
299 <a name="section-Properties"></a>
300 <table class="summary" border="1" cellpadding="3"
301        cellspacing="0" width="100%" bgcolor="white">
302 <tr bgcolor="#70b0f0" class="table-header">
303   <td colspan="2" class="table-header">
304     <table border="0" cellpadding="0" cellspacing="0" width="100%">
305       <tr valign="top">
306         <td align="left"><span class="table-header">Properties</span></td>
307         <td align="right" valign="top"
308          ><span class="options">[<a href="#section-Properties"
309          class="privatelink" onclick="toggle_private();"
310          >hide private</a>]</span></td>
311       </tr>
312     </table>
313   </td>
314 </tr>
315   <tr>
316     <td colspan="2" class="summary">
317     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
318       <code>__class__</code>
319       </p>
320     </td>
321   </tr>
322 </table>
323 <!-- ==================== METHOD DETAILS ==================== -->
324 <a name="section-MethodDetails"></a>
325 <table class="details" border="1" cellpadding="3"
326        cellspacing="0" width="100%" bgcolor="white">
327 <tr bgcolor="#70b0f0" class="table-header">
328   <td colspan="2" class="table-header">
329     <table border="0" cellpadding="0" cellspacing="0" width="100%">
330       <tr valign="top">
331         <td align="left"><span class="table-header">Method Details</span></td>
332         <td align="right" valign="top"
333          ><span class="options">[<a href="#section-MethodDetails"
334          class="privatelink" onclick="toggle_private();"
335          >hide private</a>]</span></td>
336       </tr>
337     </table>
338   </td>
339 </tr>
340 </table>
341 <a name="__init__"></a>
342 <div>
343 <table class="details" border="1" cellpadding="3"
344        cellspacing="0" width="100%" bgcolor="white">
345 <tr><td>
346   <table width="100%" cellpadding="0" cellspacing="0" border="0">
347   <tr valign="top"><td>
348   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
349         <span class="sig-arg">selector</span>,
350         <span class="sig-arg">type</span>,
351         <span class="sig-arg">name</span>,
352         <span class="sig-arg">expr</span>)</span>
353     <br /><em class="fname">(Constructor)</em>
354   </h3>
355   </td><td align="right" valign="top"
356     ><span class="codelink"><a href="lxml.cssselect-pysrc.html#Function.__init__">source&nbsp;code</a></span>&nbsp;
357     </td>
358   </tr></table>
359   
360   x.__init__(...) initializes x; see help(type(x)) for signature
361   <dl class="fields">
362     <dt>Overrides:
363         object.__init__
364         <dd><em class="note">(inherited documentation)</em></dd>
365     </dt>
366   </dl>
367 </td></tr></table>
368 </div>
369 <a name="__repr__"></a>
370 <div>
371 <table class="details" border="1" cellpadding="3"
372        cellspacing="0" width="100%" bgcolor="white">
373 <tr><td>
374   <table width="100%" cellpadding="0" cellspacing="0" border="0">
375   <tr valign="top"><td>
376   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
377     <br /><em class="fname">(Representation operator)</em>
378   </h3>
379   </td><td align="right" valign="top"
380     ><span class="codelink"><a href="lxml.cssselect-pysrc.html#Function.__repr__">source&nbsp;code</a></span>&nbsp;
381     </td>
382   </tr></table>
383   
384   repr(x)
385   <dl class="fields">
386     <dt>Overrides:
387         object.__repr__
388         <dd><em class="note">(inherited documentation)</em></dd>
389     </dt>
390   </dl>
391 </td></tr></table>
392 </div>
393 <br />
394 <!-- ==================== NAVIGATION BAR ==================== -->
395 <table class="navbar" border="0" width="100%" cellpadding="0"
396        bgcolor="#a0c0ff" cellspacing="0">
397   <tr valign="middle">
398   <!-- Home link -->
399       <th>&nbsp;&nbsp;&nbsp;<a
400         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
401
402   <!-- Tree link -->
403       <th>&nbsp;&nbsp;&nbsp;<a
404         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
405
406   <!-- Index link -->
407       <th>&nbsp;&nbsp;&nbsp;<a
408         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
409
410   <!-- Help link -->
411       <th>&nbsp;&nbsp;&nbsp;<a
412         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
413
414   <!-- Project homepage -->
415       <th class="navbar" align="right" width="100%">
416         <table border="0" cellpadding="0" cellspacing="0">
417           <tr><th class="navbar" align="center"
418             ><a class="navbar" target="_top" href="/">lxml API</a></th>
419           </tr></table></th>
420   </tr>
421 </table>
422 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
423   <tr>
424     <td align="left" class="footer">
425     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
426     </td>
427     <td align="right" class="footer">
428       <a target="mainFrame" href="http://epydoc.sourceforge.net"
429         >http://epydoc.sourceforge.net</a>
430     </td>
431   </tr>
432 </table>
433
434 <script type="text/javascript">
435   <!--
436   // Private objects are initially displayed (because if
437   // javascript is turned off then we want them to be
438   // visible); but by default, we want to hide them.  So hide
439   // them unless we have a cookie that says to show them.
440   checkCookie();
441   // -->
442 </script>
443 </body>
444 </html>