Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Helpviewer.Bookmarks.XbelWriter.html
eric6/Documentation/Source/eric6.Helpviewer.Bookmarks.XbelWriter.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Helpviewer.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Helpviewer.Bookmarks.XbelWriter</h1> | |
| 23 <p> | |
| 24 Module implementing a class to write XBEL 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="#XbelWriter">XbelWriter</a></td> | |
| 34 <td>Class implementing a writer object to generate XBEL 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="XbelWriter" ID="XbelWriter"></a> | |
| 43 <h2>XbelWriter</h2> | |
| 44 <p> | |
| 45 Class implementing a writer object to generate XBEL bookmark files. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QXmlStreamWriter | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#XbelWriter.__init__">XbelWriter</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#XbelWriter.__write">__write</a></td> | |
| 64 <td>Private method to write an XBEL bookmark file.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#XbelWriter.__writeItem">__writeItem</a></td> | |
| 67 <td>Private method to write an entry for a node.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#XbelWriter.write">write</a></td> | |
| 70 <td>Public method to write an XBEL bookmark file.</td> | |
| 71 </tr> | |
| 72 </table> | |
| 73 <h3>Static Methods</h3> | |
| 74 <table> | |
| 75 <tr><td>None</td></tr> | |
| 76 </table> | |
| 77 <a NAME="XbelWriter.__init__" ID="XbelWriter.__init__"></a> | |
| 78 <h4>XbelWriter (Constructor)</h4> | |
| 79 <b>XbelWriter</b>(<i></i>) | |
| 80 <p> | |
| 81 Constructor | |
| 82 </p><a NAME="XbelWriter.__write" ID="XbelWriter.__write"></a> | |
| 83 <h4>XbelWriter.__write</h4> | |
| 84 <b>__write</b>(<i>root</i>) | |
| 85 <p> | |
| 86 Private method to write an XBEL bookmark file. | |
| 87 </p><dl> | |
| 88 <dt><i>root</i></dt> | |
| 89 <dd> | |
| 90 root node of the bookmark tree (BookmarkNode) | |
| 91 </dd> | |
| 92 </dl><dl> | |
| 93 <dt>Returns:</dt> | |
| 94 <dd> | |
| 95 flag indicating success (boolean) | |
| 96 </dd> | |
| 97 </dl><a NAME="XbelWriter.__writeItem" ID="XbelWriter.__writeItem"></a> | |
| 98 <h4>XbelWriter.__writeItem</h4> | |
| 99 <b>__writeItem</b>(<i>node</i>) | |
| 100 <p> | |
| 101 Private method to write an entry for a node. | |
| 102 </p><dl> | |
| 103 <dt><i>node</i></dt> | |
| 104 <dd> | |
| 105 reference to the node to be written (BookmarkNode) | |
| 106 </dd> | |
| 107 </dl><a NAME="XbelWriter.write" ID="XbelWriter.write"></a> | |
| 108 <h4>XbelWriter.write</h4> | |
| 109 <b>write</b>(<i>fileNameOrDevice, root</i>) | |
| 110 <p> | |
| 111 Public method to write an XBEL bookmark file. | |
| 112 </p><dl> | |
| 113 <dt><i>fileNameOrDevice</i></dt> | |
| 114 <dd> | |
| 115 name of the file to write (string) | |
| 116 or device to write to (QIODevice) | |
| 117 </dd><dt><i>root</i></dt> | |
| 118 <dd> | |
| 119 root node of the bookmark tree (BookmarkNode) | |
| 120 </dd> | |
| 121 </dl><dl> | |
| 122 <dt>Returns:</dt> | |
| 123 <dd> | |
| 124 flag indicating success (boolean) | |
| 125 </dd> | |
| 126 </dl> | |
| 127 <div align="right"><a href="#top">Up</a></div> | |
| 128 <hr /> | |
| 129 </body></html> |
