Documentation/Source/eric6.E5XML.SessionReader.html

changeset 3673
e26d7d0c1088
child 6052
8b49d3e0b4c8
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.E5XML.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><a NAME="top" ID="top"></a>
22 <h1>eric6.E5XML.SessionReader</h1>
23 <p>
24 Module implementing a class for reading an XML session file.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#SessionReader">SessionReader</a></td>
34 <td>Class for reading an XML session file.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="SessionReader" ID="SessionReader"></a>
43 <h2>SessionReader</h2>
44 <p>
45 Class for reading an XML session file.
46 </p>
47 <h3>Derived from</h3>
48 XMLStreamReaderBase
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>supportedVersions</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#SessionReader.__init__">SessionReader</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#SessionReader.__readBookmark">__readBookmark</a></td>
64 <td>Private method to read the bookmark info.</td>
65 </tr><tr>
66 <td><a href="#SessionReader.__readBookmarks">__readBookmarks</a></td>
67 <td>Private method to read the bookmark infos.</td>
68 </tr><tr>
69 <td><a href="#SessionReader.__readBreakpoint">__readBreakpoint</a></td>
70 <td>Private method to read the break point info.</td>
71 </tr><tr>
72 <td><a href="#SessionReader.__readBreakpoints">__readBreakpoints</a></td>
73 <td>Private method to read the break point infos.</td>
74 </tr><tr>
75 <td><a href="#SessionReader.__readDebugInfo">__readDebugInfo</a></td>
76 <td>Private method to read the debug infos.</td>
77 </tr><tr>
78 <td><a href="#SessionReader.__readFilenames">__readFilenames</a></td>
79 <td>Private method to read the file name infos.</td>
80 </tr><tr>
81 <td><a href="#SessionReader.__readProjectBrowserState">__readProjectBrowserState</a></td>
82 <td>Private method to read the project browser state info.</td>
83 </tr><tr>
84 <td><a href="#SessionReader.__readProjectBrowserStates">__readProjectBrowserStates</a></td>
85 <td>Private method to read the project browser state infos.</td>
86 </tr><tr>
87 <td><a href="#SessionReader.__readWatchexpression">__readWatchexpression</a></td>
88 <td>Private method to read the watch expression info.</td>
89 </tr><tr>
90 <td><a href="#SessionReader.__readWatchexpressions">__readWatchexpressions</a></td>
91 <td>Private method to read watch expression infos.</td>
92 </tr><tr>
93 <td><a href="#SessionReader.readXML">readXML</a></td>
94 <td>Public method to read and parse the XML document.</td>
95 </tr>
96 </table>
97 <h3>Static Methods</h3>
98 <table>
99 <tr><td>None</td></tr>
100 </table>
101 <a NAME="SessionReader.__init__" ID="SessionReader.__init__"></a>
102 <h4>SessionReader (Constructor)</h4>
103 <b>SessionReader</b>(<i>device, isGlobal</i>)
104 <p>
105 Constructor
106 </p><dl>
107 <dt><i>device</i></dt>
108 <dd>
109 reference to the I/O device to read from (QIODevice)
110 </dd><dt><i>isGlobal</i></dt>
111 <dd>
112 flag indicating to read the global session (boolean).
113 </dd>
114 </dl><a NAME="SessionReader.__readBookmark" ID="SessionReader.__readBookmark"></a>
115 <h4>SessionReader.__readBookmark</h4>
116 <b>__readBookmark</b>(<i></i>)
117 <p>
118 Private method to read the bookmark info.
119 </p><a NAME="SessionReader.__readBookmarks" ID="SessionReader.__readBookmarks"></a>
120 <h4>SessionReader.__readBookmarks</h4>
121 <b>__readBookmarks</b>(<i></i>)
122 <p>
123 Private method to read the bookmark infos.
124 </p><a NAME="SessionReader.__readBreakpoint" ID="SessionReader.__readBreakpoint"></a>
125 <h4>SessionReader.__readBreakpoint</h4>
126 <b>__readBreakpoint</b>(<i></i>)
127 <p>
128 Private method to read the break point info.
129 </p><a NAME="SessionReader.__readBreakpoints" ID="SessionReader.__readBreakpoints"></a>
130 <h4>SessionReader.__readBreakpoints</h4>
131 <b>__readBreakpoints</b>(<i></i>)
132 <p>
133 Private method to read the break point infos.
134 </p><a NAME="SessionReader.__readDebugInfo" ID="SessionReader.__readDebugInfo"></a>
135 <h4>SessionReader.__readDebugInfo</h4>
136 <b>__readDebugInfo</b>(<i></i>)
137 <p>
138 Private method to read the debug infos.
139 </p><a NAME="SessionReader.__readFilenames" ID="SessionReader.__readFilenames"></a>
140 <h4>SessionReader.__readFilenames</h4>
141 <b>__readFilenames</b>(<i></i>)
142 <p>
143 Private method to read the file name infos.
144 </p><a NAME="SessionReader.__readProjectBrowserState" ID="SessionReader.__readProjectBrowserState"></a>
145 <h4>SessionReader.__readProjectBrowserState</h4>
146 <b>__readProjectBrowserState</b>(<i>browserName</i>)
147 <p>
148 Private method to read the project browser state info.
149 </p><dl>
150 <dt><i>browserName</i></dt>
151 <dd>
152 name of the project browser (string)
153 </dd>
154 </dl><a NAME="SessionReader.__readProjectBrowserStates" ID="SessionReader.__readProjectBrowserStates"></a>
155 <h4>SessionReader.__readProjectBrowserStates</h4>
156 <b>__readProjectBrowserStates</b>(<i></i>)
157 <p>
158 Private method to read the project browser state infos.
159 </p><a NAME="SessionReader.__readWatchexpression" ID="SessionReader.__readWatchexpression"></a>
160 <h4>SessionReader.__readWatchexpression</h4>
161 <b>__readWatchexpression</b>(<i></i>)
162 <p>
163 Private method to read the watch expression info.
164 </p><a NAME="SessionReader.__readWatchexpressions" ID="SessionReader.__readWatchexpressions"></a>
165 <h4>SessionReader.__readWatchexpressions</h4>
166 <b>__readWatchexpressions</b>(<i></i>)
167 <p>
168 Private method to read watch expression infos.
169 </p><a NAME="SessionReader.readXML" ID="SessionReader.readXML"></a>
170 <h4>SessionReader.readXML</h4>
171 <b>readXML</b>(<i>quiet=False</i>)
172 <p>
173 Public method to read and parse the XML document.
174 </p><dl>
175 <dt><i>quiet</i></dt>
176 <dd>
177 flag indicating quiet operations.
178 If this flag is true, no errors are reported.
179 </dd>
180 </dl>
181 <div align="right"><a href="#top">Up</a></div>
182 <hr />
183 </body></html>

eric ide

mercurial