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