Package wx :: Package lib :: Package agw :: Module balloontip :: Class BalloonTip

[frames | no frames]

## Type BalloonTip

    object --+
             |
            BalloonTip

Method Summary
| ``__init__`(self, topicon, toptitle, message, shape, tipstyle)` Default class constructor.
| ``DestroyTimer`(self)` The destruction timer has expired.
| ``EnableTip`(self, enable)` Enable/disable globally the BalloonTip.
| ``GetBalloonColour`(self)` Returns the BalloonTip background colour.
| ``GetBalloonIcon`(self)` Returns the BalloonTip top-left icon.
| ``GetBalloonMessage`(self)` Returns the BalloonTip tip message.
| ``GetBalloonShape`(self)` Returns the BalloonTip frame shape.
| ``GetBalloonTipStyle`(self)` Returns the BalloonTip tipstyle.
| ``GetBalloonTitle`(self)` Returns the BalloonTip top title.
| ``GetEndDelay`(self)` Returns the delay time after which the BalloonTip is destroyed.
| ``GetMessageColour`(self)` Returns the colour for the tip message.
| ``GetMessageFont`(self)` Returns the font for the tip message.
| ``GetStartDelay`(self)` Returns the delay time after which the BalloonTip is created.
| ``GetTarget`(self)` Returns the target window for the BalloonTip.
| ``GetTitleColour`(self)` Returns the colour for the top title.
| ``GetTitleFont`(self)` Returns the font for the top title.
| ``NotifyTimer`(self)` The creation timer has expired.
| ``OnDestroy`(self, event)` Handles the target destruction.
| ``OnTaskBarMove`(self, event)` Handles the mouse motion inside the taskbar icon.
| ``OnWidgetEnter`(self, event)` Starts the BalloonTip timer for creation.
| ``OnWidgetLeave`(self, event)` Handles the wx.EVT_LEAVE_WINDOW for the target control/window.
| ``OnWidgetMotion`(self, event)` Handle the mouse motion inside the target.
| ``SetBalloonColour`(self, colour)` Sets the BalloonTip background colour.
| ``SetBalloonIcon`(self, icon)` Sets the BalloonTip top-left icon.
| ``SetBalloonMessage`(self, message)` Sets the BalloonTip tip message.
| ``SetBalloonShape`(self, shape)` Sets the BalloonTip frame shape.
| ``SetBalloonTipStyle`(self, tipstyle)` Sets the BalloonTip tipstyle.
| ``SetBalloonTitle`(self, title)` Sets the BalloonTip top title.
| ``SetEndDelay`(self, delay)` Sets the delay time after which the BalloonTip is destroyed.
| ``SetMessageColour`(self, colour)` Sets the colour for the tip message.
| ``SetMessageFont`(self, font)` Sets the font for the tip message.
| ``SetStartDelay`(self, delay)` Sets the delay time after which the BalloonTip is created.
| ``SetTarget`(self, widget)` Sets the target control/window for the BalloonTip.
| ``SetTitleColour`(self, colour)` Sets the colour for the top title.
| ``SetTitleFont`(self, font)` Sets the font for the top title.
| ``TaskBarTimer`(self)` This timer check periodically the mouse position.

Method Details

### __init__(self, topicon=None, toptitle='', message='', shape=1, tipstyle=3)
(Constructor)

    Default class constructor.

    BalloonTip.__init__(self, topicon=none, toptitle="", message="",
                        shape=BT_ROUNDED, tipstyle=BT_LEAVE)

    Parameters:

    - topicon: an icon that will be displayed on the top-left part of the
      BalloonTip frame. if set to none, no icon will be displayed;
    - toptile: a title that will be displayed on the top part of the
      BalloonTip frame. if set to an empty string, no title will be displayed;
    - message: the tip message that will be displayed. It can not be set to
      an empty string;
    - shape: the BalloonTip shape. it can be one of:
      a) BT_RECTANGLE (a rectangle);
      b) BT_ROUNDED (rounded rectangle, the default).
    - tipstyle: the BalloonTip destruction behavior. It can be one of:
      a) BT_LEAVE: the BalloonTip is destroyed when the mouse leaves the
         target control/window;
      b) BT_CLICK: the BalloonTip is destroyed when you click on any area
         of the target control/window;
      c) BT_BUTTON: the BalloonTip is destroyed when you click on the
         top-right close button;

  Overrides:
    `__builtin__.object.__init__`

