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