Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Helpviewer.Bookmarks.NsHtmlWriter.html
eric6/Documentation/Source/eric6.Helpviewer.Bookmarks.NsHtmlWriter.html
- changeset 6942
- 2602857055c5
- parent 3673
- e26d7d0c1088
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Helpviewer.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Helpviewer.Bookmarks.NsHtmlWriter</h1> | |
| 23 <p> | |
| 24 Module implementing a class to write Netscape HTML bookmark files. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#NsHtmlWriter">NsHtmlWriter</a></td> | |
| 34 <td>Class implementing a writer object to generate Netscape HTML bookmark files.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="NsHtmlWriter" ID="NsHtmlWriter"></a> | |
| 43 <h2>NsHtmlWriter</h2> | |
| 44 <p> | |
| 45 Class implementing a writer object to generate Netscape HTML bookmark | |
| 46 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><dl> | |
| 103 <dt>Returns:</dt> | |
| 104 <dd> | |
| 105 flag indicating success (boolean) | |
| 106 </dd> | |
| 107 </dl><a NAME="NsHtmlWriter.__writeBookmark" ID="NsHtmlWriter.__writeBookmark"></a> | |
| 108 <h4>NsHtmlWriter.__writeBookmark</h4> | |
| 109 <b>__writeBookmark</b>(<i>node, indent</i>) | |
| 110 <p> | |
| 111 Private method to write a bookmark node. | |
| 112 </p><dl> | |
| 113 <dt><i>node</i></dt> | |
| 114 <dd> | |
| 115 reference to the node to be written (BookmarkNode) | |
| 116 </dd><dt><i>indent</i></dt> | |
| 117 <dd> | |
| 118 size of the indentation (integer) | |
| 119 </dd> | |
| 120 </dl><a NAME="NsHtmlWriter.__writeFolder" ID="NsHtmlWriter.__writeFolder"></a> | |
| 121 <h4>NsHtmlWriter.__writeFolder</h4> | |
| 122 <b>__writeFolder</b>(<i>node, indent</i>) | |
| 123 <p> | |
| 124 Private method to write a bookmark node. | |
| 125 </p><dl> | |
| 126 <dt><i>node</i></dt> | |
| 127 <dd> | |
| 128 reference to the node to be written (BookmarkNode) | |
| 129 </dd><dt><i>indent</i></dt> | |
| 130 <dd> | |
| 131 size of the indentation (integer) | |
| 132 </dd> | |
| 133 </dl><a NAME="NsHtmlWriter.__writeItem" ID="NsHtmlWriter.__writeItem"></a> | |
| 134 <h4>NsHtmlWriter.__writeItem</h4> | |
| 135 <b>__writeItem</b>(<i>node, indent</i>) | |
| 136 <p> | |
| 137 Private method to write an entry for a node. | |
| 138 </p><dl> | |
| 139 <dt><i>node</i></dt> | |
| 140 <dd> | |
| 141 reference to the node to be written (BookmarkNode) | |
| 142 </dd><dt><i>indent</i></dt> | |
| 143 <dd> | |
| 144 size of the indentation (integer) | |
| 145 </dd> | |
| 146 </dl><a NAME="NsHtmlWriter.__writeSeparator" ID="NsHtmlWriter.__writeSeparator"></a> | |
| 147 <h4>NsHtmlWriter.__writeSeparator</h4> | |
| 148 <b>__writeSeparator</b>(<i>indent</i>) | |
| 149 <p> | |
| 150 Private method to write a separator. | |
| 151 </p><dl> | |
| 152 <dt><i>indent</i></dt> | |
| 153 <dd> | |
| 154 size of the indentation (integer) | |
| 155 </dd> | |
| 156 </dl><a NAME="NsHtmlWriter.write" ID="NsHtmlWriter.write"></a> | |
| 157 <h4>NsHtmlWriter.write</h4> | |
| 158 <b>write</b>(<i>fileNameOrDevice, root</i>) | |
| 159 <p> | |
| 160 Public method to write an Netscape HTML bookmark file. | |
| 161 </p><dl> | |
| 162 <dt><i>fileNameOrDevice</i></dt> | |
| 163 <dd> | |
| 164 name of the file to write (string) | |
| 165 or device to write to (QIODevice) | |
| 166 </dd><dt><i>root</i></dt> | |
| 167 <dd> | |
| 168 root node of the bookmark tree (BookmarkNode) | |
| 169 </dd> | |
| 170 </dl><dl> | |
| 171 <dt>Returns:</dt> | |
| 172 <dd> | |
| 173 flag indicating success (boolean) | |
| 174 </dd> | |
| 175 </dl> | |
| 176 <div align="right"><a href="#top">Up</a></div> | |
| 177 <hr /> | |
| 178 </body></html> |
