wx.BusyInfo¶

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

Normally the main thread should always return to the main loop to continue dispatching events as quickly as possible, hence this class shouldn’t be needed. However if the main thread does need to block, this class provides a simple way to at least show this to the user: just create a wx.BusyInfo object on the stack, and within the current scope, a message window will be shown.

For example:

# Normal usage
wait = wx.BusyInfo("Please wait, working...")
for i in range(10000):
    DoACalculation()
del wait

# It can be used as a context manager too
with wx.BusyInfo("Please wait, working..."):
    for i in range(10000):
    DoACalculation()

It works by creating a window in the constructor, and deleting it in the destructor.

This window is rather plain by default but can be customized by passing wx.BusyInfo constructor an object of wx.BusyInfoFlags class instead of a simple message. Here is an example from the dialogs sample:

info = wx.BusyInfo(
         wx.BusyInfoFlags()
             .Parent(self)
             .Icon(wx.ArtProvider.GetIcon(wx.ART_PRINT,
                                          wx.ART_OTHER, wx.Size(128, 128)))
             .Title("<b>Printing your document</b>")
             .Text("Please wait...")
             .Foreground(wx.WHITE)
             .Background(wx.BLACK)
             .Transparency(4 * wx.ALPHA_OPAQUE / 5)
     )

This shows that separate title and text can be set, and that simple markup ( wx.Control.SetLabelMarkup ) can be used in them, and that it’s also possible to add an icon and customize the colours and transparency of the window.

You may also want to call TheApp.Yield() to refresh the window periodically (in case it had been obscured by other windows, for example) like this:

with wx.WindowDisabler():
    wait = wx.BusyInfo("Please wait, working...")

    for i in range(100000):
        DoACalculation()

        if not (i % 1000):
            wx.GetApp().Yield()

but take care to not cause undesirable reentrancies when doing it (see wx.App.Yield for more details). The simplest way to do it is to use wx.WindowDisabler class as illustrated in the above example.

Note that a wx.BusyInfo is always built with the STAY_ON_TOP window style (see wx.Frame window styles for more info).

Class Hierarchy¶

Inheritance diagram for class BusyInfo:

Methods Summary¶

`__init__`	General constructor.
`UpdateLabel`	Same as `UpdateText` but doesn’t interpret the string as containing markup.
`UpdateText`	Update the information text.
`__enter__`
`__exit__`

Class API¶

class wx.BusyInfo(object)¶

Possible constructors:

BusyInfo(flags)

BusyInfo(msg, parent=None)

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

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self, flags)

General constructor.

This constructor allows specifying all supported attributes by calling the appropriate methods on wx.BusyInfoFlags object passed to it as parameter. All of them are optional but usually at least the message should be specified.

Parameters:: flags (wx.BusyInfoFlags) –

New in version 4.1/wxWidgets-3.1.0.

__init__ (self, msg, parent=None)

Simple constructor specifying only the message and the parent.

This constructs a busy info window as child of parent and displays msg in it. It is exactly equivalent to using

wait = wx.BusyInfo(wx.BusyInfoFlags().Parent(parent).Label(message))

Parameters:

msg (string) –
parent (wx.Window) –

Note

If parent is not None you must ensure that it is not closed while the busy info is shown.

UpdateLabel(self, str)¶

Same as UpdateText but doesn’t interpret the string as containing markup.

Parameters:: str (string) –

New in version 4.1/wxWidgets-3.1.3.

UpdateText(self, str)¶

Update the information text.

The text string may contain markup as described in wx.Control.SetLabelMarkup .

Parameters:: str (string) –