hint
Max Reference
Open Help

hint

Display 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.

Examples

Provide optional hints to UI objects

Discussion

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.

Attributes

delay [int] (default: 0)

Sets the delay in milliseconds until the hint appears. A value of 0 sets a default delay time, usually about 500 ms.

enabled [int] (default: 1)

Toggles enabling display of hint text.

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic

Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points).

Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [float]

Sets the color for the object's text in RGBA format.

textjustification [int]

Text Justification

Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

int

Arguments

enable [int]
0 will disable any hinting while a non-zero number will enable it.

float

Arguments

enable [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

Arguments

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.

Output

message

The message stored in the hint object.

See Also

Name Description
comment Explanatory note or label
umenu Pop-up menu