src/eric7/Documentation/Source/eric7.EricXML.SessionReader.html

branch
eric7
changeset 10479
856476537696
parent 9209
b99e7fd55fd3
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.EricXML.SessionReader</h1> 9 <h1>eric7.EricXML.SessionReader</h1>
10
11 <p> 10 <p>
12 Module implementing a class for reading an XML session file. 11 Module implementing a class for reading an XML session file.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#SessionReader">SessionReader</a></td> 22 <td><a href="#SessionReader">SessionReader</a></td>
25 <td>Class for reading an XML session file.</td> 23 <td>Class for reading an XML session file.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="SessionReader" ID="SessionReader"></a> 34 <a NAME="SessionReader" ID="SessionReader"></a>
36 <h2>SessionReader</h2> 35 <h2>SessionReader</h2>
37
38 <p> 36 <p>
39 Class for reading an XML session file. 37 Class for reading an XML session file.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 XMLStreamReaderBase 41 XMLStreamReaderBase
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44
45 <table> 43 <table>
46 <tr><td>supportedVersions</td></tr> 44 <tr><td>supportedVersions</td></tr>
47 </table> 45 </table>
46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#SessionReader.__init__">SessionReader</a></td> 55 <td><a href="#SessionReader.__init__">SessionReader</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
101 <tr> 98 <tr>
102 <td><a href="#SessionReader.readXML">readXML</a></td> 99 <td><a href="#SessionReader.readXML">readXML</a></td>
103 <td>Public method to read and parse the XML document.</td> 100 <td>Public method to read and parse the XML document.</td>
104 </tr> 101 </tr>
105 </table> 102 </table>
103
106 <h3>Static Methods</h3> 104 <h3>Static Methods</h3>
107 105 <table>
108 <table> 106 <tr><td>None</td></tr>
109 <tr><td>None</td></tr> 107 </table>
110 </table> 108
111 109
112 <a NAME="SessionReader.__init__" ID="SessionReader.__init__"></a> 110 <a NAME="SessionReader.__init__" ID="SessionReader.__init__"></a>
113 <h4>SessionReader (Constructor)</h4> 111 <h4>SessionReader (Constructor)</h4>
114 <b>SessionReader</b>(<i>device, isGlobal</i>) 112 <b>SessionReader</b>(<i>device, isGlobal</i>)
115
116 <p> 113 <p>
117 Constructor 114 Constructor
118 </p> 115 </p>
116
119 <dl> 117 <dl>
120 118
121 <dt><i>device</i> (QIODevice)</dt> 119 <dt><i>device</i> (QIODevice)</dt>
122 <dd> 120 <dd>
123 reference to the I/O device to read from 121 reference to the I/O device to read from
128 </dd> 126 </dd>
129 </dl> 127 </dl>
130 <a NAME="SessionReader.__readBookmark" ID="SessionReader.__readBookmark"></a> 128 <a NAME="SessionReader.__readBookmark" ID="SessionReader.__readBookmark"></a>
131 <h4>SessionReader.__readBookmark</h4> 129 <h4>SessionReader.__readBookmark</h4>
132 <b>__readBookmark</b>(<i></i>) 130 <b>__readBookmark</b>(<i></i>)
133
134 <p> 131 <p>
135 Private method to read the bookmark info. 132 Private method to read the bookmark info.
136 </p> 133 </p>
134
137 <a NAME="SessionReader.__readBookmarks" ID="SessionReader.__readBookmarks"></a> 135 <a NAME="SessionReader.__readBookmarks" ID="SessionReader.__readBookmarks"></a>
138 <h4>SessionReader.__readBookmarks</h4> 136 <h4>SessionReader.__readBookmarks</h4>
139 <b>__readBookmarks</b>(<i></i>) 137 <b>__readBookmarks</b>(<i></i>)
140
141 <p> 138 <p>
142 Private method to read the bookmark infos. 139 Private method to read the bookmark infos.
143 </p> 140 </p>
141
144 <a NAME="SessionReader.__readBreakpoint" ID="SessionReader.__readBreakpoint"></a> 142 <a NAME="SessionReader.__readBreakpoint" ID="SessionReader.__readBreakpoint"></a>
145 <h4>SessionReader.__readBreakpoint</h4> 143 <h4>SessionReader.__readBreakpoint</h4>
146 <b>__readBreakpoint</b>(<i></i>) 144 <b>__readBreakpoint</b>(<i></i>)
147
148 <p> 145 <p>
149 Private method to read the break point info. 146 Private method to read the break point info.
150 </p> 147 </p>
148
151 <a NAME="SessionReader.__readBreakpoints" ID="SessionReader.__readBreakpoints"></a> 149 <a NAME="SessionReader.__readBreakpoints" ID="SessionReader.__readBreakpoints"></a>
152 <h4>SessionReader.__readBreakpoints</h4> 150 <h4>SessionReader.__readBreakpoints</h4>
153 <b>__readBreakpoints</b>(<i></i>) 151 <b>__readBreakpoints</b>(<i></i>)
154
155 <p> 152 <p>
156 Private method to read the break point infos. 153 Private method to read the break point infos.
157 </p> 154 </p>
155
158 <a NAME="SessionReader.__readDebugInfo" ID="SessionReader.__readDebugInfo"></a> 156 <a NAME="SessionReader.__readDebugInfo" ID="SessionReader.__readDebugInfo"></a>
159 <h4>SessionReader.__readDebugInfo</h4> 157 <h4>SessionReader.__readDebugInfo</h4>
160 <b>__readDebugInfo</b>(<i></i>) 158 <b>__readDebugInfo</b>(<i></i>)
161
162 <p> 159 <p>
163 Private method to read the debug infos. 160 Private method to read the debug infos.
164 </p> 161 </p>
162
165 <a NAME="SessionReader.__readFilenames" ID="SessionReader.__readFilenames"></a> 163 <a NAME="SessionReader.__readFilenames" ID="SessionReader.__readFilenames"></a>
166 <h4>SessionReader.__readFilenames</h4> 164 <h4>SessionReader.__readFilenames</h4>
167 <b>__readFilenames</b>(<i></i>) 165 <b>__readFilenames</b>(<i></i>)
168
169 <p> 166 <p>
170 Private method to read the file name infos. 167 Private method to read the file name infos.
171 </p> 168 </p>
169
172 <a NAME="SessionReader.__readProjectBrowserState" ID="SessionReader.__readProjectBrowserState"></a> 170 <a NAME="SessionReader.__readProjectBrowserState" ID="SessionReader.__readProjectBrowserState"></a>
173 <h4>SessionReader.__readProjectBrowserState</h4> 171 <h4>SessionReader.__readProjectBrowserState</h4>
174 <b>__readProjectBrowserState</b>(<i>browserName</i>) 172 <b>__readProjectBrowserState</b>(<i>browserName</i>)
175
176 <p> 173 <p>
177 Private method to read the project browser state info. 174 Private method to read the project browser state info.
178 </p> 175 </p>
176
179 <dl> 177 <dl>
180 178
181 <dt><i>browserName</i> (str)</dt> 179 <dt><i>browserName</i> (str)</dt>
182 <dd> 180 <dd>
183 name of the project browser 181 name of the project browser
184 </dd> 182 </dd>
185 </dl> 183 </dl>
186 <a NAME="SessionReader.__readProjectBrowserStates" ID="SessionReader.__readProjectBrowserStates"></a> 184 <a NAME="SessionReader.__readProjectBrowserStates" ID="SessionReader.__readProjectBrowserStates"></a>
187 <h4>SessionReader.__readProjectBrowserStates</h4> 185 <h4>SessionReader.__readProjectBrowserStates</h4>
188 <b>__readProjectBrowserStates</b>(<i></i>) 186 <b>__readProjectBrowserStates</b>(<i></i>)
189
190 <p> 187 <p>
191 Private method to read the project browser state infos. 188 Private method to read the project browser state infos.
192 </p> 189 </p>
190
193 <a NAME="SessionReader.__readWatchexpression" ID="SessionReader.__readWatchexpression"></a> 191 <a NAME="SessionReader.__readWatchexpression" ID="SessionReader.__readWatchexpression"></a>
194 <h4>SessionReader.__readWatchexpression</h4> 192 <h4>SessionReader.__readWatchexpression</h4>
195 <b>__readWatchexpression</b>(<i></i>) 193 <b>__readWatchexpression</b>(<i></i>)
196
197 <p> 194 <p>
198 Private method to read the watch expression info. 195 Private method to read the watch expression info.
199 </p> 196 </p>
197
200 <a NAME="SessionReader.__readWatchexpressions" ID="SessionReader.__readWatchexpressions"></a> 198 <a NAME="SessionReader.__readWatchexpressions" ID="SessionReader.__readWatchexpressions"></a>
201 <h4>SessionReader.__readWatchexpressions</h4> 199 <h4>SessionReader.__readWatchexpressions</h4>
202 <b>__readWatchexpressions</b>(<i></i>) 200 <b>__readWatchexpressions</b>(<i></i>)
203
204 <p> 201 <p>
205 Private method to read watch expression infos. 202 Private method to read watch expression infos.
206 </p> 203 </p>
204
207 <a NAME="SessionReader.readXML" ID="SessionReader.readXML"></a> 205 <a NAME="SessionReader.readXML" ID="SessionReader.readXML"></a>
208 <h4>SessionReader.readXML</h4> 206 <h4>SessionReader.readXML</h4>
209 <b>readXML</b>(<i>quiet=False</i>) 207 <b>readXML</b>(<i>quiet=False</i>)
210
211 <p> 208 <p>
212 Public method to read and parse the XML document. 209 Public method to read and parse the XML document.
213 </p> 210 </p>
211
214 <dl> 212 <dl>
215 213
216 <dt><i>quiet</i> (bool)</dt> 214 <dt><i>quiet</i> (bool)</dt>
217 <dd> 215 <dd>
218 flag indicating quiet operations. 216 flag indicating quiet operations.

eric ide

mercurial