doc/html/api/lxml.etree.XSLTExtension-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.XSLTExtension</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;XSLTExtension
  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.XSLTExtension-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 XSLTExtension</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">XSLTExtension</strong>
  69 </pre>
  70
  71 <hr />
  72 Base class of an XSLT extension element.
  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">a new object with type S, a subtype of T</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.etree.XSLTExtension-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
  98         <span class="summary-sig-arg">S</span>,
  99         <span class="summary-sig-arg">...</span>)</span></td>
 100           <td align="right" valign="top">
 101
 102
 103           </td>
 104         </tr>
 105       </table>
 106
 107     </td>
 108   </tr>
 109 <tr>
 110     <td width="15%" align="right" valign="top" class="summary">
 111       <span class="summary-type">&nbsp;</span>
 112     </td><td class="summary">
 113       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 114         <tr>
 115           <td><span class="summary-sig"><a href="lxml.etree.XSLTExtension-class.html#apply_templates" class="summary-sig-name">apply_templates</a>(<span class="summary-sig-arg">self</span>,
 116         <span class="summary-sig-arg">context</span>,
 117         <span class="summary-sig-arg">node</span>,
 118         <span class="summary-sig-arg">output_parent</span>=<span class="summary-sig-default">None</span>)</span><br />
 119       Call this method to retrieve the result of applying templates
 120 to an element.</td>
 121           <td align="right" valign="top">
 122
 123
 124           </td>
 125         </tr>
 126       </table>
 127
 128     </td>
 129   </tr>
 130 <tr>
 131     <td width="15%" align="right" valign="top" class="summary">
 132       <span class="summary-type">&nbsp;</span>
 133     </td><td class="summary">
 134       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 135         <tr>
 136           <td><span class="summary-sig"><a href="lxml.etree.XSLTExtension-class.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-arg">self</span>,
 137         <span class="summary-sig-arg">context</span>,
 138         <span class="summary-sig-arg">self_node</span>,
 139         <span class="summary-sig-arg">input_node</span>,
 140         <span class="summary-sig-arg">output_parent</span>)</span><br />
 141       Execute this extension element.</td>
 142           <td align="right" valign="top">
 143
 144
 145           </td>
 146         </tr>
 147       </table>
 148
 149     </td>
 150   </tr>
 151 <tr>
 152     <td width="15%" align="right" valign="top" class="summary">
 153       <span class="summary-type">&nbsp;</span>
 154     </td><td class="summary">
 155       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 156         <tr>
 157           <td><span class="summary-sig"><a href="lxml.etree.XSLTExtension-class.html#process_children" class="summary-sig-name">process_children</a>(<span class="summary-sig-arg">self</span>,
 158         <span class="summary-sig-arg">context</span>,
 159         <span class="summary-sig-arg">output_parent</span>=<span class="summary-sig-default">None</span>)</span><br />
 160       Call this method to process the XSLT content of the extension
 161 element itself.</td>
 162           <td align="right" valign="top">
 163
 164
 165           </td>
 166         </tr>
 167       </table>
 168
 169     </td>
 170   </tr>
 171   <tr>
 172     <td colspan="2" class="summary">
 173     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 174       <code>__delattr__</code>,
 175       <code>__format__</code>,
 176       <code>__getattribute__</code>,
 177       <code>__hash__</code>,
 178       <code>__init__</code>,
 179       <code>__reduce__</code>,
 180       <code>__reduce_ex__</code>,
 181       <code>__repr__</code>,
 182       <code>__setattr__</code>,
 183       <code>__sizeof__</code>,
 184       <code>__str__</code>,
 185       <code>__subclasshook__</code>
 186       </p>
 187     </td>
 188   </tr>
 189 </table>
 190 <!-- ==================== PROPERTIES ==================== -->
 191 <a name="section-Properties"></a>
 192 <table class="summary" border="1" cellpadding="3"
 193        cellspacing="0" width="100%" bgcolor="white">
 194 <tr bgcolor="#70b0f0" class="table-header">
 195   <td colspan="2" class="table-header">
 196     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 197       <tr valign="top">
 198         <td align="left"><span class="table-header">Properties</span></td>
 199         <td align="right" valign="top"
 200          ><span class="options">[<a href="#section-Properties"
 201          class="privatelink" onclick="toggle_private();"
 202          >hide private</a>]</span></td>
 203       </tr>
 204     </table>
 205   </td>
 206 </tr>
 207   <tr>
 208     <td colspan="2" class="summary">
 209     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 210       <code>__class__</code>
 211       </p>
 212     </td>
 213   </tr>
 214 </table>
 215 <!-- ==================== METHOD DETAILS ==================== -->
 216 <a name="section-MethodDetails"></a>
 217 <table class="details" border="1" cellpadding="3"
 218        cellspacing="0" width="100%" bgcolor="white">
 219 <tr bgcolor="#70b0f0" class="table-header">
 220   <td colspan="2" class="table-header">
 221     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 222       <tr valign="top">
 223         <td align="left"><span class="table-header">Method Details</span></td>
 224         <td align="right" valign="top"
 225          ><span class="options">[<a href="#section-MethodDetails"
 226          class="privatelink" onclick="toggle_private();"
 227          >hide private</a>]</span></td>
 228       </tr>
 229     </table>
 230   </td>
 231 </tr>
 232 </table>
 233 <a name="__new__"></a>
 234 <div>
 235 <table class="details" border="1" cellpadding="3"
 236        cellspacing="0" width="100%" bgcolor="white">
 237 <tr><td>
 238   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 239   <tr valign="top"><td>
 240   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 241         <span class="sig-arg">S</span>,
 242         <span class="sig-arg">...</span>)</span>
 243   </h3>
 244   </td><td align="right" valign="top"
 245     >&nbsp;
 246     </td>
 247   </tr></table>
 248
 249
 250   <dl class="fields">
 251     <dt>Returns: a new object with type S, a subtype of T</dt>
 252     <dt>Overrides:
 253         object.__new__
 254     </dt>
 255   </dl>
 256 </td></tr></table>
 257 </div>
 258 <a name="apply_templates"></a>
 259 <div>
 260 <table class="details" border="1" cellpadding="3"
 261        cellspacing="0" width="100%" bgcolor="white">
 262 <tr><td>
 263   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 264   <tr valign="top"><td>
 265   <h3 class="epydoc"><span class="sig"><span class="sig-name">apply_templates</span>(<span class="sig-arg">self</span>,
 266         <span class="sig-arg">context</span>,
 267         <span class="sig-arg">node</span>,
 268         <span class="sig-arg">output_parent</span>=<span class="sig-default">None</span>)</span>
 269   </h3>
 270   </td><td align="right" valign="top"
 271     >&nbsp;
 272     </td>
 273   </tr></table>
 274
 275   <p>Call this method to retrieve the result of applying templates
 276 to an element.</p>
 277 <p>The return value is a list of elements or text strings that
 278 were generated by the XSLT processor.</p>
 279 <p>If you pass an Element as <code class="link">output_parent</code> parameter, the result
 280 will instead be appended to the element (including attributes
 281 etc.) and the return value will be <code class="link">None</code>.  This is a safe way
 282 to generate content into the output document directly, without
 283 having to take care of special values like text or attributes.</p>
 284   <dl class="fields">
 285   </dl>
 286 </td></tr></table>
 287 </div>
 288 <a name="execute"></a>
 289 <div>
 290 <table class="details" border="1" cellpadding="3"
 291        cellspacing="0" width="100%" bgcolor="white">
 292 <tr><td>
 293   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 294   <tr valign="top"><td>
 295   <h3 class="epydoc"><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">self</span>,
 296         <span class="sig-arg">context</span>,
 297         <span class="sig-arg">self_node</span>,
 298         <span class="sig-arg">input_node</span>,
 299         <span class="sig-arg">output_parent</span>)</span>
 300   </h3>
 301   </td><td align="right" valign="top"
 302     >&nbsp;
 303     </td>
 304   </tr></table>
 305
 306   <p>Execute this extension element.</p>
 307 <p>Subclasses must override this method.  They may append
 308 elements to the <code class="link">output_parent</code> element here, or set its text
 309 content.  To this end, the <code class="link">input_node</code> provides read-only
 310 access to the current node in the input document, and the
 311 <code class="link">self_node</code> points to the extension element in the stylesheet.</p>
 312 <p>Note that the <code class="link">output_parent</code> parameter may be <code class="link">None</code> if there
 313 is no parent element in the current context (e.g. no content
 314 was added to the output tree yet).</p>
 315   <dl class="fields">
 316   </dl>
 317 </td></tr></table>
 318 </div>
 319 <a name="process_children"></a>
 320 <div>
 321 <table class="details" border="1" cellpadding="3"
 322        cellspacing="0" width="100%" bgcolor="white">
 323 <tr><td>
 324   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 325   <tr valign="top"><td>
 326   <h3 class="epydoc"><span class="sig"><span class="sig-name">process_children</span>(<span class="sig-arg">self</span>,
 327         <span class="sig-arg">context</span>,
 328         <span class="sig-arg">output_parent</span>=<span class="sig-default">None</span>)</span>
 329   </h3>
 330   </td><td align="right" valign="top"
 331     >&nbsp;
 332     </td>
 333   </tr></table>
 334
 335   <p>Call this method to process the XSLT content of the extension
 336 element itself.</p>
 337 <p>The return value is a list of elements or text strings that
 338 were generated by the XSLT processor.</p>
 339 <p>If you pass an Element as <code class="link">output_parent</code> parameter, the result
 340 will instead be appended to the element (including attributes
 341 etc.) and the return value will be <code class="link">None</code>.  This is a safe way
 342 to generate content into the output document directly, without
 343 having to take care of special values like text or attributes.</p>
 344   <dl class="fields">
 345   </dl>
 346 </td></tr></table>
 347 </div>
 348 <br />
 349 <!-- ==================== NAVIGATION BAR ==================== -->
 350 <table class="navbar" border="0" width="100%" cellpadding="0"
 351        bgcolor="#a0c0ff" cellspacing="0">
 352   <tr valign="middle">
 353   <!-- Home link -->
 354       <th>&nbsp;&nbsp;&nbsp;<a
 355         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 356
 357   <!-- Tree link -->
 358       <th>&nbsp;&nbsp;&nbsp;<a
 359         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 360
 361   <!-- Index link -->
 362       <th>&nbsp;&nbsp;&nbsp;<a
 363         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 364
 365   <!-- Help link -->
 366       <th>&nbsp;&nbsp;&nbsp;<a
 367         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 368
 369   <!-- Project homepage -->
 370       <th class="navbar" align="right" width="100%">
 371         <table border="0" cellpadding="0" cellspacing="0">
 372           <tr><th class="navbar" align="center"
 373             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 374           </tr></table></th>
 375   </tr>
 376 </table>
 377 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 378   <tr>
 379     <td align="left" class="footer">
 380     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 381     </td>
 382     <td align="right" class="footer">
 383       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 384         >http://epydoc.sourceforge.net</a>
 385     </td>
 386   </tr>
 387 </table>
 388
 389 <script type="text/javascript">
 390   <!--
 391   // Private objects are initially displayed (because if
 392   // javascript is turned off then we want them to be
 393   // visible); but by default, we want to hide them.  So hide
 394   // them unless we have a cookie that says to show them.
 395   checkCookie();
 396   // -->
 397 </script>
 398 </body>
 399 </html>