Imported Upstream version 2.3.5
[platform/upstream/python-lxml.git] / doc / html / api / lxml.html._MethodFunc-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.html._MethodFunc</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.html-module.html">Package&nbsp;html</a> ::
47         Class&nbsp;_MethodFunc
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.html._MethodFunc-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 _MethodFunc</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.html-pysrc.html#_MethodFunc">source&nbsp;code</a></span></p>
65 <pre class="base-tree">
66 object --+
67          |
68         <strong class="uidshort">_MethodFunc</strong>
69 </pre>
70
71 <hr />
72 An object that represents a method on an element as a function;
73 the function takes either an element or an HTML string.  It
74 returns whatever the function normally returns, or if the function
75 works in-place (and so returns None) it returns a serialized form
76 of the resulting document.
77
78 <!-- ==================== INSTANCE METHODS ==================== -->
79 <a name="section-InstanceMethods"></a>
80 <table class="summary" border="1" cellpadding="3"
81        cellspacing="0" width="100%" bgcolor="white">
82 <tr bgcolor="#70b0f0" class="table-header">
83   <td colspan="2" class="table-header">
84     <table border="0" cellpadding="0" cellspacing="0" width="100%">
85       <tr valign="top">
86         <td align="left"><span class="table-header">Instance Methods</span></td>
87         <td align="right" valign="top"
88          ><span class="options">[<a href="#section-InstanceMethods"
89          class="privatelink" onclick="toggle_private();"
90          >hide private</a>]</span></td>
91       </tr>
92     </table>
93   </td>
94 </tr>
95 <tr>
96     <td width="15%" align="right" valign="top" class="summary">
97       <span class="summary-type">&nbsp;</span>
98     </td><td class="summary">
99       <table width="100%" cellpadding="0" cellspacing="0" border="0">
100         <tr>
101           <td><span class="summary-sig"><a href="lxml.html._MethodFunc-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
102         <span class="summary-sig-arg">name</span>,
103         <span class="summary-sig-arg">copy</span>=<span class="summary-sig-default">False</span>,
104         <span class="summary-sig-arg">source_class</span>=<span class="summary-sig-default">&lt;class 'lxml.html.HtmlMixin'&gt;</span>)</span><br />
105       x.__init__(...) initializes x; see help(type(x)) for signature</td>
106           <td align="right" valign="top">
107             <span class="codelink"><a href="lxml.html-pysrc.html#_MethodFunc.__init__">source&nbsp;code</a></span>
108             
109           </td>
110         </tr>
111       </table>
112       
113     </td>
114   </tr>
115 <tr>
116     <td width="15%" align="right" valign="top" class="summary">
117       <span class="summary-type">&nbsp;</span>
118     </td><td class="summary">
119       <table width="100%" cellpadding="0" cellspacing="0" border="0">
120         <tr>
121           <td><span class="summary-sig"><a name="__call__"></a><span class="summary-sig-name">__call__</span>(<span class="summary-sig-arg">self</span>,
122         <span class="summary-sig-arg">doc</span>,
123         <span class="summary-sig-arg">*args</span>,
124         <span class="summary-sig-arg">**kw</span>)</span></td>
125           <td align="right" valign="top">
126             <span class="codelink"><a href="lxml.html-pysrc.html#_MethodFunc.__call__">source&nbsp;code</a></span>
127             
128           </td>
129         </tr>
130       </table>
131       
132     </td>
133   </tr>
134   <tr>
135     <td colspan="2" class="summary">
136     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
137       <code>__delattr__</code>,
138       <code>__format__</code>,
139       <code>__getattribute__</code>,
140       <code>__hash__</code>,
141       <code>__new__</code>,
142       <code>__reduce__</code>,
143       <code>__reduce_ex__</code>,
144       <code>__repr__</code>,
145       <code>__setattr__</code>,
146       <code>__sizeof__</code>,
147       <code>__str__</code>,
148       <code>__subclasshook__</code>
149       </p>
150     </td>
151   </tr>
152 </table>
153 <!-- ==================== PROPERTIES ==================== -->
154 <a name="section-Properties"></a>
155 <table class="summary" border="1" cellpadding="3"
156        cellspacing="0" width="100%" bgcolor="white">
157 <tr bgcolor="#70b0f0" class="table-header">
158   <td colspan="2" class="table-header">
159     <table border="0" cellpadding="0" cellspacing="0" width="100%">
160       <tr valign="top">
161         <td align="left"><span class="table-header">Properties</span></td>
162         <td align="right" valign="top"
163          ><span class="options">[<a href="#section-Properties"
164          class="privatelink" onclick="toggle_private();"
165          >hide private</a>]</span></td>
166       </tr>
167     </table>
168   </td>
169 </tr>
170   <tr>
171     <td colspan="2" class="summary">
172     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
173       <code>__class__</code>
174       </p>
175     </td>
176   </tr>
177 </table>
178 <!-- ==================== METHOD DETAILS ==================== -->
179 <a name="section-MethodDetails"></a>
180 <table class="details" border="1" cellpadding="3"
181        cellspacing="0" width="100%" bgcolor="white">
182 <tr bgcolor="#70b0f0" class="table-header">
183   <td colspan="2" class="table-header">
184     <table border="0" cellpadding="0" cellspacing="0" width="100%">
185       <tr valign="top">
186         <td align="left"><span class="table-header">Method Details</span></td>
187         <td align="right" valign="top"
188          ><span class="options">[<a href="#section-MethodDetails"
189          class="privatelink" onclick="toggle_private();"
190          >hide private</a>]</span></td>
191       </tr>
192     </table>
193   </td>
194 </tr>
195 </table>
196 <a name="__init__"></a>
197 <div>
198 <table class="details" border="1" cellpadding="3"
199        cellspacing="0" width="100%" bgcolor="white">
200 <tr><td>
201   <table width="100%" cellpadding="0" cellspacing="0" border="0">
202   <tr valign="top"><td>
203   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
204         <span class="sig-arg">name</span>,
205         <span class="sig-arg">copy</span>=<span class="sig-default">False</span>,
206         <span class="sig-arg">source_class</span>=<span class="sig-default">&lt;class 'lxml.html.HtmlMixin'&gt;</span>)</span>
207     <br /><em class="fname">(Constructor)</em>
208   </h3>
209   </td><td align="right" valign="top"
210     ><span class="codelink"><a href="lxml.html-pysrc.html#_MethodFunc.__init__">source&nbsp;code</a></span>&nbsp;
211     </td>
212   </tr></table>
213   
214   x.__init__(...) initializes x; see help(type(x)) for signature
215   <dl class="fields">
216     <dt>Overrides:
217         object.__init__
218         <dd><em class="note">(inherited documentation)</em></dd>
219     </dt>
220   </dl>
221 </td></tr></table>
222 </div>
223 <br />
224 <!-- ==================== NAVIGATION BAR ==================== -->
225 <table class="navbar" border="0" width="100%" cellpadding="0"
226        bgcolor="#a0c0ff" cellspacing="0">
227   <tr valign="middle">
228   <!-- Home link -->
229       <th>&nbsp;&nbsp;&nbsp;<a
230         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
231
232   <!-- Tree link -->
233       <th>&nbsp;&nbsp;&nbsp;<a
234         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
235
236   <!-- Index link -->
237       <th>&nbsp;&nbsp;&nbsp;<a
238         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
239
240   <!-- Help link -->
241       <th>&nbsp;&nbsp;&nbsp;<a
242         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
243
244   <!-- Project homepage -->
245       <th class="navbar" align="right" width="100%">
246         <table border="0" cellpadding="0" cellspacing="0">
247           <tr><th class="navbar" align="center"
248             ><a class="navbar" target="_top" href="/">lxml API</a></th>
249           </tr></table></th>
250   </tr>
251 </table>
252 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
253   <tr>
254     <td align="left" class="footer">
255     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:19 2012
256     </td>
257     <td align="right" class="footer">
258       <a target="mainFrame" href="http://epydoc.sourceforge.net"
259         >http://epydoc.sourceforge.net</a>
260     </td>
261   </tr>
262 </table>
263
264 <script type="text/javascript">
265   <!--
266   // Private objects are initially displayed (because if
267   // javascript is turned off then we want them to be
268   // visible); but by default, we want to hide them.  So hide
269   // them unless we have a cookie that says to show them.
270   checkCookie();
271   // -->
272 </script>
273 </body>
274 </html>