Documentation/Source/eric5.Helpviewer.Bookmarks.NsHtmlWriter.html

changeset 1732
b140a24e147a
child 2367
78f6c8193d37
equal deleted inserted replaced
1731:56cf9c150dbf 1732:b140a24e147a
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.Helpviewer.Bookmarks.NsHtmlWriter</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Helpviewer.Bookmarks.NsHtmlWriter</h1>
24 <p>
25 Module implementing a class to write Netscape HTML bookmark files.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#NsHtmlWriter">NsHtmlWriter</a></td>
35 <td>Class implementing a writer object to generate Netscape HTML bookmark files.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="NsHtmlWriter" ID="NsHtmlWriter"></a>
44 <h2>NsHtmlWriter</h2>
45 <p>
46 Class implementing a writer object to generate Netscape HTML bookmark files.
47 </p>
48 <h3>Derived from</h3>
49 QObject
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>indentSize</td></tr>
53 </table>
54 <h3>Class Methods</h3>
55 <table>
56 <tr><td>None</td></tr>
57 </table>
58 <h3>Methods</h3>
59 <table>
60 <tr>
61 <td><a href="#NsHtmlWriter.__init__">NsHtmlWriter</a></td>
62 <td>Constructor</td>
63 </tr><tr>
64 <td><a href="#NsHtmlWriter.__write">__write</a></td>
65 <td>Private method to write an Netscape HTML bookmark file.</td>
66 </tr><tr>
67 <td><a href="#NsHtmlWriter.__writeBookmark">__writeBookmark</a></td>
68 <td>Private method to write a bookmark node.</td>
69 </tr><tr>
70 <td><a href="#NsHtmlWriter.__writeFolder">__writeFolder</a></td>
71 <td>Private method to write a bookmark node.</td>
72 </tr><tr>
73 <td><a href="#NsHtmlWriter.__writeItem">__writeItem</a></td>
74 <td>Private method to write an entry for a node.</td>
75 </tr><tr>
76 <td><a href="#NsHtmlWriter.__writeSeparator">__writeSeparator</a></td>
77 <td>Private method to write a separator.</td>
78 </tr><tr>
79 <td><a href="#NsHtmlWriter.write">write</a></td>
80 <td>Public method to write an Netscape HTML bookmark file.</td>
81 </tr>
82 </table>
83 <h3>Static Methods</h3>
84 <table>
85 <tr><td>None</td></tr>
86 </table>
87 <a NAME="NsHtmlWriter.__init__" ID="NsHtmlWriter.__init__"></a>
88 <h4>NsHtmlWriter (Constructor)</h4>
89 <b>NsHtmlWriter</b>(<i></i>)
90 <p>
91 Constructor
92 </p><a NAME="NsHtmlWriter.__write" ID="NsHtmlWriter.__write"></a>
93 <h4>NsHtmlWriter.__write</h4>
94 <b>__write</b>(<i>root</i>)
95 <p>
96 Private method to write an Netscape HTML bookmark file.
97 </p><dl>
98 <dt><i>root</i></dt>
99 <dd>
100 root node of the bookmark tree (BookmarkNode)
101 </dd>
102 </dl><a NAME="NsHtmlWriter.__writeBookmark" ID="NsHtmlWriter.__writeBookmark"></a>
103 <h4>NsHtmlWriter.__writeBookmark</h4>
104 <b>__writeBookmark</b>(<i>node, indent</i>)
105 <p>
106 Private method to write a bookmark node.
107 </p><dl>
108 <dt><i>node</i></dt>
109 <dd>
110 reference to the node to be written (BookmarkNode)
111 </dd><dt><i>indent</i></dt>
112 <dd>
113 size of the indentation (integer)
114 </dd>
115 </dl><a NAME="NsHtmlWriter.__writeFolder" ID="NsHtmlWriter.__writeFolder"></a>
116 <h4>NsHtmlWriter.__writeFolder</h4>
117 <b>__writeFolder</b>(<i>node, indent</i>)
118 <p>
119 Private method to write a bookmark node.
120 </p><dl>
121 <dt><i>node</i></dt>
122 <dd>
123 reference to the node to be written (BookmarkNode)
124 </dd><dt><i>indent</i></dt>
125 <dd>
126 size of the indentation (integer)
127 </dd>
128 </dl><a NAME="NsHtmlWriter.__writeItem" ID="NsHtmlWriter.__writeItem"></a>
129 <h4>NsHtmlWriter.__writeItem</h4>
130 <b>__writeItem</b>(<i>node, indent</i>)
131 <p>
132 Private method to write an entry for a node.
133 </p><dl>
134 <dt><i>node</i></dt>
135 <dd>
136 reference to the node to be written (BookmarkNode)
137 </dd><dt><i>indent</i></dt>
138 <dd>
139 size of the indentation (integer)
140 </dd>
141 </dl><a NAME="NsHtmlWriter.__writeSeparator" ID="NsHtmlWriter.__writeSeparator"></a>
142 <h4>NsHtmlWriter.__writeSeparator</h4>
143 <b>__writeSeparator</b>(<i>indent</i>)
144 <p>
145 Private method to write a separator.
146 </p><dl>
147 <dt><i>indent</i></dt>
148 <dd>
149 size of the indentation (integer)
150 </dd>
151 </dl><a NAME="NsHtmlWriter.write" ID="NsHtmlWriter.write"></a>
152 <h4>NsHtmlWriter.write</h4>
153 <b>write</b>(<i>fileNameOrDevice, root</i>)
154 <p>
155 Public method to write an Netscape HTML bookmark file.
156 </p><dl>
157 <dt><i>fileNameOrDevice</i></dt>
158 <dd>
159 name of the file to write (string)
160 or device to write to (QIODevice)
161 </dd><dt><i>root</i></dt>
162 <dd>
163 root node of the bookmark tree (BookmarkNode)
164 </dd>
165 </dl>
166 <div align="right"><a href="#top">Up</a></div>
167 <hr />
168 </body></html>

eric ide

mercurial