Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.Helpviewer.Bookmarks.XbelWriter.html
Documentation/Source/eric4.Helpviewer.Bookmarks.XbelWriter.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric4.Helpviewer.Bookmarks.XbelWriter</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.Helpviewer.Bookmarks.XbelWriter</h1> | |
| 24 <p> | |
| 25 Module implementing a class to write XBEL bookmark files. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#XbelWriter">XbelWriter</a></td> | |
| 35 <td>Class implementing a writer object to generate XBEL bookmark files.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="XbelWriter" ID="XbelWriter"></a> | |
| 44 <h2>XbelWriter</h2> | |
| 45 <p> | |
| 46 Class implementing a writer object to generate XBEL bookmark files. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QXmlStreamWriter | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#XbelWriter.__init__">XbelWriter</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#XbelWriter.__write">__write</a></td> | |
| 61 <td>Private method to write an XBEL bookmark file.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#XbelWriter.__writeItem">__writeItem</a></td> | |
| 64 <td>Private method to write an entry for a node.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#XbelWriter.write">write</a></td> | |
| 67 <td>Public method to write an XBEL bookmark file.</td> | |
| 68 </tr> | |
| 69 </table> | |
| 70 <a NAME="XbelWriter.__init__" ID="XbelWriter.__init__"></a> | |
| 71 <h4>XbelWriter (Constructor)</h4> | |
| 72 <b>XbelWriter</b>(<i></i>) | |
| 73 <p> | |
| 74 Constructor | |
| 75 </p><a NAME="XbelWriter.__write" ID="XbelWriter.__write"></a> | |
| 76 <h4>XbelWriter.__write</h4> | |
| 77 <b>__write</b>(<i>root</i>) | |
| 78 <p> | |
| 79 Private method to write an XBEL bookmark file. | |
| 80 </p><dl> | |
| 81 <dt><i>root</i></dt> | |
| 82 <dd> | |
| 83 root node of the bookmark tree (BookmarkNode) | |
| 84 </dd> | |
| 85 </dl><a NAME="XbelWriter.__writeItem" ID="XbelWriter.__writeItem"></a> | |
| 86 <h4>XbelWriter.__writeItem</h4> | |
| 87 <b>__writeItem</b>(<i>node</i>) | |
| 88 <p> | |
| 89 Private method to write an entry for a node. | |
| 90 </p><dl> | |
| 91 <dt><i>node</i></dt> | |
| 92 <dd> | |
| 93 reference to the node to be written (BookmarkNode) | |
| 94 </dd> | |
| 95 </dl><a NAME="XbelWriter.write" ID="XbelWriter.write"></a> | |
| 96 <h4>XbelWriter.write</h4> | |
| 97 <b>write</b>(<i>fileNameOrDevice, root</i>) | |
| 98 <p> | |
| 99 Public method to write an XBEL bookmark file. | |
| 100 </p><dl> | |
| 101 <dt><i>fileNameOrDevice</i></dt> | |
| 102 <dd> | |
| 103 name of the file to write (string) | |
| 104 or device to write to (QIODevice) | |
| 105 </dd><dt><i>root</i></dt> | |
| 106 <dd> | |
| 107 root node of the bookmark tree (BookmarkNode) | |
| 108 </dd> | |
| 109 </dl> | |
| 110 <div align="right"><a href="#top">Up</a></div> | |
| 111 <hr /> | |
| 112 </body></html> |
