Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.XbelWriter.html
src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.XbelWriter.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.XbelWriter</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.XbelWriter</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a class to write XBEL 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="#XbelWriter">XbelWriter</a></td> | |
| 25 <td>Class implementing a writer object to generate XBEL 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="XbelWriter" ID="XbelWriter"></a> | |
| 36 <h2>XbelWriter</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a writer object to generate XBEL bookmark files. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QXmlStreamWriter | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#XbelWriter.__init__">XbelWriter</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#XbelWriter.__write">__write</a></td> | |
| 63 <td>Private method to write an XBEL bookmark file.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#XbelWriter.__writeItem">__writeItem</a></td> | |
| 67 <td>Private method to write an entry for a node.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#XbelWriter.write">write</a></td> | |
| 71 <td>Public method to write an XBEL bookmark file.</td> | |
| 72 </tr> | |
| 73 </table> | |
| 74 <h3>Static Methods</h3> | |
| 75 | |
| 76 <table> | |
| 77 <tr><td>None</td></tr> | |
| 78 </table> | |
| 79 | |
| 80 <a NAME="XbelWriter.__init__" ID="XbelWriter.__init__"></a> | |
| 81 <h4>XbelWriter (Constructor)</h4> | |
| 82 <b>XbelWriter</b>(<i></i>) | |
| 83 | |
| 84 <p> | |
| 85 Constructor | |
| 86 </p> | |
| 87 <a NAME="XbelWriter.__write" ID="XbelWriter.__write"></a> | |
| 88 <h4>XbelWriter.__write</h4> | |
| 89 <b>__write</b>(<i>root</i>) | |
| 90 | |
| 91 <p> | |
| 92 Private method to write an XBEL bookmark file. | |
| 93 </p> | |
| 94 <dl> | |
| 95 | |
| 96 <dt><i>root</i></dt> | |
| 97 <dd> | |
| 98 root node of the bookmark tree (BookmarkNode) | |
| 99 </dd> | |
| 100 </dl> | |
| 101 <dl> | |
| 102 <dt>Return:</dt> | |
| 103 <dd> | |
| 104 flag indicating success (boolean) | |
| 105 </dd> | |
| 106 </dl> | |
| 107 <a NAME="XbelWriter.__writeItem" ID="XbelWriter.__writeItem"></a> | |
| 108 <h4>XbelWriter.__writeItem</h4> | |
| 109 <b>__writeItem</b>(<i>node</i>) | |
| 110 | |
| 111 <p> | |
| 112 Private method to write an entry for a node. | |
| 113 </p> | |
| 114 <dl> | |
| 115 | |
| 116 <dt><i>node</i></dt> | |
| 117 <dd> | |
| 118 reference to the node to be written (BookmarkNode) | |
| 119 </dd> | |
| 120 </dl> | |
| 121 <a NAME="XbelWriter.write" ID="XbelWriter.write"></a> | |
| 122 <h4>XbelWriter.write</h4> | |
| 123 <b>write</b>(<i>fileNameOrDevice, root</i>) | |
| 124 | |
| 125 <p> | |
| 126 Public method to write an XBEL bookmark file. | |
| 127 </p> | |
| 128 <dl> | |
| 129 | |
| 130 <dt><i>fileNameOrDevice</i></dt> | |
| 131 <dd> | |
| 132 name of the file to write (string) | |
| 133 or device to write to (QIODevice) | |
| 134 </dd> | |
| 135 <dt><i>root</i></dt> | |
| 136 <dd> | |
| 137 root node of the bookmark tree (BookmarkNode) | |
| 138 </dd> | |
| 139 </dl> | |
| 140 <dl> | |
| 141 <dt>Return:</dt> | |
| 142 <dd> | |
| 143 flag indicating success (boolean) | |
| 144 </dd> | |
| 145 </dl> | |
| 146 <div align="right"><a href="#top">Up</a></div> | |
| 147 <hr /> | |
| 148 </body></html> |
