eric: diff Documentation/Source/eric5.Helpviewer.Bookmarks.XbelReader.html

diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.Helpviewer.Bookmarks.XbelReader.html
--- a/Documentation/Source/eric5.Helpviewer.Bookmarks.XbelReader.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.XbelReader.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Helpviewer.Bookmarks.XbelReader</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#99;&#108;&#97;&#115;&#115; &#116;&#111; &#114;&#101;&#97;&#100; &#88;&#66;&#69;&#76; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#102;&#105;&#108;&#101;&#115;.
+Module implementing a class to read XBEL bookmark files.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,10 +32,10 @@
 <table>
 <tr>
 <td><a href="#XbelReader">XbelReader</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#114;&#101;&#97;&#100;&#101;&#114; &#111;&#98;&#106;&#101;&#99;&#116; &#102;&#111;&#114; &#88;&#66;&#69;&#76; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#102;&#105;&#108;&#101;&#115;.</td>
+<td>Class implementing a reader object for XBEL bookmark files.</td>
 </tr><tr>
 <td><a href="#XmlEntityResolver">XmlEntityResolver</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97;&#110; &#88;&#77;&#76; &#101;&#110;&#116;&#105;&#116;y &#114;&#101;&#115;&#111;&#108;v&#101;&#114; &#102;&#111;&#114; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#102;&#105;&#108;&#101;&#115;.</td>
+<td>Class implementing an XML entity resolver for bookmark files.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -46,7 +46,7 @@
 <a NAME="XbelReader" ID="XbelReader"></a>
 <h2>XbelReader</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#114;&#101;&#97;&#100;&#101;&#114; &#111;&#98;&#106;&#101;&#99;&#116; &#102;&#111;&#114; &#88;&#66;&#69;&#76; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#102;&#105;&#108;&#101;&#115;.
+    Class implementing a reader object for XBEL bookmark files.
 </p>
 <h3>Derived from</h3>
 QXmlStreamReader
@@ -58,118 +58,118 @@
 <table>
 <tr>
 <td><a href="#XbelReader.__init__">XbelReader</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#XbelReader.__readBookmarkNode">__readBookmarkNode</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97;&#110;&#100; &#112;&#97;&#114;&#115;&#101; &#97; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#115;&#117;&#98;&#116;&#114;&#101;&#101;.</td>
+<td>Private method to read and parse a bookmark subtree.</td>
 </tr><tr>
 <td><a href="#XbelReader.__readDescription">__readDescription</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#116;&#104;&#101; &#100;&#101;&#115;&#99; &#101;&#108;&#101;&#109;&#101;&#110;&#116;.</td>
+<td>Private method to read the desc element.</td>
 </tr><tr>
 <td><a href="#XbelReader.__readFolder">__readFolder</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97;&#110;&#100; &#112;&#97;&#114;&#115;&#101; &#97; &#102;&#111;&#108;&#100;&#101;&#114; &#115;&#117;&#98;&#116;&#114;&#101;&#101;.</td>
+<td>Private method to read and parse a folder subtree.</td>
 </tr><tr>
 <td><a href="#XbelReader.__readSeparator">__readSeparator</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97; &#115;&#101;&#112;&#97;&#114;&#97;&#116;&#111;&#114; &#101;&#108;&#101;&#109;&#101;&#110;&#116;.</td>
+<td>Private method to read a separator element.</td>
 </tr><tr>
 <td><a href="#XbelReader.__readTitle">__readTitle</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#116;&#104;&#101; &#116;&#105;&#116;&#108;&#101; &#101;&#108;&#101;&#109;&#101;&#110;&#116;.</td>
+<td>Private method to read the title element.</td>
 </tr><tr>
 <td><a href="#XbelReader.__readXBEL">__readXBEL</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97;&#110;&#100; &#112;&#97;&#114;&#115;&#101; &#116;&#104;&#101; &#88;&#66;&#69;&#76; &#102;&#105;&#108;&#101;.</td>
+<td>Private method to read and parse the XBEL file.</td>
 </tr><tr>
 <td><a href="#XbelReader.__skipUnknownElement">__skipUnknownElement</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#107;&#105;&#112; &#111;v&#101;&#114; &#97;&#108;&#108; &#117;&#110;&#107;&#110;&#111;w&#110; &#101;&#108;&#101;&#109;&#101;&#110;&#116;&#115;.</td>
+<td>Private method to skip over all unknown elements.</td>
 </tr><tr>
 <td><a href="#XbelReader.read">read</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97;&#110; &#88;&#66;&#69;&#76; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#102;&#105;&#108;&#101;.</td>
