16 |
16 |
17 a { color: #BA6D36; } |
17 a { color: #BA6D36; } |
18 |
18 |
19 </style> |
19 </style> |
20 </head> |
20 </head> |
21 <body><a NAME="top" ID="top"></a> |
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
22 <h1>eric6.WebBrowser.Bookmarks.NsHtmlWriter</h1> |
23 <h1>eric6.WebBrowser.Bookmarks.NsHtmlWriter</h1> |
|
24 |
23 <p> |
25 <p> |
24 Module implementing a class to write Netscape HTML bookmark files. |
26 Module implementing a class to write Netscape HTML bookmark files. |
25 </p> |
27 </p> |
26 <h3>Global Attributes</h3> |
28 <h3>Global Attributes</h3> |
|
29 |
27 <table> |
30 <table> |
28 <tr><td>None</td></tr> |
31 <tr><td>None</td></tr> |
29 </table> |
32 </table> |
30 <h3>Classes</h3> |
33 <h3>Classes</h3> |
31 <table> |
34 |
|
35 <table> |
|
36 |
32 <tr> |
37 <tr> |
33 <td><a href="#NsHtmlWriter">NsHtmlWriter</a></td> |
38 <td><a href="#NsHtmlWriter">NsHtmlWriter</a></td> |
34 <td>Class implementing a writer object to generate Netscape HTML bookmark files.</td> |
39 <td>Class implementing a writer object to generate Netscape HTML bookmark files.</td> |
35 </tr> |
40 </tr> |
36 </table> |
41 </table> |
37 <h3>Functions</h3> |
42 <h3>Functions</h3> |
38 <table> |
43 |
39 <tr><td>None</td></tr> |
44 <table> |
40 </table> |
45 <tr><td>None</td></tr> |
41 <hr /><hr /> |
46 </table> |
|
47 <hr /> |
|
48 <hr /> |
42 <a NAME="NsHtmlWriter" ID="NsHtmlWriter"></a> |
49 <a NAME="NsHtmlWriter" ID="NsHtmlWriter"></a> |
43 <h2>NsHtmlWriter</h2> |
50 <h2>NsHtmlWriter</h2> |
|
51 |
44 <p> |
52 <p> |
45 Class implementing a writer object to generate Netscape HTML bookmark |
53 Class implementing a writer object to generate Netscape HTML bookmark |
46 files. |
54 files. |
47 </p> |
55 </p> |
48 <h3>Derived from</h3> |
56 <h3>Derived from</h3> |
49 QObject |
57 QObject |
50 <h3>Class Attributes</h3> |
58 <h3>Class Attributes</h3> |
|
59 |
51 <table> |
60 <table> |
52 <tr><td>indentSize</td></tr> |
61 <tr><td>indentSize</td></tr> |
53 </table> |
62 </table> |
54 <h3>Class Methods</h3> |
63 <h3>Class Methods</h3> |
|
64 |
55 <table> |
65 <table> |
56 <tr><td>None</td></tr> |
66 <tr><td>None</td></tr> |
57 </table> |
67 </table> |
58 <h3>Methods</h3> |
68 <h3>Methods</h3> |
59 <table> |
69 |
|
70 <table> |
|
71 |
60 <tr> |
72 <tr> |
61 <td><a href="#NsHtmlWriter.__init__">NsHtmlWriter</a></td> |
73 <td><a href="#NsHtmlWriter.__init__">NsHtmlWriter</a></td> |
62 <td>Constructor</td> |
74 <td>Constructor</td> |
63 </tr><tr> |
75 </tr> |
|
76 <tr> |
64 <td><a href="#NsHtmlWriter.__write">__write</a></td> |
77 <td><a href="#NsHtmlWriter.__write">__write</a></td> |
65 <td>Private method to write an Netscape HTML bookmark file.</td> |
78 <td>Private method to write an Netscape HTML bookmark file.</td> |
66 </tr><tr> |
79 </tr> |
|
80 <tr> |
67 <td><a href="#NsHtmlWriter.__writeBookmark">__writeBookmark</a></td> |
81 <td><a href="#NsHtmlWriter.__writeBookmark">__writeBookmark</a></td> |
68 <td>Private method to write a bookmark node.</td> |
82 <td>Private method to write a bookmark node.</td> |
69 </tr><tr> |
83 </tr> |
|
84 <tr> |
70 <td><a href="#NsHtmlWriter.__writeFolder">__writeFolder</a></td> |
85 <td><a href="#NsHtmlWriter.__writeFolder">__writeFolder</a></td> |
71 <td>Private method to write a bookmark node.</td> |
86 <td>Private method to write a bookmark node.</td> |
72 </tr><tr> |
87 </tr> |
|
88 <tr> |
73 <td><a href="#NsHtmlWriter.__writeItem">__writeItem</a></td> |
89 <td><a href="#NsHtmlWriter.__writeItem">__writeItem</a></td> |
74 <td>Private method to write an entry for a node.</td> |
90 <td>Private method to write an entry for a node.</td> |
75 </tr><tr> |
91 </tr> |
|
92 <tr> |
76 <td><a href="#NsHtmlWriter.__writeSeparator">__writeSeparator</a></td> |
93 <td><a href="#NsHtmlWriter.__writeSeparator">__writeSeparator</a></td> |
77 <td>Private method to write a separator.</td> |
94 <td>Private method to write a separator.</td> |
78 </tr><tr> |
95 </tr> |
|
96 <tr> |
79 <td><a href="#NsHtmlWriter.write">write</a></td> |
97 <td><a href="#NsHtmlWriter.write">write</a></td> |
80 <td>Public method to write an Netscape HTML bookmark file.</td> |
98 <td>Public method to write an Netscape HTML bookmark file.</td> |
81 </tr> |
99 </tr> |
82 </table> |
100 </table> |
83 <h3>Static Methods</h3> |
101 <h3>Static Methods</h3> |
84 <table> |
102 |
85 <tr><td>None</td></tr> |
103 <table> |
86 </table> |
104 <tr><td>None</td></tr> |
|
105 </table> |
|
106 |
87 <a NAME="NsHtmlWriter.__init__" ID="NsHtmlWriter.__init__"></a> |
107 <a NAME="NsHtmlWriter.__init__" ID="NsHtmlWriter.__init__"></a> |
88 <h4>NsHtmlWriter (Constructor)</h4> |
108 <h4>NsHtmlWriter (Constructor)</h4> |
89 <b>NsHtmlWriter</b>(<i></i>) |
109 <b>NsHtmlWriter</b>(<i></i>) |
|
110 |
90 <p> |
111 <p> |
91 Constructor |
112 Constructor |
92 </p><a NAME="NsHtmlWriter.__write" ID="NsHtmlWriter.__write"></a> |
113 </p> |
|
114 <a NAME="NsHtmlWriter.__write" ID="NsHtmlWriter.__write"></a> |
93 <h4>NsHtmlWriter.__write</h4> |
115 <h4>NsHtmlWriter.__write</h4> |
94 <b>__write</b>(<i>root</i>) |
116 <b>__write</b>(<i>root</i>) |
|
117 |
95 <p> |
118 <p> |
96 Private method to write an Netscape HTML bookmark file. |
119 Private method to write an Netscape HTML bookmark file. |
97 </p><dl> |
120 </p> |
|
121 <dl> |
|
122 |
98 <dt><i>root</i></dt> |
123 <dt><i>root</i></dt> |
99 <dd> |
124 <dd> |
100 root node of the bookmark tree (BookmarkNode) |
125 root node of the bookmark tree (BookmarkNode) |
101 </dd> |
126 </dd> |
102 </dl><dl> |
127 </dl> |
|
128 <dl> |
103 <dt>Returns:</dt> |
129 <dt>Returns:</dt> |
104 <dd> |
130 <dd> |
105 flag indicating success (boolean) |
131 flag indicating success (boolean) |
106 </dd> |
132 </dd> |
107 </dl><a NAME="NsHtmlWriter.__writeBookmark" ID="NsHtmlWriter.__writeBookmark"></a> |
133 </dl> |
|
134 <a NAME="NsHtmlWriter.__writeBookmark" ID="NsHtmlWriter.__writeBookmark"></a> |
108 <h4>NsHtmlWriter.__writeBookmark</h4> |
135 <h4>NsHtmlWriter.__writeBookmark</h4> |
109 <b>__writeBookmark</b>(<i>node, indent</i>) |
136 <b>__writeBookmark</b>(<i>node, indent</i>) |
|
137 |
110 <p> |
138 <p> |
111 Private method to write a bookmark node. |
139 Private method to write a bookmark node. |
112 </p><dl> |
140 </p> |
|
141 <dl> |
|
142 |
113 <dt><i>node</i></dt> |
143 <dt><i>node</i></dt> |
114 <dd> |
144 <dd> |
115 reference to the node to be written (BookmarkNode) |
145 reference to the node to be written (BookmarkNode) |
116 </dd><dt><i>indent</i></dt> |
146 </dd> |
117 <dd> |
147 <dt><i>indent</i></dt> |
118 size of the indentation (integer) |
148 <dd> |
119 </dd> |
149 size of the indentation (integer) |
120 </dl><a NAME="NsHtmlWriter.__writeFolder" ID="NsHtmlWriter.__writeFolder"></a> |
150 </dd> |
|
151 </dl> |
|
152 <a NAME="NsHtmlWriter.__writeFolder" ID="NsHtmlWriter.__writeFolder"></a> |
121 <h4>NsHtmlWriter.__writeFolder</h4> |
153 <h4>NsHtmlWriter.__writeFolder</h4> |
122 <b>__writeFolder</b>(<i>node, indent</i>) |
154 <b>__writeFolder</b>(<i>node, indent</i>) |
|
155 |
123 <p> |
156 <p> |
124 Private method to write a bookmark node. |
157 Private method to write a bookmark node. |
125 </p><dl> |
158 </p> |
|
159 <dl> |
|
160 |
126 <dt><i>node</i></dt> |
161 <dt><i>node</i></dt> |
127 <dd> |
162 <dd> |
128 reference to the node to be written (BookmarkNode) |
163 reference to the node to be written (BookmarkNode) |
129 </dd><dt><i>indent</i></dt> |
164 </dd> |
130 <dd> |
165 <dt><i>indent</i></dt> |
131 size of the indentation (integer) |
166 <dd> |
132 </dd> |
167 size of the indentation (integer) |
133 </dl><a NAME="NsHtmlWriter.__writeItem" ID="NsHtmlWriter.__writeItem"></a> |
168 </dd> |
|
169 </dl> |
|
170 <a NAME="NsHtmlWriter.__writeItem" ID="NsHtmlWriter.__writeItem"></a> |
134 <h4>NsHtmlWriter.__writeItem</h4> |
171 <h4>NsHtmlWriter.__writeItem</h4> |
135 <b>__writeItem</b>(<i>node, indent</i>) |
172 <b>__writeItem</b>(<i>node, indent</i>) |
|
173 |
136 <p> |
174 <p> |
137 Private method to write an entry for a node. |
175 Private method to write an entry for a node. |
138 </p><dl> |
176 </p> |
|
177 <dl> |
|
178 |
139 <dt><i>node</i></dt> |
179 <dt><i>node</i></dt> |
140 <dd> |
180 <dd> |
141 reference to the node to be written (BookmarkNode) |
181 reference to the node to be written (BookmarkNode) |
142 </dd><dt><i>indent</i></dt> |
182 </dd> |
143 <dd> |
183 <dt><i>indent</i></dt> |
144 size of the indentation (integer) |
184 <dd> |
145 </dd> |
185 size of the indentation (integer) |
146 </dl><a NAME="NsHtmlWriter.__writeSeparator" ID="NsHtmlWriter.__writeSeparator"></a> |
186 </dd> |
|
187 </dl> |
|
188 <a NAME="NsHtmlWriter.__writeSeparator" ID="NsHtmlWriter.__writeSeparator"></a> |
147 <h4>NsHtmlWriter.__writeSeparator</h4> |
189 <h4>NsHtmlWriter.__writeSeparator</h4> |
148 <b>__writeSeparator</b>(<i>indent</i>) |
190 <b>__writeSeparator</b>(<i>indent</i>) |
|
191 |
149 <p> |
192 <p> |
150 Private method to write a separator. |
193 Private method to write a separator. |
151 </p><dl> |
194 </p> |
152 <dt><i>indent</i></dt> |
195 <dl> |
153 <dd> |
196 |
154 size of the indentation (integer) |
197 <dt><i>indent</i></dt> |
155 </dd> |
198 <dd> |
156 </dl><a NAME="NsHtmlWriter.write" ID="NsHtmlWriter.write"></a> |
199 size of the indentation (integer) |
|
200 </dd> |
|
201 </dl> |
|
202 <a NAME="NsHtmlWriter.write" ID="NsHtmlWriter.write"></a> |
157 <h4>NsHtmlWriter.write</h4> |
203 <h4>NsHtmlWriter.write</h4> |
158 <b>write</b>(<i>fileNameOrDevice, root</i>) |
204 <b>write</b>(<i>fileNameOrDevice, root</i>) |
|
205 |
159 <p> |
206 <p> |
160 Public method to write an Netscape HTML bookmark file. |
207 Public method to write an Netscape HTML bookmark file. |
161 </p><dl> |
208 </p> |
|
209 <dl> |
|
210 |
162 <dt><i>fileNameOrDevice</i></dt> |
211 <dt><i>fileNameOrDevice</i></dt> |
163 <dd> |
212 <dd> |
164 name of the file to write (string) |
213 name of the file to write (string) |
165 or device to write to (QIODevice) |
214 or device to write to (QIODevice) |
166 </dd><dt><i>root</i></dt> |
215 </dd> |
|
216 <dt><i>root</i></dt> |
167 <dd> |
217 <dd> |
168 root node of the bookmark tree (BookmarkNode) |
218 root node of the bookmark tree (BookmarkNode) |
169 </dd> |
219 </dd> |
170 </dl><dl> |
220 </dl> |
|
221 <dl> |
171 <dt>Returns:</dt> |
222 <dt>Returns:</dt> |
172 <dd> |
223 <dd> |
173 flag indicating success (boolean) |
224 flag indicating success (boolean) |
174 </dd> |
225 </dd> |
175 </dl> |
226 </dl> |