### DestroyTimer(self)

The destruction timer has expired. Destroys the BalloonTip frame.

### EnableTip(self, enable=True)

Enable/disable globally the BalloonTip.

### GetBalloonColour(self)

Returns the BalloonTip background colour.

### GetBalloonIcon(self)

Returns the BalloonTip top-left icon.

### GetBalloonMessage(self)

Returns the BalloonTip tip message.

### GetBalloonShape(self)

Returns the BalloonTip frame shape.

### GetBalloonTipStyle(self)

Returns the BalloonTip tipstyle.

### GetBalloonTitle(self)

Returns the BalloonTip top title.

### GetEndDelay(self)

Returns the delay time after which the BalloonTip is destroyed.

### GetMessageColour(self)

Returns the colour for the tip message.

### GetMessageFont(self)

Returns the font for the tip message.

### GetStartDelay(self)

Returns the delay time after which the BalloonTip is created.

### GetTarget(self)

Returns the target window for the BalloonTip.

### GetTitleColour(self)

Returns the colour for the top title.

### GetTitleFont(self)

Returns the font for the top title.

### NotifyTimer(self)

The creation timer has expired. creates the BalloonTip frame.

### OnDestroy(self, event)

Handles the target destruction.

### OnTaskBarMove(self, event)

Handles the mouse motion inside the taskbar icon.

### OnWidgetEnter(self, event)

Starts the BalloonTip timer for creation.

### OnWidgetLeave(self, event)

Handles the wx.EVT_LEAVE_WINDOW for the target control/window.

If the BalloonTip tipstyle is set to BT_LEAVE, the BalloonTip is destroyed.

### OnWidgetMotion(self, event)

Handle the mouse motion inside the target.

This prevents the annoying behavior of BalloonTip to display when the user does something else inside the window. The BalloonTip window is displayed only when the mouse does not move for the start delay time.

### SetBalloonColour(self, colour=None)

Sets the BalloonTip background colour.

### SetBalloonIcon(self, icon)

Sets the BalloonTip top-left icon.

### SetBalloonMessage(self, message)

Sets the BalloonTip tip message. it should not be empty.

### SetBalloonShape(self, shape=1)

Sets the BalloonTip frame shape.

it should be one of bt_rounded, bt_rectangle.

### SetBalloonTipStyle(self, tipstyle=3)

Sets the BalloonTip tipstyle.

It should be one of BT_LEAVE, BT_CLICK, BT_BUTTON.

### SetBalloonTitle(self, title='')

Sets the BalloonTip top title.

### SetEndDelay(self, delay=1000000.0)

Sets the delay time after which the BalloonTip is destroyed.

### SetMessageColour(self, colour=None)

Sets the colour for the tip message.

### SetMessageFont(self, font=None)

Sets the font for the tip message.

### SetStartDelay(self, delay=1)

Sets the delay time after which the BalloonTip is created.

### SetTarget(self, widget)

Sets the target control/window for the BalloonTip.

### SetTitleColour(self, colour=None)

Sets the colour for the top title.

### SetTitleFont(self, font=None)

Sets the font for the top title.

### TaskBarTimer(self)

This timer check periodically the mouse position.

If the current mouse position is sufficiently far from the coordinates it had when entered the taskbar icon and the BalloonTip style is BT_LEAVE, the BalloonTip frame is destroyed.

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