.. wxPython Phoenix documentation

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

   Copyright: (c) 2011-2025 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: 

::

        # Normal usage
        wait = wx.BusyCursor()
        for i in range(10000):
            DoACalculation()
        del wait

        # It can be used as a context manager too
        with wx.BusyCursor():
            for i in range(10000):
                DoACalculation()



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








         



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







|

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

.. raw:: html

   <div class="collabsible-wrapper">
      <input id="collapsible-inheritance" class="collapsible-checkbox" type="checkbox">
      <label for="collapsible-inheritance" tabindex="0" title="Show inheritance diagram" class="collapsible-label">Inheritance diagram for class <strong>BusyCursor</strong>:</label>
      <div class="collapsible-content">
         <p class="graphviz">
            <center><img src="_static/images/inheritance/wx.BusyCursor_inheritance.svg" alt="Inheritance diagram of BusyCursor" usemap="#dummy" class="inheritance invert-in-dark-mode"/></center>
            <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.BusyCursor.html" title="This class makes it easy to tell your user that the program is temporarily busy." alt="" coords="5,5,142,34"/> </map> 
         </p>
      </div>
   </div>
   <script type="text/javascript" src="_static/inheritancetoggle.js"></script>



|


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

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


|


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


.. class:: wx.BusyCursor(object)

   **Possible constructors**::

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



   .. method:: __init__(self, *args, **kw)



      |overload| **Overloaded Implementations:**

      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self, cursor=HOURGLASS_CURSOR)`
      
      Constructs a busy cursor object, calling `wx.BeginBusyCursor`     . 
                       
      
      
      :param `cursor`: 
      :type `cursor`: wx.Cursor
      
      
      
      
      :rtype: `None`     
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self, cursors)`
      
      Constructs a busy cursor object, calling `wx.BeginBusyCursor`       with the given cursor bundle. 
                       
      
      
                      
      
      
      :param `cursors`: 
      :type `cursors`: wx.CursorBundle
      
      
      
      
      :rtype: `None`     
      
      
      
      
      
      
      
      .. versionadded:: 4.3/wxWidgets-3.3.0  
           
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`






   .. method:: __enter__(self)




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