Package wx :: Package lib :: Package agw :: Module toasterbox :: Class ToasterBox
[frames | no frames]

Type ToasterBox

object --+            
         |            
    Object --+        
             |        
    EvtHandler --+    
                 |    
             Timer --+
                     |
                    ToasterBox


Method Summary
  __init__(self, parent, tbstyle, windowstyle, closingstyle, scrollType)
Default class constructor.
  AddPanel(self, panel)
Adds a panel to the ToasterBox.
  CleanList(self)
Clean the window list.
  GetToasterBoxWindow(self)
Returns the ToasterBox frame.
  MoveAbove(self, tb)
If a ToasterBox already exists, move the new one above.
  Notify(self)
It's time to hide a ToasterBox!
  Play(self)
Creates the ToasterBoxWindow, that does all the job.
  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.
  SetTitle(self, title)
Sets the ToasterBox title if it was created with TB_CAPTION window style.

Property Summary

Method Details

__init__(self, parent, tbstyle=1, windowstyle=33587202, closingstyle=1, scrollType=2)
(Constructor)

Default class constructor.

ToasterBox.__init__(self, tbstyle=TB_SIMPLE, windowstyle=DEFAULT_TB_STYLE)

Parameters:

- tbstyle: this parameter may have 2 values:
  (a) TB_SIMPLE: a simple ToasterBox, with background image and text
      customization can be created;
  (b) TB_COMPLEX: ToasterBoxes with different degree of complexity can
      be created. You can add as many controls as you want, provided
      that you call the AddPanel() method and pass to it a dummy frame
      and a wx.Panel. see the demo for details.

- windowstyle: this parameter influences the visual appearance of ToasterBox:
  (a) DEFAULT_TB_STYLE: default style, no caption nor close box;
  (b) TB_CAPTION: ToasterBox will have a caption, with the possibility to
      set a title for ToasterBox frame, and a close box;

- closingstyle: set this value to TB_ONCLICK if you want to be able to close
  ToasterBox by a mouse click anywhere in the ToasterBox frame.
Overrides:
wx.Timer.__init__

AddPanel(self, panel)

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

CleanList(self)

Clean the window list.

GetToasterBoxWindow(self)

Returns the ToasterBox frame.

MoveAbove(self, tb)

If a ToasterBox already exists, move the new one above.

Notify(self)

It's time to hide a ToasterBox!

Overrides:
wx.Timer.Notify

Play(self)

Creates the ToasterBoxWindow, that does all the job.

SetPopupBackgroundColor(self, colour=None)

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

SetPopupBitmap(self, bitmap=None)

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=None)

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

SetPopupTextFont(self, font=None)

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

SetTitle(self, title)

Sets the ToasterBox title if it was created with TB_CAPTION window style.


Generated by Epydoc 2.1.20050511.rpd on Mon Feb 16 12:52:34 2009 http://epydoc.sf.net