|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.EricXML.SessionReader</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.EricXML.SessionReader</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing a class for reading an XML session file. |
|
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="#SessionReader">SessionReader</a></td> |
|
39 <td>Class for reading an XML session file.</td> |
|
40 </tr> |
|
41 </table> |
|
42 <h3>Functions</h3> |
|
43 |
|
44 <table> |
|
45 <tr><td>None</td></tr> |
|
46 </table> |
|
47 <hr /> |
|
48 <hr /> |
|
49 <a NAME="SessionReader" ID="SessionReader"></a> |
|
50 <h2>SessionReader</h2> |
|
51 |
|
52 <p> |
|
53 Class for reading an XML session file. |
|
54 </p> |
|
55 <h3>Derived from</h3> |
|
56 XMLStreamReaderBase |
|
57 <h3>Class Attributes</h3> |
|
58 |
|
59 <table> |
|
60 <tr><td>supportedVersions</td></tr> |
|
61 </table> |
|
62 <h3>Class Methods</h3> |
|
63 |
|
64 <table> |
|
65 <tr><td>None</td></tr> |
|
66 </table> |
|
67 <h3>Methods</h3> |
|
68 |
|
69 <table> |
|
70 |
|
71 <tr> |
|
72 <td><a href="#SessionReader.__init__">SessionReader</a></td> |
|
73 <td>Constructor</td> |
|
74 </tr> |
|
75 <tr> |
|
76 <td><a href="#SessionReader.__readBookmark">__readBookmark</a></td> |
|
77 <td>Private method to read the bookmark info.</td> |
|
78 </tr> |
|
79 <tr> |
|
80 <td><a href="#SessionReader.__readBookmarks">__readBookmarks</a></td> |
|
81 <td>Private method to read the bookmark infos.</td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td><a href="#SessionReader.__readBreakpoint">__readBreakpoint</a></td> |
|
85 <td>Private method to read the break point info.</td> |
|
86 </tr> |
|
87 <tr> |
|
88 <td><a href="#SessionReader.__readBreakpoints">__readBreakpoints</a></td> |
|
89 <td>Private method to read the break point infos.</td> |
|
90 </tr> |
|
91 <tr> |
|
92 <td><a href="#SessionReader.__readDebugInfo">__readDebugInfo</a></td> |
|
93 <td>Private method to read the debug infos.</td> |
|
94 </tr> |
|
95 <tr> |
|
96 <td><a href="#SessionReader.__readFilenames">__readFilenames</a></td> |
|
97 <td>Private method to read the file name infos.</td> |
|
98 </tr> |
|
99 <tr> |
|
100 <td><a href="#SessionReader.__readProjectBrowserState">__readProjectBrowserState</a></td> |
|
101 <td>Private method to read the project browser state info.</td> |
|
102 </tr> |
|
103 <tr> |
|
104 <td><a href="#SessionReader.__readProjectBrowserStates">__readProjectBrowserStates</a></td> |
|
105 <td>Private method to read the project browser state infos.</td> |
|
106 </tr> |
|
107 <tr> |
|
108 <td><a href="#SessionReader.__readWatchexpression">__readWatchexpression</a></td> |
|
109 <td>Private method to read the watch expression info.</td> |
|
110 </tr> |
|
111 <tr> |
|
112 <td><a href="#SessionReader.__readWatchexpressions">__readWatchexpressions</a></td> |
|
113 <td>Private method to read watch expression infos.</td> |
|
114 </tr> |
|
115 <tr> |
|
116 <td><a href="#SessionReader.readXML">readXML</a></td> |
|
117 <td>Public method to read and parse the XML document.</td> |
|
118 </tr> |
|
119 </table> |
|
120 <h3>Static Methods</h3> |
|
121 |
|
122 <table> |
|
123 <tr><td>None</td></tr> |
|
124 </table> |
|
125 |
|
126 <a NAME="SessionReader.__init__" ID="SessionReader.__init__"></a> |
|
127 <h4>SessionReader (Constructor)</h4> |
|
128 <b>SessionReader</b>(<i>device, isGlobal</i>) |
|
129 |
|
130 <p> |
|
131 Constructor |
|
132 </p> |
|
133 <dl> |
|
134 |
|
135 <dt><i>device</i> (QIODevice)</dt> |
|
136 <dd> |
|
137 reference to the I/O device to read from |
|
138 </dd> |
|
139 <dt><i>isGlobal</i> (bool)</dt> |
|
140 <dd> |
|
141 flag indicating to read the global session |
|
142 </dd> |
|
143 </dl> |
|
144 <a NAME="SessionReader.__readBookmark" ID="SessionReader.__readBookmark"></a> |
|
145 <h4>SessionReader.__readBookmark</h4> |
|
146 <b>__readBookmark</b>(<i></i>) |
|
147 |
|
148 <p> |
|
149 Private method to read the bookmark info. |
|
150 </p> |
|
151 <a NAME="SessionReader.__readBookmarks" ID="SessionReader.__readBookmarks"></a> |
|
152 <h4>SessionReader.__readBookmarks</h4> |
|
153 <b>__readBookmarks</b>(<i></i>) |
|
154 |
|
155 <p> |
|
156 Private method to read the bookmark infos. |
|
157 </p> |
|
158 <a NAME="SessionReader.__readBreakpoint" ID="SessionReader.__readBreakpoint"></a> |
|
159 <h4>SessionReader.__readBreakpoint</h4> |
|
160 <b>__readBreakpoint</b>(<i></i>) |
|
161 |
|
162 <p> |
|
163 Private method to read the break point info. |
|
164 </p> |
|
165 <a NAME="SessionReader.__readBreakpoints" ID="SessionReader.__readBreakpoints"></a> |
|
166 <h4>SessionReader.__readBreakpoints</h4> |
|
167 <b>__readBreakpoints</b>(<i></i>) |
|
168 |
|
169 <p> |
|
170 Private method to read the break point infos. |
|
171 </p> |
|
172 <a NAME="SessionReader.__readDebugInfo" ID="SessionReader.__readDebugInfo"></a> |
|
173 <h4>SessionReader.__readDebugInfo</h4> |
|
174 <b>__readDebugInfo</b>(<i></i>) |
|
175 |
|
176 <p> |
|
177 Private method to read the debug infos. |
|
178 </p> |
|
179 <a NAME="SessionReader.__readFilenames" ID="SessionReader.__readFilenames"></a> |
|
180 <h4>SessionReader.__readFilenames</h4> |
|
181 <b>__readFilenames</b>(<i></i>) |
|
182 |
|
183 <p> |
|
184 Private method to read the file name infos. |
|
185 </p> |
|
186 <a NAME="SessionReader.__readProjectBrowserState" ID="SessionReader.__readProjectBrowserState"></a> |
|
187 <h4>SessionReader.__readProjectBrowserState</h4> |
|
188 <b>__readProjectBrowserState</b>(<i>browserName</i>) |
|
189 |
|
190 <p> |
|
191 Private method to read the project browser state info. |
|
192 </p> |
|
193 <dl> |
|
194 |
|
195 <dt><i>browserName</i> (str)</dt> |
|
196 <dd> |
|
197 name of the project browser |
|
198 </dd> |
|
199 </dl> |
|
200 <a NAME="SessionReader.__readProjectBrowserStates" ID="SessionReader.__readProjectBrowserStates"></a> |
|
201 <h4>SessionReader.__readProjectBrowserStates</h4> |
|
202 <b>__readProjectBrowserStates</b>(<i></i>) |
|
203 |
|
204 <p> |
|
205 Private method to read the project browser state infos. |
|
206 </p> |
|
207 <a NAME="SessionReader.__readWatchexpression" ID="SessionReader.__readWatchexpression"></a> |
|
208 <h4>SessionReader.__readWatchexpression</h4> |
|
209 <b>__readWatchexpression</b>(<i></i>) |
|
210 |
|
211 <p> |
|
212 Private method to read the watch expression info. |
|
213 </p> |
|
214 <a NAME="SessionReader.__readWatchexpressions" ID="SessionReader.__readWatchexpressions"></a> |
|
215 <h4>SessionReader.__readWatchexpressions</h4> |
|
216 <b>__readWatchexpressions</b>(<i></i>) |
|
217 |
|
218 <p> |
|
219 Private method to read watch expression infos. |
|
220 </p> |
|
221 <a NAME="SessionReader.readXML" ID="SessionReader.readXML"></a> |
|
222 <h4>SessionReader.readXML</h4> |
|
223 <b>readXML</b>(<i>quiet=False</i>) |
|
224 |
|
225 <p> |
|
226 Public method to read and parse the XML document. |
|
227 </p> |
|
228 <dl> |
|
229 |
|
230 <dt><i>quiet</i> (bool)</dt> |
|
231 <dd> |
|
232 flag indicating quiet operations. |
|
233 If this flag is true, no errors are reported. |
|
234 </dd> |
|
235 </dl> |
|
236 <div align="right"><a href="#top">Up</a></div> |
|
237 <hr /> |
|
238 </body></html> |