hint

Pop-up style hint text

Description

When you mouse over a hint, you'll see a message appear on the screen below the area defined by the hint. The hint object has a number of messages you can use to change its appearance. In addition, you can select a hint object and set its font and font size using the Font menu, or use its Get Info... dialog to apply other settings.

Arguments

None.

Messages

int enable/disable-flag (0 or non-zero) [int]
A 0 will disable any hinting while a non-zero number will enable it.
float enable/disable-flag (0 or non-zero) [float]
Converted to int.
(mouse) When the cursor moves within the hint object's rectangle, its text message will appear in a colored area beneath the rectangle after the specified delay.
set message [symbol]
The word set, followed by any message, will replace the message stored in hint. This message will be displayed when the mouse is positioned over the hint object after an interval of time specified by the delay message.

Attributes

Name Type g/s Description
delay int
def.:0
Sets the delay in milliseconds until the hint appears.
enabled int
def.:1
Toggles enabling display of hint text.

Information for box attributes common to all objects

Output

message: The message stored in the hint object.

Examples

Provide optional hints to UI objects

See Also

Name Description
comment Explanatory note or label
umenu Pop-up menu, to display and send commands