Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

Balloon Class Reference

Inheritance diagram for Balloon:

Inheritance graph
[legend]
Collaboration diagram for Balloon:

Collaboration graph
[legend]
List of all members.

Detailed Description

Balloon - A tooltip class. This is a generic tooltip implementation. Just create a Balloon and switch it on() now and then. A Balloon is displayed if the mouse pointer does not leave the area where it has been initialized within 200 milliseconds by default.

Author:
Michael Daum
Id
Balloon.tcl,v 1.8 2004/02/25 14:42:08 micha Exp

Definition at line 22 of file Balloon.tcl.

Public Member Functions

 Balloon (TclList args)
 delay (TclNumber value=200)
 off ()
 on (TclNumber x, TclNumber y, TclString text)

Private Member Functions

 _doit (TclNumber x, TclNumber y)

Private Attributes

TclNumber balloonId = 0


Constructor & Destructor Documentation

Balloon::Balloon TclList  args  ) 
 

constructor

Definition at line 42 of file Balloon.tcl.


Member Function Documentation

Balloon::_doit TclNumber  x,
TclNumber  y
[private]
 

do the actuall display. This method is only called by Balloon::on() when the tcl loop gets idle.

Parameters:
x the x coordinate where the balloon will be displayed
y the y coordinate where the balloon will be displayed
Definition at line 90 of file Balloon.tcl.

Balloon::off  ) 
 

hide a tooltip. Call this method to switch off the tooltip balloon. Definition at line 69 of file Balloon.tcl.

Balloon::on TclNumber  x,
TclNumber  y,
TclString  text
 

show a tooltip. This method actually displays a tooltip with a certain message and position.

Parameters:
x the x coordinate where the balloon will be displayed
y the y coordinate where the balloon will be displayed
text the message text to be shown inside the tooltip
Definition at line 125 of file Balloon.tcl.


Member Data Documentation

TclNumber Balloon::balloonId = 0 [private]
 

id of the background job. When a balloon is going to be displayed we spawn a job with after and store the job id in this variable. Definition at line 36 of file Balloon.tcl.


The documentation for this class was generated from the following file:
YADA 2.0-alpha (20 Oct 2004)