Steve Sherwood > xisofs > Tk::Bubble

Download:
xisofs-1.3.tar.gz

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Source  

NAME ^

Tk::Bubble - Pop up help windows

SYNOPSYS ^

use Tk::Bubble;

...

$bubble = new Bubble(<options..>);

$bubble->attach(<widget>,<options>);

$bubble->configure(<widget>,<options>);

DESCRIPTION ^

Bubble is a bubble help system (or sometimes called tooltips/balloon help) which allows a window to be displayed after a certain amount of time. This window will vanish if the mouse is moved or a button is pressed.

CREATE OBJECT ^

To use the bubble help, a new bubble object must first be created. $bubble = new Bubble(options);. The following options are available and will be used as defaults for any popup windows created with this object.

-background

Specifies the background colour of the window. The default is 'red'.

-bordercolour

Specifies the colour of the border around the popup window. The default is 'black'.

-bordersize

Specifies the size of the border around the popup window in pixels. The default is 1.

-contents

This specifies how the window will be drawn. full which is the default will draw the popup window using the parameters supplied. partial will draw the border and the inner window as specified, but not add any text. none will simply create the framework for the popup button, but not actually create anything. This option is useful if you have a complex popup window to draw, as the attach will return the innermost object which can be use to add any other objects.

-delay

This is the delay in milliseconds before the window is displayed. The default is 1000.

-font

This is the font to be used for the text. The default is 'fixed'.

-foreground

This is the foreground colour for the popup window. The default is 'white'.

-icon

This will add an icon to the popup window. It must be an XPM image. It will be aligned in the window as specified by -iconalign. The default is no icon.

-iconalign

This specifies the alignment of the icon. It can be one of left, right, top and bottom. The default is 'left'.

-relief

This specifies the relief of the window inside the border. It can be any of the normally support relief values and by default is 'flat'.

-state

This is either normal or disabled. This affects all popup windows in this object and the default is 'normal'.

-xoffset

This is how many pixels in the x direction the popup window is offset from the mouse pointer. The default is 12.

-yoffset

This is how many pixels in the y direction the popup window is offset from the mouse pointer. The default is 12.

AUTHOR ^

Steve Sherwood <pariah@netcomuk.co.uk>

syntax highlighting: