File: wx.BusyCursor.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (130 lines) | stat: -rw-r--r-- 3,349 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.BusyCursor:

==========================================================================================================================================
|phoenix_title|  **wx.BusyCursor**
==========================================================================================================================================

This class makes it easy to tell your user that the program is temporarily busy.          

Just create a :ref:`wx.BusyCursor`  object on the stack, and within the current scope, the hourglass will be shown. 

For example: 

::

        wait = wx.BusyCursor()

        for i in xrange(10000):
            DoACalculation()

        del wait



It works by calling :ref:`wx.BeginBusyCursor`  in the constructor, and :ref:`wx.EndBusyCursor`  in the destructor. 







         



.. seealso:: :ref:`wx.BeginBusyCursor`, :ref:`wx.EndBusyCursor`, :ref:`wx.WindowDisabler`    







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>BusyCursor</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.BusyCursor_inheritance.png" alt="Inheritance diagram of BusyCursor" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.BusyCursor.html" title="wx.BusyCursor" alt="" coords="5,5,120,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.BusyCursor.__init__`                                                  Constructs a busy cursor object, calling :ref:`wx.BeginBusyCursor`.
:meth:`~wx.BusyCursor.__enter__`                                                 
:meth:`~wx.BusyCursor.__exit__`                                                  
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.BusyCursor(object)

   **Possible constructors**::

       BusyCursor(cursor=HOURGLASS_CURSOR)
       
   
   This class makes it easy to tell your user that the program is
   temporarily busy.



   .. method:: __init__(self, cursor=HOURGLASS_CURSOR)

      Constructs a busy cursor object, calling :ref:`wx.BeginBusyCursor`.                  


      :param `cursor`: 
      :type `cursor`: wx.Cursor







   .. method:: __enter__(self)




   .. method:: __exit__(self, exc_type, exc_val, exc_tb)