+<td>Public method to read an XBEL bookmark file.</td>
 </tr>
 </table>
 <a NAME="XbelReader.__init__" ID="XbelReader.__init__"></a>
 <h4>XbelReader (Constructor)</h4>
 <b>XbelReader</b>(<i></i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><a NAME="XbelReader.__readBookmarkNode" ID="XbelReader.__readBookmarkNode"></a>
 <h4>XbelReader.__readBookmarkNode</h4>
 <b>__readBookmarkNode</b>(<i>node</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97;&#110;&#100; &#112;&#97;&#114;&#115;&#101; &#97; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#115;&#117;&#98;&#116;&#114;&#101;&#101;.
+        Private method to read and parse a bookmark subtree.
 </p><dl>
 <dt><i>node</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#110;&#111;&#100;&#101; &#116;&#111; &#97;&#116;&#116;&#97;&#99;&#104; &#116;&#111; (&#66;&#111;&#111;&#107;&#109;&#97;&#114;&#107;&#78;&#111;&#100;&#101;)
+reference to the node to attach to (BookmarkNode)
 </dd>
 </dl><a NAME="XbelReader.__readDescription" ID="XbelReader.__readDescription"></a>
 <h4>XbelReader.__readDescription</h4>
 <b>__readDescription</b>(<i>node</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#116;&#104;&#101; &#100;&#101;&#115;&#99; &#101;&#108;&#101;&#109;&#101;&#110;&#116;.
+        Private method to read the desc element.
 </p><dl>
 <dt><i>node</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#110;&#111;&#100;&#101; &#100;&#101;&#115;&#99; &#98;&#101;&#108;&#111;&#110;&#103;&#115; &#116;&#111; (&#66;&#111;&#111;&#107;&#109;&#97;&#114;&#107;&#78;&#111;&#100;&#101;)
+reference to the bookmark node desc belongs to (BookmarkNode)
 </dd>
 </dl><a NAME="XbelReader.__readFolder" ID="XbelReader.__readFolder"></a>
 <h4>XbelReader.__readFolder</h4>
 <b>__readFolder</b>(<i>node</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97;&#110;&#100; &#112;&#97;&#114;&#115;&#101; &#97; &#102;&#111;&#108;&#100;&#101;&#114; &#115;&#117;&#98;&#116;&#114;&#101;&#101;.
+        Private method to read and parse a folder subtree.
 </p><dl>
 <dt><i>node</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#110;&#111;&#100;&#101; &#116;&#111; &#97;&#116;&#116;&#97;&#99;&#104; &#116;&#111; (&#66;&#111;&#111;&#107;&#109;&#97;&#114;&#107;&#78;&#111;&#100;&#101;)
+reference to the node to attach to (BookmarkNode)
 </dd>
 </dl><a NAME="XbelReader.__readSeparator" ID="XbelReader.__readSeparator"></a>
 <h4>XbelReader.__readSeparator</h4>
 <b>__readSeparator</b>(<i>node</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97; &#115;&#101;&#112;&#97;&#114;&#97;&#116;&#111;&#114; &#101;&#108;&#101;&#109;&#101;&#110;&#116;.
+        Private method to read a separator element.
 </p><dl>
 <dt><i>node</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#110;&#111;&#100;&#101; &#116;&#104;&#101; &#115;&#101;&#112;&#97;&#114;&#97;&#116;&#111;&#114; &#98;&#101;&#108;&#111;&#110;&#103;&#115; &#116;&#111; (&#66;&#111;&#111;&#107;&#109;&#97;&#114;&#107;&#78;&#111;&#100;&#101;)
+reference to the bookmark node the separator belongs to (BookmarkNode)
 </dd>
 </dl><a NAME="XbelReader.__readTitle" ID="XbelReader.__readTitle"></a>
 <h4>XbelReader.__readTitle</h4>
 <b>__readTitle</b>(<i>node</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#116;&#104;&#101; &#116;&#105;&#116;&#108;&#101; &#101;&#108;&#101;&#109;&#101;&#110;&#116;.
+        Private method to read the title element.
 </p><dl>
 <dt><i>node</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#110;&#111;&#100;&#101; &#116;&#105;&#116;&#108;&#101; &#98;&#101;&#108;&#111;&#110;&#103;&#115; &#116;&#111; (&#66;&#111;&#111;&#107;&#109;&#97;&#114;&#107;&#78;&#111;&#100;&#101;)
+reference to the bookmark node title belongs to (BookmarkNode)
 </dd>
 </dl><a NAME="XbelReader.__readXBEL" ID="XbelReader.__readXBEL"></a>
 <h4>XbelReader.__readXBEL</h4>
 <b>__readXBEL</b>(<i>node</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97;&#110;&#100; &#112;&#97;&#114;&#115;&#101; &#116;&#104;&#101; &#88;&#66;&#69;&#76; &#102;&#105;&#108;&#101;.
+        Private method to read and parse the XBEL file.
 </p><dl>
 <dt><i>node</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#110;&#111;&#100;&#101; &#116;&#111; &#97;&#116;&#116;&#97;&#99;&#104; &#116;&#111; (&#66;&#111;&#111;&#107;&#109;&#97;&#114;&#107;&#78;&#111;&#100;&#101;)
+reference to the node to attach to (BookmarkNode)
 </dd>
 </dl><a NAME="XbelReader.__skipUnknownElement" ID="XbelReader.__skipUnknownElement"></a>
 <h4>XbelReader.__skipUnknownElement</h4>
 <b>__skipUnknownElement</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#107;&#105;&#112; &#111;v&#101;&#114; &#97;&#108;&#108; &#117;&#110;&#107;&#110;&#111;w&#110; &#101;&#108;&#101;&#109;&#101;&#110;&#116;&#115;.
+        Private method to skip over all unknown elements.
 </p><a NAME="XbelReader.read" ID="XbelReader.read"></a>
 <h4>XbelReader.read</h4>
 <b>read</b>(<i>fileNameOrDevice</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97;&#110; &#88;&#66;&#69;&#76; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#102;&#105;&#108;&#101;.
+        Public method to read an XBEL bookmark file.
 </p><dl>
 <dt><i>fileNameOrDevice</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#116;&#111; &#114;&#101;&#97;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
-            &#111;&#114; &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#100;&#101;v&#105;&#99;&#101; &#116;&#111; &#114;&#101;&#97;&#100; (&#81;&#73;&#79;&#68;&#101;v&#105;&#99;&#101;)
+name of the file to read (string)
+            or reference to the device to read (QIODevice)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#114;&#111;&#111;&#116; &#110;&#111;&#100;&#101; (&#66;&#111;&#111;&#107;&#109;&#97;&#114;&#107;&#78;&#111;&#100;&#101;)
+reference to the root node (BookmarkNode)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -177,7 +177,7 @@
 <a NAME="XmlEntityResolver" ID="XmlEntityResolver"></a>
 <h2>XmlEntityResolver</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97;&#110; &#88;&#77;&#76; &#101;&#110;&#116;&#105;&#116;y &#114;&#101;&#115;&#111;&#108;v&#101;&#114; &#102;&#111;&#114; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#102;&#105;&#108;&#101;&#115;.
+    Class implementing an XML entity resolver for bookmark files.
 </p>
 <h3>Derived from</h3>
 QXmlStreamEntityResolver
@@ -189,23 +189,23 @@
 <table>
 <tr>
 <td><a href="#XmlEntityResolver.resolveUndeclaredEntity">resolveUndeclaredEntity</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#115;&#111;&#108;v&#101; &#117;&#110;&#100;&#101;&#99;&#108;&#97;&#114;&#101;&#100; &#101;&#110;&#116;&#105;&#116;&#105;&#101;&#115;.</td>
+<td>Public method to resolve undeclared entities.</td>
 </tr>
 </table>
 <a NAME="XmlEntityResolver.resolveUndeclaredEntity" ID="XmlEntityResolver.resolveUndeclaredEntity"></a>
 <h4>XmlEntityResolver.resolveUndeclaredEntity</h4>
 <b>resolveUndeclaredEntity</b>(<i>entity</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#115;&#111;&#108;v&#101; &#117;&#110;&#100;&#101;&#99;&#108;&#97;&#114;&#101;&#100; &#101;&#110;&#116;&#105;&#116;&#105;&#101;&#115;.
+        Public method to resolve undeclared entities.
 </p><dl>
 <dt><i>entity</i></dt>
 <dd>
-&#101;&#110;&#116;&#105;&#116;y &#116;&#111; &#98;&#101; &#114;&#101;&#115;&#111;&#108;v&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+entity to be resolved (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#114;&#101;&#115;&#111;&#108;v&#101;&#100; &#101;&#110;&#116;&#105;&#116;y (&#115;&#116;&#114;&#105;&#110;&#103;)
+resolved entity (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>