PA_CreateTip


version 2003


PA_CreateTip (tipContent; posX; posY; objectRect)

Parameter Type Description
tipContent char * Content of the tip to draw
posX short Left local coordinate of the tip (window)
posY short Top local coordinate of the tip
objectRect PA_Rect Rectangle(local) where the tip is valid

Description

The routine PA_CreateTip creates a tip window.

tipContent

is the string that will be displayed.

If posX and posY are both equal to zero, the tip window will be at 16 pixels South East from mouse position by default.

objectRect

is the area of the object described by the tip. If the user moves the mouse outside of this rectangle, the tip window will be closed.

The tip window will also close after a certain delay. If a tip was opened before this call, it will be closed.

All coordinates are expressed in local coordinates of the window.

Depending on default settings or on previous calls to PA_UsePStrings or PA_UseCStrings , tipContent will be a Pascal or an ANSI C string.

NOTE

The tip is "temporary" and not saved in the structure like a "regular" tip created in the Design environment.

Example

   PA_Rect   r = {100, 100, 120, 185}; // Local coordinates of a "Save" button
   PA_CreateTip("Close the window, saving changes", 0, 0, r);

See Also

No reference.

Error Handling

PA_GetLastError

always returns eER_NoErr