--- a/eric6/Documentation/Source/eric6.WebBrowser.Bookmarks.XbelWriter.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.WebBrowser.Bookmarks.XbelWriter.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,107 +18,140 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.WebBrowser.Bookmarks.XbelWriter</h1> + <p> Module implementing a class to write XBEL bookmark files. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#XbelWriter">XbelWriter</a></td> <td>Class implementing a writer object to generate XBEL bookmark files.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="XbelWriter" ID="XbelWriter"></a> <h2>XbelWriter</h2> + <p> Class implementing a writer object to generate XBEL bookmark files. </p> <h3>Derived from</h3> QXmlStreamWriter <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#XbelWriter.__init__">XbelWriter</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#XbelWriter.__write">__write</a></td> <td>Private method to write an XBEL bookmark file.</td> -</tr><tr> +</tr> +<tr> <td><a href="#XbelWriter.__writeItem">__writeItem</a></td> <td>Private method to write an entry for a node.</td> -</tr><tr> +</tr> +<tr> <td><a href="#XbelWriter.write">write</a></td> <td>Public method to write an XBEL bookmark file.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="XbelWriter.__init__" ID="XbelWriter.__init__"></a> <h4>XbelWriter (Constructor)</h4> <b>XbelWriter</b>(<i></i>) + <p> Constructor -</p><a NAME="XbelWriter.__write" ID="XbelWriter.__write"></a> +</p> +<a NAME="XbelWriter.__write" ID="XbelWriter.__write"></a> <h4>XbelWriter.__write</h4> <b>__write</b>(<i>root</i>) + <p> Private method to write an XBEL bookmark file. -</p><dl> +</p> +<dl> + <dt><i>root</i></dt> <dd> root node of the bookmark tree (BookmarkNode) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating success (boolean) </dd> -</dl><a NAME="XbelWriter.__writeItem" ID="XbelWriter.__writeItem"></a> +</dl> +<a NAME="XbelWriter.__writeItem" ID="XbelWriter.__writeItem"></a> <h4>XbelWriter.__writeItem</h4> <b>__writeItem</b>(<i>node</i>) + <p> Private method to write an entry for a node. -</p><dl> +</p> +<dl> + <dt><i>node</i></dt> <dd> reference to the node to be written (BookmarkNode) </dd> -</dl><a NAME="XbelWriter.write" ID="XbelWriter.write"></a> +</dl> +<a NAME="XbelWriter.write" ID="XbelWriter.write"></a> <h4>XbelWriter.write</h4> <b>write</b>(<i>fileNameOrDevice, root</i>) + <p> Public method to write an XBEL bookmark file. -</p><dl> +</p> +<dl> + <dt><i>fileNameOrDevice</i></dt> <dd> name of the file to write (string) or device to write to (QIODevice) -</dd><dt><i>root</i></dt> +</dd> +<dt><i>root</i></dt> <dd> root node of the bookmark tree (BookmarkNode) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating success (boolean)