BubbleCall()

NAME

BubbleCall - Display a bubble help.

PROTOTYPAGE

int BubbleCall( char *help, int x, int y);

PARAMETERS

help:

pointeur to the string to display in a bubble,

x,y:

coordinates of the bubble (use the mouse position),

return:

0 si no error,

ERROR CODE

BubbleCall() returns a code error.

0:

no error,

-1:

BubbleGEM not in memory,

-2:

the environ variable 'BUBBLE=' or 'BUBBLEGEM=' are incorrects,

-3:

no more memory,

DESCRIPTION

BubbleCall() sends a message to BUBBLE.APP to display a bubble help. If BUBBLE.APP is not loaded, BubbleCall() tries to load it using the PATH or BUBBLE or BUBBLEGEM environ variables. This function just display a bubble help. It is possible to attach a bubble help to an object from a formular or a toolbar and display them systematically. For that purpose, see the BubbleAttach() and BubbleEvnt() functions.

REMARKS

A '|' character forces a carriage return inside the bubble help.

The AES should not be stopped, that is the case with classic formulars which make use of wind_update() function, when the BubbleCall() function is invoked. However, it is possible to call BubbleGEM from a classic formular with the BubbleModal() function.

SEE ALSO

(!url [The BubbleGEM documentation] [BUBBLE.HYP]), BubbleAttach(), BubbleEvnt(), BubbleFree(), BubbleConf().