Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.WebBrowser.Bookmarks.XbelReader.html

eric6/Documentation/Source/eric6.WebBrowser.Bookmarks.XbelReader.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.Bookmarks.XbelReader</h1> 23 <h1>eric6.WebBrowser.Bookmarks.XbelReader</h1>
24
23 <p> 25 <p>
24 Module implementing a class to read XBEL bookmark files. 26 Module implementing a class to read XBEL bookmark files.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#XbelReader">XbelReader</a></td> 38 <td><a href="#XbelReader">XbelReader</a></td>
34 <td>Class implementing a reader object for XBEL bookmark files.</td> 39 <td>Class implementing a reader object for XBEL bookmark files.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#XmlEntityResolver">XmlEntityResolver</a></td> 42 <td><a href="#XmlEntityResolver">XmlEntityResolver</a></td>
37 <td>Class implementing an XML entity resolver for bookmark files.</td> 43 <td>Class implementing an XML entity resolver for bookmark files.</td>
38 </tr> 44 </tr>
39 </table> 45 </table>
40 <h3>Functions</h3> 46 <h3>Functions</h3>
41 <table> 47
42 <tr><td>None</td></tr> 48 <table>
43 </table> 49 <tr><td>None</td></tr>
44 <hr /><hr /> 50 </table>
51 <hr />
52 <hr />
45 <a NAME="XbelReader" ID="XbelReader"></a> 53 <a NAME="XbelReader" ID="XbelReader"></a>
46 <h2>XbelReader</h2> 54 <h2>XbelReader</h2>
55
47 <p> 56 <p>
48 Class implementing a reader object for XBEL bookmark files. 57 Class implementing a reader object for XBEL bookmark files.
49 </p> 58 </p>
50 <h3>Derived from</h3> 59 <h3>Derived from</h3>
51 QXmlStreamReader 60 QXmlStreamReader
52 <h3>Class Attributes</h3> 61 <h3>Class Attributes</h3>
62
53 <table> 63 <table>
54 <tr><td>None</td></tr> 64 <tr><td>None</td></tr>
55 </table> 65 </table>
56 <h3>Class Methods</h3> 66 <h3>Class Methods</h3>
67
57 <table> 68 <table>
58 <tr><td>None</td></tr> 69 <tr><td>None</td></tr>
59 </table> 70 </table>
60 <h3>Methods</h3> 71 <h3>Methods</h3>
61 <table> 72
73 <table>
74
62 <tr> 75 <tr>
63 <td><a href="#XbelReader.__init__">XbelReader</a></td> 76 <td><a href="#XbelReader.__init__">XbelReader</a></td>
64 <td>Constructor</td> 77 <td>Constructor</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#XbelReader.__readBookmarkNode">__readBookmarkNode</a></td> 80 <td><a href="#XbelReader.__readBookmarkNode">__readBookmarkNode</a></td>
67 <td>Private method to read and parse a bookmark subtree.</td> 81 <td>Private method to read and parse a bookmark subtree.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#XbelReader.__readDescription">__readDescription</a></td> 84 <td><a href="#XbelReader.__readDescription">__readDescription</a></td>
70 <td>Private method to read the desc element.</td> 85 <td>Private method to read the desc element.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#XbelReader.__readFolder">__readFolder</a></td> 88 <td><a href="#XbelReader.__readFolder">__readFolder</a></td>
73 <td>Private method to read and parse a folder subtree.</td> 89 <td>Private method to read and parse a folder subtree.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#XbelReader.__readInfo">__readInfo</a></td> 92 <td><a href="#XbelReader.__readInfo">__readInfo</a></td>
76 <td>Private method to read and parse an info subtree.</td> 93 <td>Private method to read and parse an info subtree.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#XbelReader.__readSeparator">__readSeparator</a></td> 96 <td><a href="#XbelReader.__readSeparator">__readSeparator</a></td>
79 <td>Private method to read a separator element.</td> 97 <td>Private method to read a separator element.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#XbelReader.__readTitle">__readTitle</a></td> 100 <td><a href="#XbelReader.__readTitle">__readTitle</a></td>
82 <td>Private method to read the title element.</td> 101 <td>Private method to read the title element.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#XbelReader.__readXBEL">__readXBEL</a></td> 104 <td><a href="#XbelReader.__readXBEL">__readXBEL</a></td>
85 <td>Private method to read and parse the XBEL file.</td> 105 <td>Private method to read and parse the XBEL file.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#XbelReader.__skipUnknownElement">__skipUnknownElement</a></td> 108 <td><a href="#XbelReader.__skipUnknownElement">__skipUnknownElement</a></td>
88 <td>Private method to skip over all unknown elements.</td> 109 <td>Private method to skip over all unknown elements.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#XbelReader.read">read</a></td> 112 <td><a href="#XbelReader.read">read</a></td>
91 <td>Public method to read an XBEL bookmark file.</td> 113 <td>Public method to read an XBEL bookmark file.</td>
92 </tr> 114 </tr>
93 </table> 115 </table>
94 <h3>Static Methods</h3> 116 <h3>Static Methods</h3>
95 <table> 117
96 <tr><td>None</td></tr> 118 <table>
97 </table> 119 <tr><td>None</td></tr>
120 </table>
121
98 <a NAME="XbelReader.__init__" ID="XbelReader.__init__"></a> 122 <a NAME="XbelReader.__init__" ID="XbelReader.__init__"></a>
99 <h4>XbelReader (Constructor)</h4> 123 <h4>XbelReader (Constructor)</h4>
100 <b>XbelReader</b>(<i></i>) 124 <b>XbelReader</b>(<i></i>)
125
101 <p> 126 <p>
102 Constructor 127 Constructor
103 </p><a NAME="XbelReader.__readBookmarkNode" ID="XbelReader.__readBookmarkNode"></a> 128 </p>
129 <a NAME="XbelReader.__readBookmarkNode" ID="XbelReader.__readBookmarkNode"></a>
104 <h4>XbelReader.__readBookmarkNode</h4> 130 <h4>XbelReader.__readBookmarkNode</h4>
105 <b>__readBookmarkNode</b>(<i>node</i>) 131 <b>__readBookmarkNode</b>(<i>node</i>)
132
106 <p> 133 <p>
107 Private method to read and parse a bookmark subtree. 134 Private method to read and parse a bookmark subtree.
108 </p><dl> 135 </p>
136 <dl>
137
109 <dt><i>node</i></dt> 138 <dt><i>node</i></dt>
110 <dd> 139 <dd>
111 reference to the node to attach to (BookmarkNode) 140 reference to the node to attach to (BookmarkNode)
112 </dd> 141 </dd>
113 </dl><a NAME="XbelReader.__readDescription" ID="XbelReader.__readDescription"></a> 142 </dl>
143 <a NAME="XbelReader.__readDescription" ID="XbelReader.__readDescription"></a>
114 <h4>XbelReader.__readDescription</h4> 144 <h4>XbelReader.__readDescription</h4>
115 <b>__readDescription</b>(<i>node</i>) 145 <b>__readDescription</b>(<i>node</i>)
146
116 <p> 147 <p>
117 Private method to read the desc element. 148 Private method to read the desc element.
118 </p><dl> 149 </p>
150 <dl>
151
119 <dt><i>node</i></dt> 152 <dt><i>node</i></dt>
120 <dd> 153 <dd>
121 reference to the bookmark node desc belongs to 154 reference to the bookmark node desc belongs to
122 (BookmarkNode) 155 (BookmarkNode)
123 </dd> 156 </dd>
124 </dl><a NAME="XbelReader.__readFolder" ID="XbelReader.__readFolder"></a> 157 </dl>
158 <a NAME="XbelReader.__readFolder" ID="XbelReader.__readFolder"></a>
125 <h4>XbelReader.__readFolder</h4> 159 <h4>XbelReader.__readFolder</h4>
126 <b>__readFolder</b>(<i>node</i>) 160 <b>__readFolder</b>(<i>node</i>)
161
127 <p> 162 <p>
128 Private method to read and parse a folder subtree. 163 Private method to read and parse a folder subtree.
129 </p><dl> 164 </p>
165 <dl>
166
130 <dt><i>node</i></dt> 167 <dt><i>node</i></dt>
131 <dd> 168 <dd>
132 reference to the node to attach to (BookmarkNode) 169 reference to the node to attach to (BookmarkNode)
133 </dd> 170 </dd>
134 </dl><a NAME="XbelReader.__readInfo" ID="XbelReader.__readInfo"></a> 171 </dl>
172 <a NAME="XbelReader.__readInfo" ID="XbelReader.__readInfo"></a>
135 <h4>XbelReader.__readInfo</h4> 173 <h4>XbelReader.__readInfo</h4>
136 <b>__readInfo</b>(<i></i>) 174 <b>__readInfo</b>(<i></i>)
175
137 <p> 176 <p>
138 Private method to read and parse an info subtree. 177 Private method to read and parse an info subtree.
139 </p><a NAME="XbelReader.__readSeparator" ID="XbelReader.__readSeparator"></a> 178 </p>
179 <a NAME="XbelReader.__readSeparator" ID="XbelReader.__readSeparator"></a>
140 <h4>XbelReader.__readSeparator</h4> 180 <h4>XbelReader.__readSeparator</h4>
141 <b>__readSeparator</b>(<i>node</i>) 181 <b>__readSeparator</b>(<i>node</i>)
182
142 <p> 183 <p>
143 Private method to read a separator element. 184 Private method to read a separator element.
144 </p><dl> 185 </p>
186 <dl>
187
145 <dt><i>node</i></dt> 188 <dt><i>node</i></dt>
146 <dd> 189 <dd>
147 reference to the bookmark node the separator belongs to 190 reference to the bookmark node the separator belongs to
148 (BookmarkNode) 191 (BookmarkNode)
149 </dd> 192 </dd>
150 </dl><a NAME="XbelReader.__readTitle" ID="XbelReader.__readTitle"></a> 193 </dl>
194 <a NAME="XbelReader.__readTitle" ID="XbelReader.__readTitle"></a>
151 <h4>XbelReader.__readTitle</h4> 195 <h4>XbelReader.__readTitle</h4>
152 <b>__readTitle</b>(<i>node</i>) 196 <b>__readTitle</b>(<i>node</i>)
197
153 <p> 198 <p>
154 Private method to read the title element. 199 Private method to read the title element.
155 </p><dl> 200 </p>
201 <dl>
202
156 <dt><i>node</i></dt> 203 <dt><i>node</i></dt>
157 <dd> 204 <dd>
158 reference to the bookmark node title belongs to 205 reference to the bookmark node title belongs to
159 (BookmarkNode) 206 (BookmarkNode)
160 </dd> 207 </dd>
161 </dl><a NAME="XbelReader.__readXBEL" ID="XbelReader.__readXBEL"></a> 208 </dl>
209 <a NAME="XbelReader.__readXBEL" ID="XbelReader.__readXBEL"></a>
162 <h4>XbelReader.__readXBEL</h4> 210 <h4>XbelReader.__readXBEL</h4>
163 <b>__readXBEL</b>(<i>node</i>) 211 <b>__readXBEL</b>(<i>node</i>)
212
164 <p> 213 <p>
165 Private method to read and parse the XBEL file. 214 Private method to read and parse the XBEL file.
166 </p><dl> 215 </p>
216 <dl>
217
167 <dt><i>node</i></dt> 218 <dt><i>node</i></dt>
168 <dd> 219 <dd>
169 reference to the node to attach to (BookmarkNode) 220 reference to the node to attach to (BookmarkNode)
170 </dd> 221 </dd>
171 </dl><a NAME="XbelReader.__skipUnknownElement" ID="XbelReader.__skipUnknownElement"></a> 222 </dl>
223 <a NAME="XbelReader.__skipUnknownElement" ID="XbelReader.__skipUnknownElement"></a>
172 <h4>XbelReader.__skipUnknownElement</h4> 224 <h4>XbelReader.__skipUnknownElement</h4>
173 <b>__skipUnknownElement</b>(<i></i>) 225 <b>__skipUnknownElement</b>(<i></i>)
226
174 <p> 227 <p>
175 Private method to skip over all unknown elements. 228 Private method to skip over all unknown elements.
176 </p><a NAME="XbelReader.read" ID="XbelReader.read"></a> 229 </p>
230 <a NAME="XbelReader.read" ID="XbelReader.read"></a>
177 <h4>XbelReader.read</h4> 231 <h4>XbelReader.read</h4>
178 <b>read</b>(<i>fileNameOrDevice</i>) 232 <b>read</b>(<i>fileNameOrDevice</i>)
233
179 <p> 234 <p>
180 Public method to read an XBEL bookmark file. 235 Public method to read an XBEL bookmark file.
181 </p><dl> 236 </p>
237 <dl>
238
182 <dt><i>fileNameOrDevice</i></dt> 239 <dt><i>fileNameOrDevice</i></dt>
183 <dd> 240 <dd>
184 name of the file to read (string) 241 name of the file to read (string)
185 or reference to the device to read (QIODevice) 242 or reference to the device to read (QIODevice)
186 </dd> 243 </dd>
187 </dl><dl> 244 </dl>
245 <dl>
188 <dt>Returns:</dt> 246 <dt>Returns:</dt>
189 <dd> 247 <dd>
190 reference to the root node (BookmarkNode) 248 reference to the root node (BookmarkNode)
191 </dd> 249 </dd>
192 </dl> 250 </dl>
193 <div align="right"><a href="#top">Up</a></div> 251 <div align="right"><a href="#top">Up</a></div>
194 <hr /><hr /> 252 <hr />
253 <hr />
195 <a NAME="XmlEntityResolver" ID="XmlEntityResolver"></a> 254 <a NAME="XmlEntityResolver" ID="XmlEntityResolver"></a>
196 <h2>XmlEntityResolver</h2> 255 <h2>XmlEntityResolver</h2>
256
197 <p> 257 <p>
198 Class implementing an XML entity resolver for bookmark files. 258 Class implementing an XML entity resolver for bookmark files.
199 </p> 259 </p>
200 <h3>Derived from</h3> 260 <h3>Derived from</h3>
201 QXmlStreamEntityResolver 261 QXmlStreamEntityResolver
202 <h3>Class Attributes</h3> 262 <h3>Class Attributes</h3>
263
203 <table> 264 <table>
204 <tr><td>None</td></tr> 265 <tr><td>None</td></tr>
205 </table> 266 </table>
206 <h3>Class Methods</h3> 267 <h3>Class Methods</h3>
268
207 <table> 269 <table>
208 <tr><td>None</td></tr> 270 <tr><td>None</td></tr>
209 </table> 271 </table>
210 <h3>Methods</h3> 272 <h3>Methods</h3>
211 <table> 273
274 <table>
275
212 <tr> 276 <tr>
213 <td><a href="#XmlEntityResolver.resolveUndeclaredEntity">resolveUndeclaredEntity</a></td> 277 <td><a href="#XmlEntityResolver.resolveUndeclaredEntity">resolveUndeclaredEntity</a></td>
214 <td>Public method to resolve undeclared entities.</td> 278 <td>Public method to resolve undeclared entities.</td>
215 </tr> 279 </tr>
216 </table> 280 </table>
217 <h3>Static Methods</h3> 281 <h3>Static Methods</h3>
218 <table> 282
219 <tr><td>None</td></tr> 283 <table>
220 </table> 284 <tr><td>None</td></tr>
285 </table>
286
221 <a NAME="XmlEntityResolver.resolveUndeclaredEntity" ID="XmlEntityResolver.resolveUndeclaredEntity"></a> 287 <a NAME="XmlEntityResolver.resolveUndeclaredEntity" ID="XmlEntityResolver.resolveUndeclaredEntity"></a>
222 <h4>XmlEntityResolver.resolveUndeclaredEntity</h4> 288 <h4>XmlEntityResolver.resolveUndeclaredEntity</h4>
223 <b>resolveUndeclaredEntity</b>(<i>entity</i>) 289 <b>resolveUndeclaredEntity</b>(<i>entity</i>)
290
224 <p> 291 <p>
225 Public method to resolve undeclared entities. 292 Public method to resolve undeclared entities.
226 </p><dl> 293 </p>
294 <dl>
295
227 <dt><i>entity</i></dt> 296 <dt><i>entity</i></dt>
228 <dd> 297 <dd>
229 entity to be resolved (string) 298 entity to be resolved (string)
230 </dd> 299 </dd>
231 </dl><dl> 300 </dl>
301 <dl>
232 <dt>Returns:</dt> 302 <dt>Returns:</dt>
233 <dd> 303 <dd>
234 resolved entity (string) 304 resolved entity (string)
235 </dd> 305 </dd>
236 </dl> 306 </dl>

Mercurial Repository: eric

eric ide

mercurial