Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.WebBrowser.Bookmarks.XbelWriter.html
eric6/Documentation/Source/eric6.WebBrowser.Bookmarks.XbelWriter.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7989
- a21d673a8f99
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.WebBrowser.Bookmarks.XbelWriter</h1> | 23 <h1>eric6.WebBrowser.Bookmarks.XbelWriter</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing a class to write XBEL bookmark files. | 26 Module implementing a class to write XBEL bookmark files. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#XbelWriter">XbelWriter</a></td> | 38 <td><a href="#XbelWriter">XbelWriter</a></td> |
| 34 <td>Class implementing a writer object to generate XBEL bookmark files.</td> | 39 <td>Class implementing a writer object to generate XBEL bookmark files.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 43 | |
| 38 <table> | 44 <table> |
| 39 <tr><td>None</td></tr> | 45 <tr><td>None</td></tr> |
| 40 </table> | 46 </table> |
| 41 <hr /><hr /> | 47 <hr /> |
| 48 <hr /> | |
| 42 <a NAME="XbelWriter" ID="XbelWriter"></a> | 49 <a NAME="XbelWriter" ID="XbelWriter"></a> |
| 43 <h2>XbelWriter</h2> | 50 <h2>XbelWriter</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing a writer object to generate XBEL bookmark files. | 53 Class implementing a writer object to generate XBEL bookmark files. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 QXmlStreamWriter | 56 QXmlStreamWriter |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>None</td></tr> | 60 <tr><td>None</td></tr> |
| 52 </table> | 61 </table> |
| 53 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | |
| 54 <table> | 64 <table> |
| 55 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 56 </table> | 66 </table> |
| 57 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 68 | |
| 58 <table> | 69 <table> |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#XbelWriter.__init__">XbelWriter</a></td> | 72 <td><a href="#XbelWriter.__init__">XbelWriter</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#XbelWriter.__write">__write</a></td> | 76 <td><a href="#XbelWriter.__write">__write</a></td> |
| 64 <td>Private method to write an XBEL bookmark file.</td> | 77 <td>Private method to write an XBEL bookmark file.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#XbelWriter.__writeItem">__writeItem</a></td> | 80 <td><a href="#XbelWriter.__writeItem">__writeItem</a></td> |
| 67 <td>Private method to write an entry for a node.</td> | 81 <td>Private method to write an entry for a node.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#XbelWriter.write">write</a></td> | 84 <td><a href="#XbelWriter.write">write</a></td> |
| 70 <td>Public method to write an XBEL bookmark file.</td> | 85 <td>Public method to write an XBEL bookmark file.</td> |
| 71 </tr> | 86 </tr> |
| 72 </table> | 87 </table> |
| 73 <h3>Static Methods</h3> | 88 <h3>Static Methods</h3> |
| 89 | |
| 74 <table> | 90 <table> |
| 75 <tr><td>None</td></tr> | 91 <tr><td>None</td></tr> |
| 76 </table> | 92 </table> |
| 93 | |
| 77 <a NAME="XbelWriter.__init__" ID="XbelWriter.__init__"></a> | 94 <a NAME="XbelWriter.__init__" ID="XbelWriter.__init__"></a> |
| 78 <h4>XbelWriter (Constructor)</h4> | 95 <h4>XbelWriter (Constructor)</h4> |
| 79 <b>XbelWriter</b>(<i></i>) | 96 <b>XbelWriter</b>(<i></i>) |
| 97 | |
| 80 <p> | 98 <p> |
| 81 Constructor | 99 Constructor |
| 82 </p><a NAME="XbelWriter.__write" ID="XbelWriter.__write"></a> | 100 </p> |
| 101 <a NAME="XbelWriter.__write" ID="XbelWriter.__write"></a> | |
| 83 <h4>XbelWriter.__write</h4> | 102 <h4>XbelWriter.__write</h4> |
| 84 <b>__write</b>(<i>root</i>) | 103 <b>__write</b>(<i>root</i>) |
| 104 | |
| 85 <p> | 105 <p> |
| 86 Private method to write an XBEL bookmark file. | 106 Private method to write an XBEL bookmark file. |
| 87 </p><dl> | 107 </p> |
| 108 <dl> | |
| 109 | |
| 88 <dt><i>root</i></dt> | 110 <dt><i>root</i></dt> |
| 89 <dd> | 111 <dd> |
| 90 root node of the bookmark tree (BookmarkNode) | 112 root node of the bookmark tree (BookmarkNode) |
| 91 </dd> | 113 </dd> |
| 92 </dl><dl> | 114 </dl> |
| 115 <dl> | |
| 93 <dt>Returns:</dt> | 116 <dt>Returns:</dt> |
| 94 <dd> | 117 <dd> |
| 95 flag indicating success (boolean) | 118 flag indicating success (boolean) |
| 96 </dd> | 119 </dd> |
| 97 </dl><a NAME="XbelWriter.__writeItem" ID="XbelWriter.__writeItem"></a> | 120 </dl> |
| 121 <a NAME="XbelWriter.__writeItem" ID="XbelWriter.__writeItem"></a> | |
| 98 <h4>XbelWriter.__writeItem</h4> | 122 <h4>XbelWriter.__writeItem</h4> |
| 99 <b>__writeItem</b>(<i>node</i>) | 123 <b>__writeItem</b>(<i>node</i>) |
| 124 | |
| 100 <p> | 125 <p> |
| 101 Private method to write an entry for a node. | 126 Private method to write an entry for a node. |
| 102 </p><dl> | 127 </p> |
| 128 <dl> | |
| 129 | |
| 103 <dt><i>node</i></dt> | 130 <dt><i>node</i></dt> |
| 104 <dd> | 131 <dd> |
| 105 reference to the node to be written (BookmarkNode) | 132 reference to the node to be written (BookmarkNode) |
| 106 </dd> | 133 </dd> |
| 107 </dl><a NAME="XbelWriter.write" ID="XbelWriter.write"></a> | 134 </dl> |
| 135 <a NAME="XbelWriter.write" ID="XbelWriter.write"></a> | |
| 108 <h4>XbelWriter.write</h4> | 136 <h4>XbelWriter.write</h4> |
| 109 <b>write</b>(<i>fileNameOrDevice, root</i>) | 137 <b>write</b>(<i>fileNameOrDevice, root</i>) |
| 138 | |
| 110 <p> | 139 <p> |
| 111 Public method to write an XBEL bookmark file. | 140 Public method to write an XBEL bookmark file. |
| 112 </p><dl> | 141 </p> |
| 142 <dl> | |
| 143 | |
| 113 <dt><i>fileNameOrDevice</i></dt> | 144 <dt><i>fileNameOrDevice</i></dt> |
| 114 <dd> | 145 <dd> |
| 115 name of the file to write (string) | 146 name of the file to write (string) |
| 116 or device to write to (QIODevice) | 147 or device to write to (QIODevice) |
| 117 </dd><dt><i>root</i></dt> | 148 </dd> |
| 149 <dt><i>root</i></dt> | |
| 118 <dd> | 150 <dd> |
| 119 root node of the bookmark tree (BookmarkNode) | 151 root node of the bookmark tree (BookmarkNode) |
| 120 </dd> | 152 </dd> |
| 121 </dl><dl> | 153 </dl> |
| 154 <dl> | |
| 122 <dt>Returns:</dt> | 155 <dt>Returns:</dt> |
| 123 <dd> | 156 <dd> |
| 124 flag indicating success (boolean) | 157 flag indicating success (boolean) |
| 125 </dd> | 158 </dd> |
| 126 </dl> | 159 </dl> |
