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