ToasterBox is a cross-platform widget to make the creation of MSN style “toaster” popups easier.
__init__ | Default class constructor. |
AddPanel | Adds a panel to the ToasterBox. |
CenterOnParent | Centres the window on its parent (if any). |
CenterOnScreen | Centres the ToasterBox on screen. |
CentreOnParent | Centres the window on its parent (if any). |
CentreOnScreen | Centres the ToasterBox on screen. |
CleanList | Cleans the window list, erasing the stack of ToasterBox objects. |
GetToasterBoxWindow | Returns the ToasterBox frame. |
GetUseFocus | Returns whether ToasterBox will steal the focus from the parent application. |
MoveAbove | If a ToasterBox already exists, move the new one above the existing one. |
Notify | It’s time to hide a ToasterBox. |
OnMoveTimer | Handles the wx.EVT_TIMER event for ToasterBox, moving the new window |
Play | Creates the ToasterBoxWindow, that does all the job. |
SetPopupBackgroundColour | Sets the ToasterBox background colour. |
SetPopupBitmap | Sets the ToasterBox background image. |
SetPopupPauseTime | Sets the time after which the ToasterBox is destroyed (linger). |
SetPopupPosition | Sets the ToasterBox position on screen. |
SetPopupPositionByInt | Sets the ToasterBox position on screen, at one of the screen corners. |
SetPopupScrollSpeed | Sets the ToasterBox scroll speed. |
SetPopupSize | Sets the ToasterBox size. |
SetPopupText | Sets the ToasterBox text label. |
SetPopupTextColour | Sets the ToasterBox foreground colour. |
SetPopupTextFont | Sets the ToasterBox text font. |
SetTitle | Sets the ToasterBox title if it was created with TB_CAPTION window style. |
SetUseFocus | If focus is True, Instructs ToasterBox to steal the focus from the |
ToasterBox is a cross-platform widget to make the creation of MSN style “toaster” popups easier.
Default class constructor.
Parameters: |
|
---|
Adds a panel to the ToasterBox.
Parameters: | panel – an instance of wx.Window. |
---|
Note
Use this method only for a ToasterBox created with the TB_COMPLEX style.
Centres the window on its parent (if any). If the ToasterBox parent is None, it calls CenterOnScreen.
Parameters: | direction – specifies the direction for the centering. May be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. |
---|
Note
This methods provides for a way to center ToasterBox over their parents instead of the entire screen. If there is no parent, then behaviour is the same as CenterOnScreen.
See also
Centres the ToasterBox on screen.
Parameters: | direction – specifies the direction for the centering. May be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. |
---|
See also
Centres the window on its parent (if any). If the ToasterBox parent is None, it calls CenterOnScreen.
Parameters: | direction – specifies the direction for the centering. May be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. |
---|
Note
This methods provides for a way to center ToasterBox over their parents instead of the entire screen. If there is no parent, then behaviour is the same as CenterOnScreen.
See also
Centres the ToasterBox on screen.
Parameters: | direction – specifies the direction for the centering. May be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. |
---|
See also
Cleans the window list, erasing the stack of ToasterBox objects.
Returns the ToasterBox frame.
Returns whether ToasterBox will steal the focus from the parent application.
If a ToasterBox already exists, move the new one above the existing one.
Parameters: | tb – another instance of ToasterBox. |
---|
It’s time to hide a ToasterBox.
Handles the wx.EVT_TIMER event for ToasterBox, moving the new window on top of the last one created.
Parameters: | event – a wx.TimerEvent event to be processed. |
---|
Creates the ToasterBoxWindow, that does all the job.
Sets the ToasterBox background colour.
Parameters: | colour – a valid wx.Colour object. If defaulted to None, then the background colour will be white. |
---|
Note
Use this method only for a ToasterBox created with the TB_SIMPLE style.
Sets the ToasterBox background image.
Parameters: | bitmap – a valid wx.Bitmap object or filename. If defaulted to None, then no background bitmap is used. |
---|
Note
Use this method only for a ToasterBox created with the TB_SIMPLE style.
Sets the time after which the ToasterBox is destroyed (linger).
Parameters: | pausetime – the delay after which the control is destroyed, in seconds. |
---|
Sets the ToasterBox position on screen.
Parameters: | pos – the widget position, an instance of wx.Point. |
---|
Sets the ToasterBox position on screen, at one of the screen corners.
Parameters: | pos – an integer specifying the screen corner, namely:
|
---|
Sets the ToasterBox scroll speed.
Parameters: | speed – it is the pause time (in milliseconds) for every step in the ScrollUp method. |
---|
Sets the ToasterBox size.
Parameters: | size – the new control size, an instance of wx.Size. |
---|
Sets the ToasterBox text label.
Parameters: | text – the widget label. |
---|
Note
Use this method only for a ToasterBox created with the TB_SIMPLE style.
Sets the ToasterBox foreground colour.
Parameters: | colour – a valid wx.Colour object. If defaulted to None, then the background colour will be black. |
---|
Note
Use this method only for a ToasterBox created with the TB_SIMPLE style.
Sets the ToasterBox text font.
Parameters: | colour – a valid wx.Colour object. If defaulted to None, then a simple generic font will be generated. |
---|
Note
Use this method only for a ToasterBox created with the TB_SIMPLE style.
Sets the ToasterBox title if it was created with TB_CAPTION window style.
Parameters: | title – the ToasterBox caption title. |
---|
If focus is True, Instructs ToasterBox to steal the focus from the parent application, otherwise it returns the focus to the original owner.
Parameters: | focus – True to set the focus on ToasterBox, False to return it to the original owner. |
---|