Imported Upstream version 2.3.6
[platform/upstream/python-lxml.git] / doc / html / api / lxml.etree._XSLTProcessingInstruction-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.etree._XSLTProcessingInstruction</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.etree-module.html">Module&nbsp;etree</a> ::
47         Class&nbsp;_XSLTProcessingInstruction
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.etree._XSLTProcessingInstruction-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 _XSLTProcessingInstruction</h1><p class="nomargin-top"></p>
65 <pre class="base-tree">
66       object --+                
67                |                
68         <a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a> --+            
69                    |            
70 <a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a> --+        
71                        |        
72   <a href="lxml.etree._ProcessingInstruction-class.html" onclick="show_private();">_ProcessingInstruction</a> --+    
73                            |    
74                       <a href="lxml.etree.PIBase-class.html">PIBase</a> --+
75                                |
76                               <strong class="uidshort">_XSLTProcessingInstruction</strong>
77 </pre>
78
79 <hr />
80 <!-- ==================== INSTANCE METHODS ==================== -->
81 <a name="section-InstanceMethods"></a>
82 <table class="summary" border="1" cellpadding="3"
83        cellspacing="0" width="100%" bgcolor="white">
84 <tr bgcolor="#70b0f0" class="table-header">
85   <td colspan="2" class="table-header">
86     <table border="0" cellpadding="0" cellspacing="0" width="100%">
87       <tr valign="top">
88         <td align="left"><span class="table-header">Instance Methods</span></td>
89         <td align="right" valign="top"
90          ><span class="options">[<a href="#section-InstanceMethods"
91          class="privatelink" onclick="toggle_private();"
92          >hide private</a>]</span></td>
93       </tr>
94     </table>
95   </td>
96 </tr>
97 <tr>
98     <td width="15%" align="right" valign="top" class="summary">
99       <span class="summary-type">a new object with type S, a subtype of T</span>
100     </td><td class="summary">
101       <table width="100%" cellpadding="0" cellspacing="0" border="0">
102         <tr>
103           <td><span class="summary-sig"><a href="lxml.etree._XSLTProcessingInstruction-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
104         <span class="summary-sig-arg">S</span>,
105         <span class="summary-sig-arg">...</span>)</span></td>
106           <td align="right" valign="top">
107             
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 href="lxml.etree._XSLTProcessingInstruction-class.html#parseXSL" class="summary-sig-name">parseXSL</a>(<span class="summary-sig-arg">self</span>,
122         <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>)</span><br />
123       Try to parse the stylesheet referenced by this PI and return
124 an ElementTree for it.  If the stylesheet is embedded in the
125 same document (referenced via xml:id), find and return an
126 ElementTree for the stylesheet Element.</td>
127           <td align="right" valign="top">
128             
129             
130           </td>
131         </tr>
132       </table>
133       
134     </td>
135   </tr>
136 <tr>
137     <td width="15%" align="right" valign="top" class="summary">
138       <span class="summary-type">&nbsp;</span>
139     </td><td class="summary">
140       <table width="100%" cellpadding="0" cellspacing="0" border="0">
141         <tr>
142           <td><span class="summary-sig"><a href="lxml.etree._XSLTProcessingInstruction-class.html#set" class="summary-sig-name">set</a>(<span class="summary-sig-arg">self</span>,
143         <span class="summary-sig-arg">key</span>,
144         <span class="summary-sig-arg">value</span>)</span><br />
145       Supports setting the 'href' pseudo-attribute in the text of
146 the processing instruction.</td>
147           <td align="right" valign="top">
148             
149             
150           </td>
151         </tr>
152       </table>
153       
154     </td>
155   </tr>
156   <tr>
157     <td colspan="2" class="summary">
158     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.PIBase-class.html">PIBase</a></code></b>:
159       <code><a href="lxml.etree.PIBase-class.html#__init__">__init__</a></code>
160       </p>
161     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._ProcessingInstruction-class.html" onclick="show_private();">_ProcessingInstruction</a></code></b>:
162       <code><a href="lxml.etree._ProcessingInstruction-class.html#__repr__">__repr__</a></code>,
163       <code><a href="lxml.etree._ProcessingInstruction-class.html#get">get</a></code>
164       </p>
165     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a></code></b>:
166       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__delitem__">__delitem__</a></code>,
167       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__getitem__">__getitem__</a></code>,
168       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__len__">__len__</a></code>,
169       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__setitem__">__setitem__</a></code>,
170       <code><a href="lxml.etree.__ContentOnlyElement-class.html#append">append</a></code>,
171       <code><a href="lxml.etree.__ContentOnlyElement-class.html#insert">insert</a></code>,
172       <code><a href="lxml.etree.__ContentOnlyElement-class.html#items">items</a></code>,
173       <code><a href="lxml.etree.__ContentOnlyElement-class.html#keys">keys</a></code>,
174       <code><a href="lxml.etree.__ContentOnlyElement-class.html#values">values</a></code>
175       </p>
176     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
177       <code><a href="lxml.etree._Element-class.html#__contains__">__contains__</a></code>,
178       <code><a href="lxml.etree._Element-class.html#__copy__">__copy__</a></code>,
179       <code><a href="lxml.etree._Element-class.html#__deepcopy__">__deepcopy__</a></code>,
180       <code><a href="lxml.etree._Element-class.html#__iter__">__iter__</a></code>,
181       <code><a href="lxml.etree._Element-class.html#__nonzero__">__nonzero__</a></code>,
182       <code><a href="lxml.etree._Element-class.html#__reversed__">__reversed__</a></code>,
183       <code><a href="lxml.etree._Element-class.html#addnext">addnext</a></code>,
184       <code><a href="lxml.etree._Element-class.html#addprevious">addprevious</a></code>,
185       <code><a href="lxml.etree._Element-class.html#clear">clear</a></code>,
186       <code><a href="lxml.etree._Element-class.html#extend">extend</a></code>,
187       <code><a href="lxml.etree._Element-class.html#find">find</a></code>,
188       <code><a href="lxml.etree._Element-class.html#findall">findall</a></code>,
189       <code><a href="lxml.etree._Element-class.html#findtext">findtext</a></code>,
190       <code><a href="lxml.etree._Element-class.html#getchildren">getchildren</a></code>,
191       <code><a href="lxml.etree._Element-class.html#getiterator">getiterator</a></code>,
192       <code><a href="lxml.etree._Element-class.html#getnext">getnext</a></code>,
193       <code><a href="lxml.etree._Element-class.html#getparent">getparent</a></code>,
194       <code><a href="lxml.etree._Element-class.html#getprevious">getprevious</a></code>,
195       <code><a href="lxml.etree._Element-class.html#getroottree">getroottree</a></code>,
196       <code><a href="lxml.etree._Element-class.html#index">index</a></code>,
197       <code><a href="lxml.etree._Element-class.html#iter">iter</a></code>,
198       <code><a href="lxml.etree._Element-class.html#iterancestors">iterancestors</a></code>,
199       <code><a href="lxml.etree._Element-class.html#iterchildren">iterchildren</a></code>,
200       <code><a href="lxml.etree._Element-class.html#iterdescendants">iterdescendants</a></code>,
201       <code><a href="lxml.etree._Element-class.html#iterfind">iterfind</a></code>,
202       <code><a href="lxml.etree._Element-class.html#itersiblings">itersiblings</a></code>,
203       <code><a href="lxml.etree._Element-class.html#itertext">itertext</a></code>,
204       <code><a href="lxml.etree._Element-class.html#makeelement">makeelement</a></code>,
205       <code><a href="lxml.etree._Element-class.html#remove">remove</a></code>,
206       <code><a href="lxml.etree._Element-class.html#replace">replace</a></code>,
207       <code><a href="lxml.etree._Element-class.html#xpath">xpath</a></code>
208       </p>
209     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b> (private):
210       <code><a href="lxml.etree._Element-class.html#_init" onclick="show_private();">_init</a></code>
211       </p></div>
212     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
213       <code>__delattr__</code>,
214       <code>__format__</code>,
215       <code>__getattribute__</code>,
216       <code>__hash__</code>,
217       <code>__reduce__</code>,
218       <code>__reduce_ex__</code>,
219       <code>__setattr__</code>,
220       <code>__sizeof__</code>,
221       <code>__str__</code>,
222       <code>__subclasshook__</code>
223       </p>
224     </td>
225   </tr>
226 </table>
227 <!-- ==================== PROPERTIES ==================== -->
228 <a name="section-Properties"></a>
229 <table class="summary" border="1" cellpadding="3"
230        cellspacing="0" width="100%" bgcolor="white">
231 <tr bgcolor="#70b0f0" class="table-header">
232   <td colspan="2" class="table-header">
233     <table border="0" cellpadding="0" cellspacing="0" width="100%">
234       <tr valign="top">
235         <td align="left"><span class="table-header">Properties</span></td>
236         <td align="right" valign="top"
237          ><span class="options">[<a href="#section-Properties"
238          class="privatelink" onclick="toggle_private();"
239          >hide private</a>]</span></td>
240       </tr>
241     </table>
242   </td>
243 </tr>
244   <tr>
245     <td colspan="2" class="summary">
246     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._ProcessingInstruction-class.html" onclick="show_private();">_ProcessingInstruction</a></code></b>:
247       <code><a href="lxml.etree._ProcessingInstruction-class.html#attrib">attrib</a></code>,
248       <code><a href="lxml.etree._ProcessingInstruction-class.html#tag">tag</a></code>,
249       <code><a href="lxml.etree._ProcessingInstruction-class.html#target">target</a></code>
250       </p>
251     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a></code></b>:
252       <code><a href="lxml.etree.__ContentOnlyElement-class.html#text">text</a></code>
253       </p>
254     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
255       <code><a href="lxml.etree._Element-class.html#base">base</a></code>,
256       <code><a href="lxml.etree._Element-class.html#nsmap">nsmap</a></code>,
257       <code><a href="lxml.etree._Element-class.html#prefix">prefix</a></code>,
258       <code><a href="lxml.etree._Element-class.html#sourceline">sourceline</a></code>,
259       <code><a href="lxml.etree._Element-class.html#tail">tail</a></code>
260       </p>
261     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
262       <code>__class__</code>
263       </p>
264     </td>
265   </tr>
266 </table>
267 <!-- ==================== METHOD DETAILS ==================== -->
268 <a name="section-MethodDetails"></a>
269 <table class="details" border="1" cellpadding="3"
270        cellspacing="0" width="100%" bgcolor="white">
271 <tr bgcolor="#70b0f0" class="table-header">
272   <td colspan="2" class="table-header">
273     <table border="0" cellpadding="0" cellspacing="0" width="100%">
274       <tr valign="top">
275         <td align="left"><span class="table-header">Method Details</span></td>
276         <td align="right" valign="top"
277          ><span class="options">[<a href="#section-MethodDetails"
278          class="privatelink" onclick="toggle_private();"
279          >hide private</a>]</span></td>
280       </tr>
281     </table>
282   </td>
283 </tr>
284 </table>
285 <a name="__new__"></a>
286 <div>
287 <table class="details" border="1" cellpadding="3"
288        cellspacing="0" width="100%" bgcolor="white">
289 <tr><td>
290   <table width="100%" cellpadding="0" cellspacing="0" border="0">
291   <tr valign="top"><td>
292   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
293         <span class="sig-arg">S</span>,
294         <span class="sig-arg">...</span>)</span>
295   </h3>
296   </td><td align="right" valign="top"
297     >&nbsp;
298     </td>
299   </tr></table>
300   
301   
302   <dl class="fields">
303     <dt>Returns: a new object with type S, a subtype of T</dt>
304     <dt>Overrides:
305         object.__new__
306     </dt>
307   </dl>
308 </td></tr></table>
309 </div>
310 <a name="parseXSL"></a>
311 <div>
312 <table class="details" border="1" cellpadding="3"
313        cellspacing="0" width="100%" bgcolor="white">
314 <tr><td>
315   <table width="100%" cellpadding="0" cellspacing="0" border="0">
316   <tr valign="top"><td>
317   <h3 class="epydoc"><span class="sig"><span class="sig-name">parseXSL</span>(<span class="sig-arg">self</span>,
318         <span class="sig-arg">parser</span>=<span class="sig-default">None</span>)</span>
319   </h3>
320   </td><td align="right" valign="top"
321     >&nbsp;
322     </td>
323   </tr></table>
324   
325   <p>Try to parse the stylesheet referenced by this PI and return
326 an ElementTree for it.  If the stylesheet is embedded in the
327 same document (referenced via xml:id), find and return an
328 ElementTree for the stylesheet Element.</p>
329 <p>The optional <tt class="rst-docutils literal">parser</tt> keyword argument can be passed to specify the
330 parser used to read from external stylesheet URLs.</p>
331   <dl class="fields">
332   </dl>
333 </td></tr></table>
334 </div>
335 <a name="set"></a>
336 <div>
337 <table class="details" border="1" cellpadding="3"
338        cellspacing="0" width="100%" bgcolor="white">
339 <tr><td>
340   <table width="100%" cellpadding="0" cellspacing="0" border="0">
341   <tr valign="top"><td>
342   <h3 class="epydoc"><span class="sig"><span class="sig-name">set</span>(<span class="sig-arg">self</span>,
343         <span class="sig-arg">key</span>,
344         <span class="sig-arg">value</span>)</span>
345   </h3>
346   </td><td align="right" valign="top"
347     >&nbsp;
348     </td>
349   </tr></table>
350   
351   Supports setting the 'href' pseudo-attribute in the text of
352 the processing instruction.
353   <dl class="fields">
354     <dt>Overrides:
355         <a href="lxml.etree._Element-class.html#set">_Element.set</a>
356     </dt>
357   </dl>
358 </td></tr></table>
359 </div>
360 <br />
361 <!-- ==================== NAVIGATION BAR ==================== -->
362 <table class="navbar" border="0" width="100%" cellpadding="0"
363        bgcolor="#a0c0ff" cellspacing="0">
364   <tr valign="middle">
365   <!-- Home link -->
366       <th>&nbsp;&nbsp;&nbsp;<a
367         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
368
369   <!-- Tree link -->
370       <th>&nbsp;&nbsp;&nbsp;<a
371         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
372
373   <!-- Index link -->
374       <th>&nbsp;&nbsp;&nbsp;<a
375         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
376
377   <!-- Help link -->
378       <th>&nbsp;&nbsp;&nbsp;<a
379         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
380
381   <!-- Project homepage -->
382       <th class="navbar" align="right" width="100%">
383         <table border="0" cellpadding="0" cellspacing="0">
384           <tr><th class="navbar" align="center"
385             ><a class="navbar" target="_top" href="/">lxml API</a></th>
386           </tr></table></th>
387   </tr>
388 </table>
389 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
390   <tr>
391     <td align="left" class="footer">
392     Generated by Epydoc 3.0.1 on Fri Sep 28 21:20:57 2012
393     </td>
394     <td align="right" class="footer">
395       <a target="mainFrame" href="http://epydoc.sourceforge.net"
396         >http://epydoc.sourceforge.net</a>
397     </td>
398   </tr>
399 </table>
400
401 <script type="text/javascript">
402   <!--
403   // Private objects are initially displayed (because if
404   // javascript is turned off then we want them to be
405   // visible); but by default, we want to hide them.  So hide
406   // them unless we have a cookie that says to show them.
407   checkCookie();
408   // -->
409 </script>
410 </body>
411 </html>