Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial