src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.XbelWriter.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.XbelWriter.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,148 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.WebBrowser.Bookmarks.XbelWriter</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.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 />
+<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>
+<td><a href="#XbelWriter.__write">__write</a></td>
+<td>Private method to write an XBEL bookmark file.</td>
+</tr>
+<tr>
+<td><a href="#XbelWriter.__writeItem">__writeItem</a></td>
+<td>Private method to write an entry for a node.</td>
+</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>
+<h4>XbelWriter.__write</h4>
+<b>__write</b>(<i>root</i>)
+
+<p>
+        Private method to write an XBEL 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="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>
+
+<dt><i>node</i></dt>
+<dd>
+reference to the node to be written (BookmarkNode)
+</dd>
+</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>
+
+<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