attrui
Max Reference
Open Help

attrui

Inspect attributes

Description

Use attrui object to inspect the attribute values of the object(s) it is connected to.

Examples

Arguments

OBJARG_NAME [OBJARG_TYPE]

Attributes

algin [atom]

TEXT_HERE

attr [symbol] (default: nothing)

Set the name of the inspected attribute. You can also click in the attribute name to display a popup menu which contains every common attributes.

attr_display [int] (default: 0)

Attribute Display

Possible values:

0 = 'Name'
1 = 'Label'

attrfilter [64 symbols] (default: none)

Set the names of the attribute you want to display in the popup menu. This is particularly useful for objects which have a lot of attributes.

bgcolor [4 floats]

Set the background color

displaymode [int] (default: 0)

Set the way of displaying the attribute value

Possible values:

0 = 'Automatic'
1 = 'Single Number (int)'
2 = 'Single Number (float)'
3 = 'Multi Number (int)'
4 = 'Multi Number (float)'
5 = 'List'
6 = 'Color (RGBA)'
7 = 'Color (ARGB)'
8 = 'Checkbox'

htricolor [4 floats]

Set the highlighted triangle color (when the numbers are focused)

lock [int] (default: 0)

Prevent you from changing the attribute by clicking in the attribute name

menu_display [int] (default: 0)

Menu Display

Possible values:

0 = 'Label'
1 = 'Name'
2 = 'Label & Attribute'

orientation [atom_long] (default: 0)

Display attrui horizontally or vertically

Possible values:

0 = 'Horizontal'
1 = 'Vertical'

showcaption [int]

Display attribute label on mouse over

style [symbol]7.0.0

Sets the style to be applied to the object. Styles can be set using the Format palette.

text_width [float] (default: 100.)

Set the with of the attribute name in horizontal mode. You can also click and drag in the middle line to change it.

textcolor [4 floats]

Set the text color

textjustification [int] (default: 0)7.0.0

Text Justification

Possible values:

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

tricolor [4 floats]

Triangle Color

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

input [int]
Set the value of the currently selected attribute to every objects attrui is connected to.

float

Arguments

input [float]
See the int listing

list

Arguments

input [any]
See the int listing

anything

Arguments

input [any]
See the int listing

(mouse)

Click in the attribute name to choose an attribute from the popup menu to inspect (only the common attribute for every connected object appears). Interact with the numbers, text input to change the value(s) of the selected attribute.

See Also

Name Description
getattr Query object attributes
pattr Provide an alias with a named data wrapper