src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.NsHtmlWriter.html

branch
eric7
changeset 10479
856476537696
parent 10436
f6881d10e995
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.Bookmarks.NsHtmlWriter</h1> 9 <h1>eric7.WebBrowser.Bookmarks.NsHtmlWriter</h1>
10
11 <p> 10 <p>
12 Module implementing a class to write Netscape HTML bookmark files. 11 Module implementing a class to write Netscape HTML bookmark files.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#NsHtmlWriter">NsHtmlWriter</a></td> 22 <td><a href="#NsHtmlWriter">NsHtmlWriter</a></td>
25 <td>Class implementing a writer object to generate Netscape HTML bookmark files.</td> 23 <td>Class implementing a writer object to generate Netscape HTML bookmark files.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="NsHtmlWriter" ID="NsHtmlWriter"></a> 34 <a NAME="NsHtmlWriter" ID="NsHtmlWriter"></a>
36 <h2>NsHtmlWriter</h2> 35 <h2>NsHtmlWriter</h2>
37
38 <p> 36 <p>
39 Class implementing a writer object to generate Netscape HTML bookmark 37 Class implementing a writer object to generate Netscape HTML bookmark
40 files. 38 files.
41 </p> 39 </p>
40
42 <h3>Derived from</h3> 41 <h3>Derived from</h3>
43 QObject 42 QObject
44 <h3>Class Attributes</h3> 43 <h3>Class Attributes</h3>
45
46 <table> 44 <table>
47 <tr><td>indentSize</td></tr> 45 <tr><td>indentSize</td></tr>
48 </table> 46 </table>
47
49 <h3>Class Methods</h3> 48 <h3>Class Methods</h3>
50 49 <table>
51 <table> 50 <tr><td>None</td></tr>
52 <tr><td>None</td></tr> 51 </table>
53 </table> 52
54 <h3>Methods</h3> 53 <h3>Methods</h3>
55 54 <table>
56 <table>
57
58 <tr> 55 <tr>
59 <td><a href="#NsHtmlWriter.__init__">NsHtmlWriter</a></td> 56 <td><a href="#NsHtmlWriter.__init__">NsHtmlWriter</a></td>
60 <td>Constructor</td> 57 <td>Constructor</td>
61 </tr> 58 </tr>
62 <tr> 59 <tr>
82 <tr> 79 <tr>
83 <td><a href="#NsHtmlWriter.write">write</a></td> 80 <td><a href="#NsHtmlWriter.write">write</a></td>
84 <td>Public method to write an Netscape HTML bookmark file.</td> 81 <td>Public method to write an Netscape HTML bookmark file.</td>
85 </tr> 82 </tr>
86 </table> 83 </table>
84
87 <h3>Static Methods</h3> 85 <h3>Static Methods</h3>
88 86 <table>
89 <table> 87 <tr><td>None</td></tr>
90 <tr><td>None</td></tr> 88 </table>
91 </table> 89
92 90
93 <a NAME="NsHtmlWriter.__init__" ID="NsHtmlWriter.__init__"></a> 91 <a NAME="NsHtmlWriter.__init__" ID="NsHtmlWriter.__init__"></a>
94 <h4>NsHtmlWriter (Constructor)</h4> 92 <h4>NsHtmlWriter (Constructor)</h4>
95 <b>NsHtmlWriter</b>(<i></i>) 93 <b>NsHtmlWriter</b>(<i></i>)
96
97 <p> 94 <p>
98 Constructor 95 Constructor
99 </p> 96 </p>
97
100 <a NAME="NsHtmlWriter.__write" ID="NsHtmlWriter.__write"></a> 98 <a NAME="NsHtmlWriter.__write" ID="NsHtmlWriter.__write"></a>
101 <h4>NsHtmlWriter.__write</h4> 99 <h4>NsHtmlWriter.__write</h4>
102 <b>__write</b>(<i>root</i>) 100 <b>__write</b>(<i>root</i>)
103
104 <p> 101 <p>
105 Private method to write an Netscape HTML bookmark file. 102 Private method to write an Netscape HTML bookmark file.
106 </p> 103 </p>
104
107 <dl> 105 <dl>
108 106
109 <dt><i>root</i> (BookmarkNode)</dt> 107 <dt><i>root</i> (BookmarkNode)</dt>
110 <dd> 108 <dd>
111 root node of the bookmark tree 109 root node of the bookmark tree
124 </dd> 122 </dd>
125 </dl> 123 </dl>
126 <a NAME="NsHtmlWriter.__writeBookmark" ID="NsHtmlWriter.__writeBookmark"></a> 124 <a NAME="NsHtmlWriter.__writeBookmark" ID="NsHtmlWriter.__writeBookmark"></a>
127 <h4>NsHtmlWriter.__writeBookmark</h4> 125 <h4>NsHtmlWriter.__writeBookmark</h4>
128 <b>__writeBookmark</b>(<i>node, indent</i>) 126 <b>__writeBookmark</b>(<i>node, indent</i>)
129
130 <p> 127 <p>
131 Private method to write a bookmark node. 128 Private method to write a bookmark node.
132 </p> 129 </p>
130
133 <dl> 131 <dl>
134 132
135 <dt><i>node</i> (BookmarkNode)</dt> 133 <dt><i>node</i> (BookmarkNode)</dt>
136 <dd> 134 <dd>
137 reference to the node to be written 135 reference to the node to be written
142 </dd> 140 </dd>
143 </dl> 141 </dl>
144 <a NAME="NsHtmlWriter.__writeFolder" ID="NsHtmlWriter.__writeFolder"></a> 142 <a NAME="NsHtmlWriter.__writeFolder" ID="NsHtmlWriter.__writeFolder"></a>
145 <h4>NsHtmlWriter.__writeFolder</h4> 143 <h4>NsHtmlWriter.__writeFolder</h4>
146 <b>__writeFolder</b>(<i>node, indent</i>) 144 <b>__writeFolder</b>(<i>node, indent</i>)
147
148 <p> 145 <p>
149 Private method to write a bookmark node. 146 Private method to write a bookmark node.
150 </p> 147 </p>
148
151 <dl> 149 <dl>
152 150
153 <dt><i>node</i> (BookmarkNode)</dt> 151 <dt><i>node</i> (BookmarkNode)</dt>
154 <dd> 152 <dd>
155 reference to the node to be written 153 reference to the node to be written
160 </dd> 158 </dd>
161 </dl> 159 </dl>
162 <a NAME="NsHtmlWriter.__writeItem" ID="NsHtmlWriter.__writeItem"></a> 160 <a NAME="NsHtmlWriter.__writeItem" ID="NsHtmlWriter.__writeItem"></a>
163 <h4>NsHtmlWriter.__writeItem</h4> 161 <h4>NsHtmlWriter.__writeItem</h4>
164 <b>__writeItem</b>(<i>node, indent</i>) 162 <b>__writeItem</b>(<i>node, indent</i>)
165
166 <p> 163 <p>
167 Private method to write an entry for a node. 164 Private method to write an entry for a node.
168 </p> 165 </p>
166
169 <dl> 167 <dl>
170 168
171 <dt><i>node</i> (BookmarkNode)</dt> 169 <dt><i>node</i> (BookmarkNode)</dt>
172 <dd> 170 <dd>
173 reference to the node to be written 171 reference to the node to be written
178 </dd> 176 </dd>
179 </dl> 177 </dl>
180 <a NAME="NsHtmlWriter.__writeSeparator" ID="NsHtmlWriter.__writeSeparator"></a> 178 <a NAME="NsHtmlWriter.__writeSeparator" ID="NsHtmlWriter.__writeSeparator"></a>
181 <h4>NsHtmlWriter.__writeSeparator</h4> 179 <h4>NsHtmlWriter.__writeSeparator</h4>
182 <b>__writeSeparator</b>(<i>indent</i>) 180 <b>__writeSeparator</b>(<i>indent</i>)
183
184 <p> 181 <p>
185 Private method to write a separator. 182 Private method to write a separator.
186 </p> 183 </p>
184
187 <dl> 185 <dl>
188 186
189 <dt><i>indent</i> (int)</dt> 187 <dt><i>indent</i> (int)</dt>
190 <dd> 188 <dd>
191 size of the indentation 189 size of the indentation
192 </dd> 190 </dd>
193 </dl> 191 </dl>
194 <a NAME="NsHtmlWriter.write" ID="NsHtmlWriter.write"></a> 192 <a NAME="NsHtmlWriter.write" ID="NsHtmlWriter.write"></a>
195 <h4>NsHtmlWriter.write</h4> 193 <h4>NsHtmlWriter.write</h4>
196 <b>write</b>(<i>fileNameOrDevice, root</i>) 194 <b>write</b>(<i>fileNameOrDevice, root</i>)
197
198 <p> 195 <p>
199 Public method to write an Netscape HTML bookmark file. 196 Public method to write an Netscape HTML bookmark file.
200 </p> 197 </p>
198
201 <dl> 199 <dl>
202 200
203 <dt><i>fileNameOrDevice</i> (str)</dt> 201 <dt><i>fileNameOrDevice</i> (str)</dt>
204 <dd> 202 <dd>
205 name of the file to write 203 name of the file to write

eric ide

mercurial