Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.WebBrowser.Bookmarks.XbelReader.html
Documentation/Source/eric6.WebBrowser.Bookmarks.XbelReader.html
- changeset 4918
- 71caf42a13d8
equal
deleted
inserted
replaced
| 4917:682750cc7bd5 | 4918:71caf42a13d8 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.WebBrowser.Bookmarks.XbelReader</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.WebBrowser.Bookmarks.XbelReader</h1> | |
| 23 <p> | |
| 24 Module implementing a class to read XBEL bookmark files. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#XbelReader">XbelReader</a></td> | |
| 34 <td>Class implementing a reader object for XBEL bookmark files.</td> | |
| 35 </tr><tr> | |
| 36 <td><a href="#XmlEntityResolver">XmlEntityResolver</a></td> | |
| 37 <td>Class implementing an XML entity resolver for bookmark files.</td> | |
| 38 </tr> | |
| 39 </table> | |
| 40 <h3>Functions</h3> | |
| 41 <table> | |
| 42 <tr><td>None</td></tr> | |
| 43 </table> | |
| 44 <hr /><hr /> | |
| 45 <a NAME="XbelReader" ID="XbelReader"></a> | |
| 46 <h2>XbelReader</h2> | |
| 47 <p> | |
| 48 Class implementing a reader object for XBEL bookmark files. | |
| 49 </p> | |
| 50 <h3>Derived from</h3> | |
| 51 QXmlStreamReader | |
| 52 <h3>Class Attributes</h3> | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Methods</h3> | |
| 61 <table> | |
| 62 <tr> | |
| 63 <td><a href="#XbelReader.__init__">XbelReader</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#XbelReader.__readBookmarkNode">__readBookmarkNode</a></td> | |
| 67 <td>Private method to read and parse a bookmark subtree.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#XbelReader.__readDescription">__readDescription</a></td> | |
| 70 <td>Private method to read the desc element.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#XbelReader.__readFolder">__readFolder</a></td> | |
| 73 <td>Private method to read and parse a folder subtree.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#XbelReader.__readInfo">__readInfo</a></td> | |
| 76 <td>Private method to read and parse an info subtree.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#XbelReader.__readSeparator">__readSeparator</a></td> | |
| 79 <td>Private method to read a separator element.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#XbelReader.__readTitle">__readTitle</a></td> | |
| 82 <td>Private method to read the title element.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#XbelReader.__readXBEL">__readXBEL</a></td> | |
| 85 <td>Private method to read and parse the XBEL file.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#XbelReader.__skipUnknownElement">__skipUnknownElement</a></td> | |
| 88 <td>Private method to skip over all unknown elements.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#XbelReader.read">read</a></td> | |
| 91 <td>Public method to read an XBEL bookmark file.</td> | |
| 92 </tr> | |
| 93 </table> | |
| 94 <h3>Static Methods</h3> | |
| 95 <table> | |
| 96 <tr><td>None</td></tr> | |
| 97 </table> | |
| 98 <a NAME="XbelReader.__init__" ID="XbelReader.__init__"></a> | |
| 99 <h4>XbelReader (Constructor)</h4> | |
| 100 <b>XbelReader</b>(<i></i>) | |
| 101 <p> | |
| 102 Constructor | |
| 103 </p><a NAME="XbelReader.__readBookmarkNode" ID="XbelReader.__readBookmarkNode"></a> | |
| 104 <h4>XbelReader.__readBookmarkNode</h4> | |
| 105 <b>__readBookmarkNode</b>(<i>node</i>) | |
| 106 <p> | |
| 107 Private method to read and parse a bookmark subtree. | |
| 108 </p><dl> | |
| 109 <dt><i>node</i></dt> | |
| 110 <dd> | |
| 111 reference to the node to attach to (BookmarkNode) | |
| 112 </dd> | |
| 113 </dl><a NAME="XbelReader.__readDescription" ID="XbelReader.__readDescription"></a> | |
| 114 <h4>XbelReader.__readDescription</h4> | |
| 115 <b>__readDescription</b>(<i>node</i>) | |
| 116 <p> | |
| 117 Private method to read the desc element. | |
| 118 </p><dl> | |
| 119 <dt><i>node</i></dt> | |
| 120 <dd> | |
| 121 reference to the bookmark node desc belongs to | |
| 122 (BookmarkNode) | |
| 123 </dd> | |
| 124 </dl><a NAME="XbelReader.__readFolder" ID="XbelReader.__readFolder"></a> | |
| 125 <h4>XbelReader.__readFolder</h4> | |
| 126 <b>__readFolder</b>(<i>node</i>) | |
| 127 <p> | |
| 128 Private method to read and parse a folder subtree. | |
| 129 </p><dl> | |
| 130 <dt><i>node</i></dt> | |
| 131 <dd> | |
| 132 reference to the node to attach to (BookmarkNode) | |
| 133 </dd> | |
| 134 </dl><a NAME="XbelReader.__readInfo" ID="XbelReader.__readInfo"></a> | |
| 135 <h4>XbelReader.__readInfo</h4> | |
| 136 <b>__readInfo</b>(<i></i>) | |
| 137 <p> | |
| 138 Private method to read and parse an info subtree. | |
| 139 </p><a NAME="XbelReader.__readSeparator" ID="XbelReader.__readSeparator"></a> | |
| 140 <h4>XbelReader.__readSeparator</h4> | |
| 141 <b>__readSeparator</b>(<i>node</i>) | |
| 142 <p> | |
| 143 Private method to read a separator element. | |
| 144 </p><dl> | |
| 145 <dt><i>node</i></dt> | |
| 146 <dd> | |
| 147 reference to the bookmark node the separator belongs to | |
| 148 (BookmarkNode) | |
| 149 </dd> | |
| 150 </dl><a NAME="XbelReader.__readTitle" ID="XbelReader.__readTitle"></a> | |
| 151 <h4>XbelReader.__readTitle</h4> | |
| 152 <b>__readTitle</b>(<i>node</i>) | |
| 153 <p> | |
| 154 Private method to read the title element. | |
| 155 </p><dl> | |
| 156 <dt><i>node</i></dt> | |
| 157 <dd> | |
| 158 reference to the bookmark node title belongs to | |
| 159 (BookmarkNode) | |
| 160 </dd> | |
| 161 </dl><a NAME="XbelReader.__readXBEL" ID="XbelReader.__readXBEL"></a> | |
| 162 <h4>XbelReader.__readXBEL</h4> | |
| 163 <b>__readXBEL</b>(<i>node</i>) | |
| 164 <p> | |
| 165 Private method to read and parse the XBEL file. | |
| 166 </p><dl> | |
| 167 <dt><i>node</i></dt> | |
| 168 <dd> | |
| 169 reference to the node to attach to (BookmarkNode) | |
| 170 </dd> | |
| 171 </dl><a NAME="XbelReader.__skipUnknownElement" ID="XbelReader.__skipUnknownElement"></a> | |
| 172 <h4>XbelReader.__skipUnknownElement</h4> | |
| 173 <b>__skipUnknownElement</b>(<i></i>) | |
| 174 <p> | |
| 175 Private method to skip over all unknown elements. | |
| 176 </p><a NAME="XbelReader.read" ID="XbelReader.read"></a> | |
| 177 <h4>XbelReader.read</h4> | |
| 178 <b>read</b>(<i>fileNameOrDevice</i>) | |
| 179 <p> | |
| 180 Public method to read an XBEL bookmark file. | |
| 181 </p><dl> | |
| 182 <dt><i>fileNameOrDevice</i></dt> | |
| 183 <dd> | |
| 184 name of the file to read (string) | |
| 185 or reference to the device to read (QIODevice) | |
| 186 </dd> | |
| 187 </dl><dl> | |
| 188 <dt>Returns:</dt> | |
| 189 <dd> | |
| 190 reference to the root node (BookmarkNode) | |
| 191 </dd> | |
| 192 </dl> | |
| 193 <div align="right"><a href="#top">Up</a></div> | |
| 194 <hr /><hr /> | |
| 195 <a NAME="XmlEntityResolver" ID="XmlEntityResolver"></a> | |
| 196 <h2>XmlEntityResolver</h2> | |
| 197 <p> | |
| 198 Class implementing an XML entity resolver for bookmark files. | |
| 199 </p> | |
| 200 <h3>Derived from</h3> | |
| 201 QXmlStreamEntityResolver | |
| 202 <h3>Class Attributes</h3> | |
| 203 <table> | |
| 204 <tr><td>None</td></tr> | |
| 205 </table> | |
| 206 <h3>Class Methods</h3> | |
| 207 <table> | |
| 208 <tr><td>None</td></tr> | |
| 209 </table> | |
| 210 <h3>Methods</h3> | |
| 211 <table> | |
| 212 <tr> | |
| 213 <td><a href="#XmlEntityResolver.resolveUndeclaredEntity">resolveUndeclaredEntity</a></td> | |
| 214 <td>Public method to resolve undeclared entities.</td> | |
| 215 </tr> | |
| 216 </table> | |
| 217 <h3>Static Methods</h3> | |
| 218 <table> | |
| 219 <tr><td>None</td></tr> | |
| 220 </table> | |
| 221 <a NAME="XmlEntityResolver.resolveUndeclaredEntity" ID="XmlEntityResolver.resolveUndeclaredEntity"></a> | |
| 222 <h4>XmlEntityResolver.resolveUndeclaredEntity</h4> | |
| 223 <b>resolveUndeclaredEntity</b>(<i>entity</i>) | |
| 224 <p> | |
| 225 Public method to resolve undeclared entities. | |
| 226 </p><dl> | |
| 227 <dt><i>entity</i></dt> | |
| 228 <dd> | |
| 229 entity to be resolved (string) | |
| 230 </dd> | |
| 231 </dl><dl> | |
| 232 <dt>Returns:</dt> | |
| 233 <dd> | |
| 234 resolved entity (string) | |
| 235 </dd> | |
| 236 </dl> | |
| 237 <div align="right"><a href="#top">Up</a></div> | |
| 238 <hr /> | |
| 239 </body></html> |
