--- a/eric6/Documentation/Source/eric6.WebBrowser.Bookmarks.XbelReader.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.WebBrowser.Bookmarks.XbelReader.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,217 +18,287 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.WebBrowser.Bookmarks.XbelReader</h1> + <p> Module implementing a class to read XBEL bookmark files. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#XbelReader">XbelReader</a></td> <td>Class implementing a reader object for XBEL bookmark files.</td> -</tr><tr> +</tr> +<tr> <td><a href="#XmlEntityResolver">XmlEntityResolver</a></td> <td>Class implementing an XML entity resolver for bookmark files.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="XbelReader" ID="XbelReader"></a> <h2>XbelReader</h2> + <p> Class implementing a reader object for XBEL bookmark files. </p> <h3>Derived from</h3> QXmlStreamReader <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="#XbelReader.__init__">XbelReader</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#XbelReader.__readBookmarkNode">__readBookmarkNode</a></td> <td>Private method to read and parse a bookmark subtree.</td> -</tr><tr> +</tr> +<tr> <td><a href="#XbelReader.__readDescription">__readDescription</a></td> <td>Private method to read the desc element.</td> -</tr><tr> +</tr> +<tr> <td><a href="#XbelReader.__readFolder">__readFolder</a></td> <td>Private method to read and parse a folder subtree.</td> -</tr><tr> +</tr> +<tr> <td><a href="#XbelReader.__readInfo">__readInfo</a></td> <td>Private method to read and parse an info subtree.</td> -</tr><tr> +</tr> +<tr> <td><a href="#XbelReader.__readSeparator">__readSeparator</a></td> <td>Private method to read a separator element.</td> -</tr><tr> +</tr> +<tr> <td><a href="#XbelReader.__readTitle">__readTitle</a></td> <td>Private method to read the title element.</td> -</tr><tr> +</tr> +<tr> <td><a href="#XbelReader.__readXBEL">__readXBEL</a></td> <td>Private method to read and parse the XBEL file.</td> -</tr><tr> +</tr> +<tr> <td><a href="#XbelReader.__skipUnknownElement">__skipUnknownElement</a></td> <td>Private method to skip over all unknown elements.</td> -</tr><tr> +</tr> +<tr> <td><a href="#XbelReader.read">read</a></td> <td>Public method to read an XBEL bookmark file.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="XbelReader.__init__" ID="XbelReader.__init__"></a> <h4>XbelReader (Constructor)</h4> <b>XbelReader</b>(<i></i>) + <p> Constructor -</p><a NAME="XbelReader.__readBookmarkNode" ID="XbelReader.__readBookmarkNode"></a> +</p> +<a NAME="XbelReader.__readBookmarkNode" ID="XbelReader.__readBookmarkNode"></a> <h4>XbelReader.__readBookmarkNode</h4> <b>__readBookmarkNode</b>(<i>node</i>) + <p> Private method to read and parse a bookmark subtree. -</p><dl> +</p> +<dl> + <dt><i>node</i></dt> <dd> reference to the node to attach to (BookmarkNode) </dd> -</dl><a NAME="XbelReader.__readDescription" ID="XbelReader.__readDescription"></a> +</dl> +<a NAME="XbelReader.__readDescription" ID="XbelReader.__readDescription"></a> <h4>XbelReader.__readDescription</h4> <b>__readDescription</b>(<i>node</i>) + <p> Private method to read the desc element. -</p><dl> +</p> +<dl> + <dt><i>node</i></dt> <dd> reference to the bookmark node desc belongs to (BookmarkNode) </dd> -</dl><a NAME="XbelReader.__readFolder" ID="XbelReader.__readFolder"></a> +</dl> +<a NAME="XbelReader.__readFolder" ID="XbelReader.__readFolder"></a> <h4>XbelReader.__readFolder</h4> <b>__readFolder</b>(<i>node</i>) + <p> Private method to read and parse a folder subtree. -</p><dl> +</p> +<dl> + <dt><i>node</i></dt> <dd> reference to the node to attach to (BookmarkNode) </dd> -</dl><a NAME="XbelReader.__readInfo" ID="XbelReader.__readInfo"></a> +</dl> +<a NAME="XbelReader.__readInfo" ID="XbelReader.__readInfo"></a> <h4>XbelReader.__readInfo</h4> <b>__readInfo</b>(<i></i>) + <p> Private method to read and parse an info subtree. -</p><a NAME="XbelReader.__readSeparator" ID="XbelReader.__readSeparator"></a> +</p> +<a NAME="XbelReader.__readSeparator" ID="XbelReader.__readSeparator"></a> <h4>XbelReader.__readSeparator</h4> <b>__readSeparator</b>(<i>node</i>) + <p> Private method to read a separator element. -</p><dl> +</p> +<dl> + <dt><i>node</i></dt> <dd> reference to the bookmark node the separator belongs to (BookmarkNode) </dd> -</dl><a NAME="XbelReader.__readTitle" ID="XbelReader.__readTitle"></a> +</dl> +<a NAME="XbelReader.__readTitle" ID="XbelReader.__readTitle"></a> <h4>XbelReader.__readTitle</h4> <b>__readTitle</b>(<i>node</i>) + <p> Private method to read the title element. -</p><dl> +</p> +<dl> + <dt><i>node</i></dt> <dd> reference to the bookmark node title belongs to (BookmarkNode) </dd> -</dl><a NAME="XbelReader.__readXBEL" ID="XbelReader.__readXBEL"></a> +</dl> +<a NAME="XbelReader.__readXBEL" ID="XbelReader.__readXBEL"></a> <h4>XbelReader.__readXBEL</h4> <b>__readXBEL</b>(<i>node</i>) + <p> Private method to read and parse the XBEL file. -</p><dl> +</p> +<dl> + <dt><i>node</i></dt> <dd> reference to the node to attach to (BookmarkNode) </dd> -</dl><a NAME="XbelReader.__skipUnknownElement" ID="XbelReader.__skipUnknownElement"></a> +</dl> +<a NAME="XbelReader.__skipUnknownElement" ID="XbelReader.__skipUnknownElement"></a> <h4>XbelReader.__skipUnknownElement</h4> <b>__skipUnknownElement</b>(<i></i>) + <p> Private method to skip over all unknown elements. -</p><a NAME="XbelReader.read" ID="XbelReader.read"></a> +</p> +<a NAME="XbelReader.read" ID="XbelReader.read"></a> <h4>XbelReader.read</h4> <b>read</b>(<i>fileNameOrDevice</i>) + <p> Public method to read an XBEL bookmark file. -</p><dl> +</p> +<dl> + <dt><i>fileNameOrDevice</i></dt> <dd> name of the file to read (string) or reference to the device to read (QIODevice) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> reference to the root node (BookmarkNode) </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="XmlEntityResolver" ID="XmlEntityResolver"></a> <h2>XmlEntityResolver</h2> + <p> Class implementing an XML entity resolver for bookmark files. </p> <h3>Derived from</h3> QXmlStreamEntityResolver <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="#XmlEntityResolver.resolveUndeclaredEntity">resolveUndeclaredEntity</a></td> <td>Public method to resolve undeclared entities.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="XmlEntityResolver.resolveUndeclaredEntity" ID="XmlEntityResolver.resolveUndeclaredEntity"></a> <h4>XmlEntityResolver.resolveUndeclaredEntity</h4> <b>resolveUndeclaredEntity</b>(<i>entity</i>) + <p> Public method to resolve undeclared entities. -</p><dl> +</p> +<dl> + <dt><i>entity</i></dt> <dd> entity to be resolved (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> resolved entity (string)