phoenix_title wx.BusyInfoFlags

Parameters for wx.BusyInfo.

This class exists only in order to make passing attributes to wx.BusyInfo constructor easier and the code doing it more readable.

All methods of this class return the reference to the object on which they are called, making it possible to chain them together, e.g. typically you would just create a temporary wx.BusyInfoFlags object and then call the methods corresponding to the attributes you want to set, before finally passing the result to wx.BusyInfo constructor, e.g.:

info = wx.BusyInfo(
        wx.BusyInfoFlags()
            .Parent(window)
            .Icon(icon)
            .Title("Some text")
            .Text("Some more text")
            .Foreground(wx.Colour(...))
            .Background(wx.Colour(...))
   )

New in version 4.1/wxWidgets-3.1.0.


class_hierarchy Class Hierarchy

Inheritance diagram for class BusyInfoFlags:

method_summary Methods Summary

__init__

Default constructor initializes all attributes to default values.

Background

Sets the background colour of wx.BusyInfo window.

Foreground

Sets the foreground colour of the title and text strings.

Icon

Sets the icon to show in wx.BusyInfo.

Label

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

Parent

Sets the parent for wx.BusyInfo.

Text

Sets the more detailed text, shown under the title, if any.

Title

Sets the title, shown prominently in wx.BusyInfo window.

Transparency

Sets the transparency of wx.BusyInfo window.


api Class API

class wx.BusyInfoFlags(object)

Possible constructors:

BusyInfoFlags()

Parameters for BusyInfo.


Methods

__init__(self)

Default constructor initializes all attributes to default values.

Call the other methods to really fill in the object.



Background(self, background)

Sets the background colour of wx.BusyInfo window.

Parameters:

background (wx.Colour) –

Return type:

wx.BusyInfoFlags



Foreground(self, foreground)

Sets the foreground colour of the title and text strings.

Parameters:

foreground (wx.Colour) –

Return type:

wx.BusyInfoFlags



Icon(self, icon)

Sets the icon to show in wx.BusyInfo.

Parameters:

icon (wx.Icon) –

Return type:

wx.BusyInfoFlags



Label(self, label)

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

This method should be used if the text shown in wx.BusyInfo comes from external source and so may contain characters having special meaning in simple markup, e.g. ‘<’.

Parameters:

label (string) –

Return type:

wx.BusyInfoFlags



Parent(self, parent)

Sets the parent for wx.BusyInfo.

Parameters:

parent (wx.Window) –

Return type:

wx.BusyInfoFlags



Text(self, text)

Sets the more detailed text, shown under the title, if any.

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

Parameters:

text (string) –

Return type:

wx.BusyInfoFlags



Title(self, title)

Sets the title, shown prominently in wx.BusyInfo window.

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

Parameters:

title (string) –

Return type:

wx.BusyInfoFlags



Transparency(self, alpha)

Sets the transparency of wx.BusyInfo window.

Parameters:

alpha (wx.Byte) – Value in wx.ALPHA_TRANSPARENT (0) to wx.ALPHA_OPAQUE (255) range.

Return type:

wx.BusyInfoFlags