src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.NsHtmlWriter.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10436
f6881d10e995
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.NsHtmlWriter.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,215 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.WebBrowser.Bookmarks.NsHtmlWriter</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.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 />
+<a NAME="NsHtmlWriter" ID="NsHtmlWriter"></a>
+<h2>NsHtmlWriter</h2>
+
+<p>
+    Class implementing a writer object to generate Netscape HTML bookmark
+    files.
+</p>
+<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>
+<td><a href="#NsHtmlWriter.__write">__write</a></td>
+<td>Private method to write an Netscape HTML bookmark file.</td>
+</tr>
+<tr>
+<td><a href="#NsHtmlWriter.__writeBookmark">__writeBookmark</a></td>
+<td>Private method to write a bookmark node.</td>
+</tr>
+<tr>
+<td><a href="#NsHtmlWriter.__writeFolder">__writeFolder</a></td>
+<td>Private method to write a bookmark node.</td>
+</tr>
+<tr>
+<td><a href="#NsHtmlWriter.__writeItem">__writeItem</a></td>
+<td>Private method to write an entry for a node.</td>
+</tr>
+<tr>
+<td><a href="#NsHtmlWriter.__writeSeparator">__writeSeparator</a></td>
+<td>Private method to write a separator.</td>
+</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>
+<h4>NsHtmlWriter.__write</h4>
+<b>__write</b>(<i>root</i>)
+
+<p>
+        Private method to write an Netscape HTML bookmark file.
+</p>
+<dl>
+
+<dt><i>root</i></dt>
+<dd>
+root node of the bookmark tree (BookmarkNode)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating success (boolean)
+</dd>
+</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>
+
+<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.__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>
+
+<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>
+root node of the bookmark tree (BookmarkNode)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating success (boolean)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial