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