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