--- a/eric6/Documentation/Source/eric6.WebBrowser.Bookmarks.NsHtmlWriter.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.WebBrowser.Bookmarks.NsHtmlWriter.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,29 +18,37 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.WebBrowser.Bookmarks.NsHtmlWriter</h1> + <p> Module implementing a class to write Netscape HTML bookmark files. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#NsHtmlWriter">NsHtmlWriter</a></td> <td>Class implementing a writer object to generate Netscape HTML bookmark files.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="NsHtmlWriter" ID="NsHtmlWriter"></a> <h2>NsHtmlWriter</h2> + <p> Class implementing a writer object to generate Netscape HTML bookmark files. @@ -48,126 +56,169 @@ <h3>Derived from</h3> QObject <h3>Class Attributes</h3> + <table> <tr><td>indentSize</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#NsHtmlWriter.__init__">NsHtmlWriter</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#NsHtmlWriter.__write">__write</a></td> <td>Private method to write an Netscape HTML bookmark file.</td> -</tr><tr> +</tr> +<tr> <td><a href="#NsHtmlWriter.__writeBookmark">__writeBookmark</a></td> <td>Private method to write a bookmark node.</td> -</tr><tr> +</tr> +<tr> <td><a href="#NsHtmlWriter.__writeFolder">__writeFolder</a></td> <td>Private method to write a bookmark node.</td> -</tr><tr> +</tr> +<tr> <td><a href="#NsHtmlWriter.__writeItem">__writeItem</a></td> <td>Private method to write an entry for a node.</td> -</tr><tr> +</tr> +<tr> <td><a href="#NsHtmlWriter.__writeSeparator">__writeSeparator</a></td> <td>Private method to write a separator.</td> -</tr><tr> +</tr> +<tr> <td><a href="#NsHtmlWriter.write">write</a></td> <td>Public method to write an Netscape HTML bookmark file.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="NsHtmlWriter.__init__" ID="NsHtmlWriter.__init__"></a> <h4>NsHtmlWriter (Constructor)</h4> <b>NsHtmlWriter</b>(<i></i>) + <p> Constructor -</p><a NAME="NsHtmlWriter.__write" ID="NsHtmlWriter.__write"></a> +</p> +<a NAME="NsHtmlWriter.__write" ID="NsHtmlWriter.__write"></a> <h4>NsHtmlWriter.__write</h4> <b>__write</b>(<i>root</i>) + <p> Private method to write an Netscape HTML 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="NsHtmlWriter.__writeBookmark" ID="NsHtmlWriter.__writeBookmark"></a> +</dl> +<a NAME="NsHtmlWriter.__writeBookmark" ID="NsHtmlWriter.__writeBookmark"></a> <h4>NsHtmlWriter.__writeBookmark</h4> <b>__writeBookmark</b>(<i>node, indent</i>) + <p> Private method to write a bookmark node. -</p><dl> -<dt><i>node</i></dt> -<dd> -reference to the node to be written (BookmarkNode) -</dd><dt><i>indent</i></dt> -<dd> -size of the indentation (integer) -</dd> -</dl><a NAME="NsHtmlWriter.__writeFolder" ID="NsHtmlWriter.__writeFolder"></a> -<h4>NsHtmlWriter.__writeFolder</h4> -<b>__writeFolder</b>(<i>node, indent</i>) -<p> - Private method to write a bookmark node. -</p><dl> +</p> +<dl> + <dt><i>node</i></dt> <dd> reference to the node to be written (BookmarkNode) -</dd><dt><i>indent</i></dt> +</dd> +<dt><i>indent</i></dt> <dd> size of the indentation (integer) </dd> -</dl><a NAME="NsHtmlWriter.__writeItem" ID="NsHtmlWriter.__writeItem"></a> -<h4>NsHtmlWriter.__writeItem</h4> -<b>__writeItem</b>(<i>node, indent</i>) +</dl> +<a NAME="NsHtmlWriter.__writeFolder" ID="NsHtmlWriter.__writeFolder"></a> +<h4>NsHtmlWriter.__writeFolder</h4> +<b>__writeFolder</b>(<i>node, indent</i>) + <p> - Private method to write an entry for a node. -</p><dl> + Private method to write a bookmark node. +</p> +<dl> + <dt><i>node</i></dt> <dd> reference to the node to be written (BookmarkNode) -</dd><dt><i>indent</i></dt> -<dd> -size of the indentation (integer) </dd> -</dl><a NAME="NsHtmlWriter.__writeSeparator" ID="NsHtmlWriter.__writeSeparator"></a> -<h4>NsHtmlWriter.__writeSeparator</h4> -<b>__writeSeparator</b>(<i>indent</i>) -<p> - Private method to write a separator. -</p><dl> <dt><i>indent</i></dt> <dd> size of the indentation (integer) </dd> -</dl><a NAME="NsHtmlWriter.write" ID="NsHtmlWriter.write"></a> +</dl> +<a NAME="NsHtmlWriter.__writeItem" ID="NsHtmlWriter.__writeItem"></a> +<h4>NsHtmlWriter.__writeItem</h4> +<b>__writeItem</b>(<i>node, indent</i>) + +<p> + Private method to write an entry for a node. +</p> +<dl> + +<dt><i>node</i></dt> +<dd> +reference to the node to be written (BookmarkNode) +</dd> +<dt><i>indent</i></dt> +<dd> +size of the indentation (integer) +</dd> +</dl> +<a NAME="NsHtmlWriter.__writeSeparator" ID="NsHtmlWriter.__writeSeparator"></a> +<h4>NsHtmlWriter.__writeSeparator</h4> +<b>__writeSeparator</b>(<i>indent</i>) + +<p> + Private method to write a separator. +</p> +<dl> + +<dt><i>indent</i></dt> +<dd> +size of the indentation (integer) +</dd> +</dl> +<a NAME="NsHtmlWriter.write" ID="NsHtmlWriter.write"></a> <h4>NsHtmlWriter.write</h4> <b>write</b>(<i>fileNameOrDevice, root</i>) + <p> Public method to write an Netscape HTML 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)