Package wx :: Package lib :: Package agw :: Module toasterbox :: Class ToasterBoxWindow

[frames | no frames]

## Type ToasterBoxWindow

    object --+
             |
        Object --+
                 |
        EvtHandler --+
                     |
                Window --+
                         |
            TopLevelWindow --+
                             |
                         Frame --+
                                 |
                                ToasterBoxWindow

Method Summary
| ``__init__`(self, parent, parent2, tbstyle, windowstyle, closingstyle, scrollType)` Default class constructor.
| ``AddPanel`(self, panel)` Adds a panel to the ToasterBox.
| `DrawText(self)`
| ``GetPopupText`(self)` Returns the ToasterBox text.
| ``NotifyTimer`(self, event)` Hides gradually the ToasterBoxWindow.
| `OnClose(self, event)`
| `OnMouseDown(self, event)`
| ``Play`(self)` Creates the ToasterBoxWindow, that does all the job.
| ``ScrollDown`(self)` Scrolls the ToasterBox down, which means gradually hiding the ToasterBox.
| ``ScrollUp`(self)` Scrolls the ToasterBox up, which means gradually showing the ToasterBox.
| ``SetPopupBackgroundColor`(self, colour)` Sets the ToasterBox background colour.
| ``SetPopupBitmap`(self, bitmap)` Sets the ToasterBox background image.
| ``SetPopupPauseTime`(self, pausetime)` Sets the time after which the ToasterBox is destroyed (linger).
| ``SetPopupPosition`(self, pos)` Sets the ToasterBox position on screen.
| ``SetPopupPositionByInt`(self, pos)` Sets the ToasterBox position on screen, at one of the screen corners.
| ``SetPopupScrollSpeed`(self, speed)` Sets the ToasterBox scroll speed.
| ``SetPopupSize`(self, size)` Sets the ToasterBox size.
| ``SetPopupText`(self, text)` Sets the ToasterBox text.
| ``SetPopupTextColor`(self, colour)` Sets the ToasterBox foreground colour.
| ``SetPopupTextFont`(self, font)` Sets the ToasterBox text font.

Property Summary

Instance Method Details

### __init__(self, parent, parent2, tbstyle, windowstyle, closingstyle, scrollType=2)
(Constructor)

Default class constructor.

Used internally. Do not call directly this class in your application!

  Overrides:
    `wx.Frame.__init__`

### AddPanel(self, panel)

Adds a panel to the ToasterBox. Use it only for ToasterBoxes created with TB_COMPLEX style.

### GetPopupText(self)

Returns the ToasterBox text. Use it only for ToasterBoxes created with TB_SIMPLE style.

### NotifyTimer(self, event)

Hides gradually the ToasterBoxWindow.

### Play(self)

Creates the ToasterBoxWindow, that does all the job.

### ScrollDown(self)

Scrolls the ToasterBox down, which means gradually hiding the ToasterBox.

### ScrollUp(self)

Scrolls the ToasterBox up, which means gradually showing the ToasterBox.

### SetPopupBackgroundColor(self, colour)

Sets the ToasterBox background colour. Use it only for ToasterBoxes created with TB_SIMPLE style.

### SetPopupBitmap(self, bitmap)

Sets the ToasterBox background image. Use it only for ToasterBoxes created with TB_SIMPLE style.

### SetPopupPauseTime(self, pausetime)

Sets the time after which the ToasterBox is destroyed (linger).

### SetPopupPosition(self, pos)

Sets the ToasterBox position on screen.

### SetPopupPositionByInt(self, pos)

Sets the ToasterBox position on screen, at one of the screen corners.

### SetPopupScrollSpeed(self, speed)

Sets the ToasterBox scroll speed. The speed parameter is the pause time (in ms) for every step in the ScrollUp() method.

### SetPopupSize(self, size)

Sets the ToasterBox size.

### SetPopupText(self, text)

Sets the ToasterBox text. Use it only for ToasterBoxes created with TB_SIMPLE style.

### SetPopupTextColor(self, colour)

Sets the ToasterBox foreground colour. Use it only for ToasterBoxes created with TB_SIMPLE style.

### SetPopupTextFont(self, font)

Sets the ToasterBox text font. Use it only for ToasterBoxes created with TB_SIMPLE style.

Generated by Epydoc 2.1.20050511.rpd on Mon Feb 16 12:54:01 2009 | http://epydoc.sf.net