|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.EricGui.EricOverrideCursor</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.EricGui.EricOverrideCursor</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing a context manager class for an override cursor and a |
|
13 QProcess class controlling an override cursor. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 |
|
17 <table> |
|
18 <tr><td>None</td></tr> |
|
19 </table> |
|
20 <h3>Classes</h3> |
|
21 |
|
22 <table> |
|
23 |
|
24 <tr> |
|
25 <td><a href="#EricOverrideCursor">EricOverrideCursor</a></td> |
|
26 <td>Class implementing a context manager class for an override cursor.</td> |
|
27 </tr> |
|
28 <tr> |
|
29 <td><a href="#EricOverrideCursorProcess">EricOverrideCursorProcess</a></td> |
|
30 <td>Class implementing a QProcess subclass controlling an override cursor.</td> |
|
31 </tr> |
|
32 <tr> |
|
33 <td><a href="#EricOverridenCursor">EricOverridenCursor</a></td> |
|
34 <td>Class implementing a context manager class for an overriden cursor.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <hr /> |
|
43 <hr /> |
|
44 <a NAME="EricOverrideCursor" ID="EricOverrideCursor"></a> |
|
45 <h2>EricOverrideCursor</h2> |
|
46 |
|
47 <p> |
|
48 Class implementing a context manager class for an override cursor. |
|
49 </p> |
|
50 <h3>Derived from</h3> |
|
51 contextlib.AbstractContextManager |
|
52 <h3>Class Attributes</h3> |
|
53 |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Class Methods</h3> |
|
58 |
|
59 <table> |
|
60 <tr><td>None</td></tr> |
|
61 </table> |
|
62 <h3>Methods</h3> |
|
63 |
|
64 <table> |
|
65 |
|
66 <tr> |
|
67 <td><a href="#EricOverrideCursor.__init__">EricOverrideCursor</a></td> |
|
68 <td>Constructor</td> |
|
69 </tr> |
|
70 <tr> |
|
71 <td><a href="#EricOverrideCursor.__enter__">__enter__</a></td> |
|
72 <td>Special method called when entering the runtime ccontext.</td> |
|
73 </tr> |
|
74 <tr> |
|
75 <td><a href="#EricOverrideCursor.__exit__">__exit__</a></td> |
|
76 <td>Special method called when exiting the runtime ccontext.</td> |
|
77 </tr> |
|
78 </table> |
|
79 <h3>Static Methods</h3> |
|
80 |
|
81 <table> |
|
82 <tr><td>None</td></tr> |
|
83 </table> |
|
84 |
|
85 <a NAME="EricOverrideCursor.__init__" ID="EricOverrideCursor.__init__"></a> |
|
86 <h4>EricOverrideCursor (Constructor)</h4> |
|
87 <b>EricOverrideCursor</b>(<i>cursorShape=Qt.CursorShape.WaitCursor</i>) |
|
88 |
|
89 <p> |
|
90 Constructor |
|
91 </p> |
|
92 <dl> |
|
93 |
|
94 <dt><i>cursorShape</i> (Qt.CursorShape)</dt> |
|
95 <dd> |
|
96 shape of the override cursor |
|
97 </dd> |
|
98 </dl> |
|
99 <a NAME="EricOverrideCursor.__enter__" ID="EricOverrideCursor.__enter__"></a> |
|
100 <h4>EricOverrideCursor.__enter__</h4> |
|
101 <b>__enter__</b>(<i></i>) |
|
102 |
|
103 <p> |
|
104 Special method called when entering the runtime ccontext. |
|
105 </p> |
|
106 <dl> |
|
107 <dt>Return:</dt> |
|
108 <dd> |
|
109 reference to the context manager object |
|
110 </dd> |
|
111 </dl> |
|
112 <dl> |
|
113 <dt>Return Type:</dt> |
|
114 <dd> |
|
115 EricOverrideCursor |
|
116 </dd> |
|
117 </dl> |
|
118 <a NAME="EricOverrideCursor.__exit__" ID="EricOverrideCursor.__exit__"></a> |
|
119 <h4>EricOverrideCursor.__exit__</h4> |
|
120 <b>__exit__</b>(<i>exc_type, exc_value, traceback</i>) |
|
121 |
|
122 <p> |
|
123 Special method called when exiting the runtime ccontext. |
|
124 </p> |
|
125 <dl> |
|
126 |
|
127 <dt><i>exc_type</i></dt> |
|
128 <dd> |
|
129 type of an exception raised in the runtime context |
|
130 </dd> |
|
131 <dt><i>exc_value</i></dt> |
|
132 <dd> |
|
133 value of an exception raised in the runtime context |
|
134 </dd> |
|
135 <dt><i>traceback</i></dt> |
|
136 <dd> |
|
137 traceback of an exception raised in the runtime |
|
138 context |
|
139 </dd> |
|
140 </dl> |
|
141 <dl> |
|
142 <dt>Return:</dt> |
|
143 <dd> |
|
144 always returns None to not suppress any exception |
|
145 </dd> |
|
146 </dl> |
|
147 <dl> |
|
148 <dt>Return Type:</dt> |
|
149 <dd> |
|
150 None |
|
151 </dd> |
|
152 </dl> |
|
153 <div align="right"><a href="#top">Up</a></div> |
|
154 <hr /> |
|
155 <hr /> |
|
156 <a NAME="EricOverrideCursorProcess" ID="EricOverrideCursorProcess"></a> |
|
157 <h2>EricOverrideCursorProcess</h2> |
|
158 |
|
159 <p> |
|
160 Class implementing a QProcess subclass controlling an override cursor. |
|
161 </p> |
|
162 <h3>Derived from</h3> |
|
163 QProcess |
|
164 <h3>Class Attributes</h3> |
|
165 |
|
166 <table> |
|
167 <tr><td>None</td></tr> |
|
168 </table> |
|
169 <h3>Class Methods</h3> |
|
170 |
|
171 <table> |
|
172 <tr><td>None</td></tr> |
|
173 </table> |
|
174 <h3>Methods</h3> |
|
175 |
|
176 <table> |
|
177 |
|
178 <tr> |
|
179 <td><a href="#EricOverrideCursorProcess.__init__">EricOverrideCursorProcess</a></td> |
|
180 <td>Constructor</td> |
|
181 </tr> |
|
182 <tr> |
|
183 <td><a href="#EricOverrideCursorProcess.__processFinished">__processFinished</a></td> |
|
184 <td>Private slot resetting the cursor when the process finished.</td> |
|
185 </tr> |
|
186 <tr> |
|
187 <td><a href="#EricOverrideCursorProcess.__processStarted">__processStarted</a></td> |
|
188 <td>Private slot setting the cursor after the process has started.</td> |
|
189 </tr> |
|
190 </table> |
|
191 <h3>Static Methods</h3> |
|
192 |
|
193 <table> |
|
194 <tr><td>None</td></tr> |
|
195 </table> |
|
196 |
|
197 <a NAME="EricOverrideCursorProcess.__init__" ID="EricOverrideCursorProcess.__init__"></a> |
|
198 <h4>EricOverrideCursorProcess (Constructor)</h4> |
|
199 <b>EricOverrideCursorProcess</b>(<i>parent=None, cursorShape=Qt.CursorShape.WaitCursor</i>) |
|
200 |
|
201 <p> |
|
202 Constructor |
|
203 </p> |
|
204 <dl> |
|
205 |
|
206 <dt><i>parent</i> (QObject)</dt> |
|
207 <dd> |
|
208 reference to the parent object |
|
209 </dd> |
|
210 <dt><i>cursorShape</i> (Qt.CursorShape)</dt> |
|
211 <dd> |
|
212 shape of the override cursor |
|
213 </dd> |
|
214 </dl> |
|
215 <a NAME="EricOverrideCursorProcess.__processFinished" ID="EricOverrideCursorProcess.__processFinished"></a> |
|
216 <h4>EricOverrideCursorProcess.__processFinished</h4> |
|
217 <b>__processFinished</b>(<i></i>) |
|
218 |
|
219 <p> |
|
220 Private slot resetting the cursor when the process finished. |
|
221 </p> |
|
222 <a NAME="EricOverrideCursorProcess.__processStarted" ID="EricOverrideCursorProcess.__processStarted"></a> |
|
223 <h4>EricOverrideCursorProcess.__processStarted</h4> |
|
224 <b>__processStarted</b>(<i></i>) |
|
225 |
|
226 <p> |
|
227 Private slot setting the cursor after the process has started. |
|
228 </p> |
|
229 <div align="right"><a href="#top">Up</a></div> |
|
230 <hr /> |
|
231 <hr /> |
|
232 <a NAME="EricOverridenCursor" ID="EricOverridenCursor"></a> |
|
233 <h2>EricOverridenCursor</h2> |
|
234 |
|
235 <p> |
|
236 Class implementing a context manager class for an overriden cursor. |
|
237 </p> |
|
238 <p> |
|
239 The cursor is reset upon entering the runtime context and restored |
|
240 upon exiting it. |
|
241 </p> |
|
242 <h3>Derived from</h3> |
|
243 contextlib.AbstractContextManager |
|
244 <h3>Class Attributes</h3> |
|
245 |
|
246 <table> |
|
247 <tr><td>None</td></tr> |
|
248 </table> |
|
249 <h3>Class Methods</h3> |
|
250 |
|
251 <table> |
|
252 <tr><td>None</td></tr> |
|
253 </table> |
|
254 <h3>Methods</h3> |
|
255 |
|
256 <table> |
|
257 |
|
258 <tr> |
|
259 <td><a href="#EricOverridenCursor.__init__">EricOverridenCursor</a></td> |
|
260 <td>Constructor</td> |
|
261 </tr> |
|
262 <tr> |
|
263 <td><a href="#EricOverridenCursor.__enter__">__enter__</a></td> |
|
264 <td>Special method called when entering the runtime ccontext.</td> |
|
265 </tr> |
|
266 <tr> |
|
267 <td><a href="#EricOverridenCursor.__exit__">__exit__</a></td> |
|
268 <td>Special method called when exiting the runtime ccontext.</td> |
|
269 </tr> |
|
270 </table> |
|
271 <h3>Static Methods</h3> |
|
272 |
|
273 <table> |
|
274 <tr><td>None</td></tr> |
|
275 </table> |
|
276 |
|
277 <a NAME="EricOverridenCursor.__init__" ID="EricOverridenCursor.__init__"></a> |
|
278 <h4>EricOverridenCursor (Constructor)</h4> |
|
279 <b>EricOverridenCursor</b>(<i></i>) |
|
280 |
|
281 <p> |
|
282 Constructor |
|
283 </p> |
|
284 <a NAME="EricOverridenCursor.__enter__" ID="EricOverridenCursor.__enter__"></a> |
|
285 <h4>EricOverridenCursor.__enter__</h4> |
|
286 <b>__enter__</b>(<i></i>) |
|
287 |
|
288 <p> |
|
289 Special method called when entering the runtime ccontext. |
|
290 </p> |
|
291 <dl> |
|
292 <dt>Return:</dt> |
|
293 <dd> |
|
294 reference to the context manager object |
|
295 </dd> |
|
296 </dl> |
|
297 <dl> |
|
298 <dt>Return Type:</dt> |
|
299 <dd> |
|
300 EricOverrideCursor |
|
301 </dd> |
|
302 </dl> |
|
303 <a NAME="EricOverridenCursor.__exit__" ID="EricOverridenCursor.__exit__"></a> |
|
304 <h4>EricOverridenCursor.__exit__</h4> |
|
305 <b>__exit__</b>(<i>exc_type, exc_value, traceback</i>) |
|
306 |
|
307 <p> |
|
308 Special method called when exiting the runtime ccontext. |
|
309 </p> |
|
310 <dl> |
|
311 |
|
312 <dt><i>exc_type</i></dt> |
|
313 <dd> |
|
314 type of an exception raised in the runtime context |
|
315 </dd> |
|
316 <dt><i>exc_value</i></dt> |
|
317 <dd> |
|
318 value of an exception raised in the runtime context |
|
319 </dd> |
|
320 <dt><i>traceback</i></dt> |
|
321 <dd> |
|
322 traceback of an exception raised in the runtime |
|
323 context |
|
324 </dd> |
|
325 </dl> |
|
326 <dl> |
|
327 <dt>Return:</dt> |
|
328 <dd> |
|
329 always returns None to not suppress any exception |
|
330 </dd> |
|
331 </dl> |
|
332 <dl> |
|
333 <dt>Return Type:</dt> |
|
334 <dd> |
|
335 None |
|
336 </dd> |
|
337 </dl> |
|
338 <div align="right"><a href="#top">Up</a></div> |
|
339 <hr /> |
|
340 </body></html> |