Imported Upstream version 2.3.5
[platform/upstream/python-lxml.git] / doc / html / api / lxml.html.HtmlComment-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.HtmlComment</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;HtmlComment
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.HtmlComment-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 HtmlComment</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.html-pysrc.html#HtmlComment">source&nbsp;code</a></span></p>
65 <pre class="base-tree">
66             object --+                
67                      |                
68         <a href="lxml.etree._Element-class.html" onclick="show_private();">etree._Element</a> --+            
69                          |            
70 <a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">etree.__ContentOnlyElement</a> --+        
71                              |        
72                 <a href="lxml.etree._Comment-class.html" onclick="show_private();">etree._Comment</a> --+    
73                                  |    
74                  <a href="lxml.etree.CommentBase-class.html">etree.CommentBase</a> --+
75                                      |
76                         object --+   |
77                                  |   |
78                          <a href="lxml.html.HtmlMixin-class.html" onclick="show_private();">HtmlMixin</a> --+
79                                      |
80                                     <strong class="uidshort">HtmlComment</strong>
81 </pre>
82
83 <hr />
84 <!-- ==================== INSTANCE METHODS ==================== -->
85 <a name="section-InstanceMethods"></a>
86 <table class="summary" border="1" cellpadding="3"
87        cellspacing="0" width="100%" bgcolor="white">
88 <tr bgcolor="#70b0f0" class="table-header">
89   <td colspan="2" class="table-header">
90     <table border="0" cellpadding="0" cellspacing="0" width="100%">
91       <tr valign="top">
92         <td align="left"><span class="table-header">Instance Methods</span></td>
93         <td align="right" valign="top"
94          ><span class="options">[<a href="#section-InstanceMethods"
95          class="privatelink" onclick="toggle_private();"
96          >hide private</a>]</span></td>
97       </tr>
98     </table>
99   </td>
100 </tr>
101   <tr>
102     <td colspan="2" class="summary">
103     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.CommentBase-class.html">etree.CommentBase</a></code></b>:
104       <code><a href="lxml.etree.CommentBase-class.html#__init__">__init__</a></code>,
105       <code><a href="lxml.etree.CommentBase-class.html#__new__">__new__</a></code>
106       </p>
107     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Comment-class.html" onclick="show_private();">etree._Comment</a></code></b>:
108       <code><a href="lxml.etree._Comment-class.html#__repr__">__repr__</a></code>
109       </p>
110     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">etree.__ContentOnlyElement</a></code></b>:
111       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__delitem__">__delitem__</a></code>,
112       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__getitem__">__getitem__</a></code>,
113       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__len__">__len__</a></code>,
114       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__setitem__">__setitem__</a></code>,
115       <code><a href="lxml.etree.__ContentOnlyElement-class.html#append">append</a></code>,
116       <code><a href="lxml.etree.__ContentOnlyElement-class.html#get">get</a></code>,
117       <code><a href="lxml.etree.__ContentOnlyElement-class.html#insert">insert</a></code>,
118       <code><a href="lxml.etree.__ContentOnlyElement-class.html#items">items</a></code>,
119       <code><a href="lxml.etree.__ContentOnlyElement-class.html#keys">keys</a></code>,
120       <code><a href="lxml.etree.__ContentOnlyElement-class.html#set">set</a></code>,
121       <code><a href="lxml.etree.__ContentOnlyElement-class.html#values">values</a></code>
122       </p>
123     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">etree._Element</a></code></b>:
124       <code><a href="lxml.etree._Element-class.html#__contains__">__contains__</a></code>,
125       <code><a href="lxml.etree._Element-class.html#__copy__">__copy__</a></code>,
126       <code><a href="lxml.etree._Element-class.html#__deepcopy__">__deepcopy__</a></code>,
127       <code><a href="lxml.etree._Element-class.html#__iter__">__iter__</a></code>,
128       <code><a href="lxml.etree._Element-class.html#__nonzero__">__nonzero__</a></code>,
129       <code><a href="lxml.etree._Element-class.html#__reversed__">__reversed__</a></code>,
130       <code><a href="lxml.etree._Element-class.html#addnext">addnext</a></code>,
131       <code><a href="lxml.etree._Element-class.html#addprevious">addprevious</a></code>,
132       <code><a href="lxml.etree._Element-class.html#clear">clear</a></code>,
133       <code><a href="lxml.etree._Element-class.html#extend">extend</a></code>,
134       <code><a href="lxml.etree._Element-class.html#find">find</a></code>,
135       <code><a href="lxml.etree._Element-class.html#findall">findall</a></code>,
136       <code><a href="lxml.etree._Element-class.html#findtext">findtext</a></code>,
137       <code><a href="lxml.etree._Element-class.html#getchildren">getchildren</a></code>,
138       <code><a href="lxml.etree._Element-class.html#getiterator">getiterator</a></code>,
139       <code><a href="lxml.etree._Element-class.html#getnext">getnext</a></code>,
140       <code><a href="lxml.etree._Element-class.html#getparent">getparent</a></code>,
141       <code><a href="lxml.etree._Element-class.html#getprevious">getprevious</a></code>,
142       <code><a href="lxml.etree._Element-class.html#getroottree">getroottree</a></code>,
143       <code><a href="lxml.etree._Element-class.html#index">index</a></code>,
144       <code><a href="lxml.etree._Element-class.html#iter">iter</a></code>,
145       <code><a href="lxml.etree._Element-class.html#iterancestors">iterancestors</a></code>,
146       <code><a href="lxml.etree._Element-class.html#iterchildren">iterchildren</a></code>,
147       <code><a href="lxml.etree._Element-class.html#iterdescendants">iterdescendants</a></code>,
148       <code><a href="lxml.etree._Element-class.html#iterfind">iterfind</a></code>,
149       <code><a href="lxml.etree._Element-class.html#itersiblings">itersiblings</a></code>,
150       <code><a href="lxml.etree._Element-class.html#itertext">itertext</a></code>,
151       <code><a href="lxml.etree._Element-class.html#makeelement">makeelement</a></code>,
152       <code><a href="lxml.etree._Element-class.html#remove">remove</a></code>,
153       <code><a href="lxml.etree._Element-class.html#replace">replace</a></code>,
154       <code><a href="lxml.etree._Element-class.html#xpath">xpath</a></code>
155       </p>
156     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">etree._Element</a></code></b> (private):
157       <code><a href="lxml.etree._Element-class.html#_init" onclick="show_private();">_init</a></code>
158       </p></div>
159     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.html.HtmlMixin-class.html" onclick="show_private();">HtmlMixin</a></code></b>:
160       <code><a href="lxml.html.HtmlMixin-class.html#cssselect">cssselect</a></code>,
161       <code><a href="lxml.html.HtmlMixin-class.html#drop_tag">drop_tag</a></code>,
162       <code><a href="lxml.html.HtmlMixin-class.html#drop_tree">drop_tree</a></code>,
163       <code><a href="lxml.html.HtmlMixin-class.html#find_class">find_class</a></code>,
164       <code><a href="lxml.html.HtmlMixin-class.html#find_rel_links">find_rel_links</a></code>,
165       <code><a href="lxml.html.HtmlMixin-class.html#get_element_by_id">get_element_by_id</a></code>,
166       <code><a href="lxml.html.HtmlMixin-class.html#iterlinks">iterlinks</a></code>,
167       <code><a href="lxml.html.HtmlMixin-class.html#make_links_absolute">make_links_absolute</a></code>,
168       <code><a href="lxml.html.HtmlMixin-class.html#resolve_base_href">resolve_base_href</a></code>,
169       <code><a href="lxml.html.HtmlMixin-class.html#rewrite_links">rewrite_links</a></code>,
170       <code><a href="lxml.html.HtmlMixin-class.html#text_content">text_content</a></code>
171       </p>
172     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.html.HtmlMixin-class.html" onclick="show_private();">HtmlMixin</a></code></b> (private):
173       <code><a href="lxml.html.HtmlMixin-class.html#_label__del" onclick="show_private();">_label__del</a></code>,
174       <code><a href="lxml.html.HtmlMixin-class.html#_label__get" onclick="show_private();">_label__get</a></code>,
175       <code><a href="lxml.html.HtmlMixin-class.html#_label__set" onclick="show_private();">_label__set</a></code>
176       </p></div>
177     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
178       <code>__delattr__</code>,
179       <code>__format__</code>,
180       <code>__getattribute__</code>,
181       <code>__hash__</code>,
182       <code>__reduce__</code>,
183       <code>__reduce_ex__</code>,
184       <code>__setattr__</code>,
185       <code>__sizeof__</code>,
186       <code>__str__</code>,
187       <code>__subclasshook__</code>
188       </p>
189     </td>
190   </tr>
191 </table>
192 <!-- ==================== PROPERTIES ==================== -->
193 <a name="section-Properties"></a>
194 <table class="summary" border="1" cellpadding="3"
195        cellspacing="0" width="100%" bgcolor="white">
196 <tr bgcolor="#70b0f0" class="table-header">
197   <td colspan="2" class="table-header">
198     <table border="0" cellpadding="0" cellspacing="0" width="100%">
199       <tr valign="top">
200         <td align="left"><span class="table-header">Properties</span></td>
201         <td align="right" valign="top"
202          ><span class="options">[<a href="#section-Properties"
203          class="privatelink" onclick="toggle_private();"
204          >hide private</a>]</span></td>
205       </tr>
206     </table>
207   </td>
208 </tr>
209   <tr>
210     <td colspan="2" class="summary">
211     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Comment-class.html" onclick="show_private();">etree._Comment</a></code></b>:
212       <code><a href="lxml.etree._Comment-class.html#tag">tag</a></code>
213       </p>
214     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">etree.__ContentOnlyElement</a></code></b>:
215       <code><a href="lxml.etree.__ContentOnlyElement-class.html#attrib">attrib</a></code>,
216       <code><a href="lxml.etree.__ContentOnlyElement-class.html#text">text</a></code>
217       </p>
218     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">etree._Element</a></code></b>:
219       <code><a href="lxml.etree._Element-class.html#base">base</a></code>,
220       <code><a href="lxml.etree._Element-class.html#nsmap">nsmap</a></code>,
221       <code><a href="lxml.etree._Element-class.html#prefix">prefix</a></code>,
222       <code><a href="lxml.etree._Element-class.html#sourceline">sourceline</a></code>,
223       <code><a href="lxml.etree._Element-class.html#tail">tail</a></code>
224       </p>
225     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.html.HtmlMixin-class.html" onclick="show_private();">HtmlMixin</a></code></b>:
226       <code><a href="lxml.html.HtmlMixin-class.html#base_url">base_url</a></code>,
227       <code><a href="lxml.html.HtmlMixin-class.html#body">body</a></code>,
228       <code><a href="lxml.html.HtmlMixin-class.html#forms">forms</a></code>,
229       <code><a href="lxml.html.HtmlMixin-class.html#head">head</a></code>,
230       <code><a href="lxml.html.HtmlMixin-class.html#label">label</a></code>
231       </p>
232     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
233       <code>__class__</code>
234       </p>
235     </td>
236   </tr>
237 </table>
238 <!-- ==================== NAVIGATION BAR ==================== -->
239 <table class="navbar" border="0" width="100%" cellpadding="0"
240        bgcolor="#a0c0ff" cellspacing="0">
241   <tr valign="middle">
242   <!-- Home link -->
243       <th>&nbsp;&nbsp;&nbsp;<a
244         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
245
246   <!-- Tree link -->
247       <th>&nbsp;&nbsp;&nbsp;<a
248         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
249
250   <!-- Index link -->
251       <th>&nbsp;&nbsp;&nbsp;<a
252         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
253
254   <!-- Help link -->
255       <th>&nbsp;&nbsp;&nbsp;<a
256         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
257
258   <!-- Project homepage -->
259       <th class="navbar" align="right" width="100%">
260         <table border="0" cellpadding="0" cellspacing="0">
261           <tr><th class="navbar" align="center"
262             ><a class="navbar" target="_top" href="/">lxml API</a></th>
263           </tr></table></th>
264   </tr>
265 </table>
266 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
267   <tr>
268     <td align="left" class="footer">
269     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:19 2012
270     </td>
271     <td align="right" class="footer">
272       <a target="mainFrame" href="http://epydoc.sourceforge.net"
273         >http://epydoc.sourceforge.net</a>
274     </td>
275   </tr>
276 </table>
277
278 <script type="text/javascript">
279   <!--
280   // Private objects are initially displayed (because if
281   // javascript is turned off then we want them to be
282   // visible); but by default, we want to hide them.  So hide
283   // them unless we have a cookie that says to show them.
284   checkCookie();
285   // -->
286 </script>
287 </body>
288 </html>