Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.E5XML.SessionReader.html

eric6/Documentation/Source/eric6.E5XML.SessionReader.html

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

Mercurial Repository: eric

eric ide

mercurial