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