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