tab
Max Reference
Open Help

tab

Tab control

Description

The tab can be used to create multiple button and multiple column displays and interfaces.

Examples

The tab object can be used to create multiple column button/toggle displays and interfaces

Arguments

None.

Attributes

activesafe [int] (default: 1)

When set to one, protects the currently active tab from text truncation.

bgcolor [4 floats]7.0.0

Background Color

button [int] (default: 0)

Toggles button mode for the tab object.

colorselectedtext [int] (default: 0)7.0.0

Use Color for Text

contrastactivetab [int] (default: 1)7.0.0

Contrasting Text Color

gradient [float] (default: 0.)

Gradient

htabcolor [4 floats]

Sets the color of the selected tab in RGBA format. The htabcolor attribute is mapped to the color style color.

margin [int] (default: 4)

Sets the text margin, in pixels, for tab text.

mode [int] (default: 0)

Sets the text tab layout mode. The modes are:

0 separate tab entries are equally spaced. This is the default.
1 separate tab entries are proportionally spaced according to the text.
Note: to add multiple words, use the backslash before a space (e.g. "one\ down")

Possible values:

0 = 'Equal Spaced'
1 = 'Proportional'

multiline [int] (default: 1)

Toggles allowing multiple lines of text in a tab. When set, you can resize the object to create multicolumn displays.

parameter_enable [int]

Enables use of this object with Max for Live Parameters and allows for setting initial parameter values in the Max environment.

rounded [float] (default: 8.)

Sets the radius, in pixels for the tab object.

segmented [int] (default: 0)

Segmented

spacing_x [float] (default: 4.)

Sets the horizontal spacing for the tab object in pixels.

spacing_y [float] (default: 4.)

Sets the vertical spacing for the tab object in pixels.

style [symbol]7.0.0

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

tabcolor [4 floats]

Sets the tab color for unselected items in RGBA format. The tabcolor attribute is mapped to the elementcolor style color.

tabs [64 symbols] (default: one two three)

Sets the tab text for each tab in the tab object.

textcolor [4 floats]

Sets the text color for the tab object when the tab is unselected in RGBA format. The textcolor attribute is mapped to the textcolor_inverse style color.

truncate [int] (default: 1)

Sets the truncation to be applied to tab text

Possible values:

0 = 'No truncation'
1 = 'Truncate from the right'
2 = 'Truncate from the middle'

valign [int] (default: 1)

Sets the vertical alignment for tabs

Possible values:

0 = 'Top'
1 = 'Center'
2 = 'Bottom'

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.

Parameter Attributes

Order

Typeint

Sets the order of recall of this parameter. Lower numbers are recalled first. The order of recall of parameters with the same order number is undefined.

Parameter Mode Enable

Typeint

Parameter Mode Enable (not available from Parameters window)

Link to Scripting Name

Typeint

When checked, the Scripting Name is linked to the Long Name attribute.

Long Name

Typesymbol

The long name of the parameter. This name must be unique per patcher hierarchy.

Short Name

Typesymbol

Sets the short name for the object's visual display. The maximum length varies according to letter width, but is generally in a range of 5 to 7 characters.

Type

Typeint

Specifies the data type. The data types used in Max for Live are:

Float
Int
Enum (enumerated list)
Blob

Note: By convention, the Live application uses floating point numbers for its calculations; the native integer representation is limited to a range of 0-255 (similar to the char data type used in Jitter). When working with Live UI objects whose integer values are likely to be outside of the 0-255 range, the Type attribute should be set to Float, and the Unit Style attribute should be set to Int.

Range/Enum

Typelist

When used with an integer or floating point data type, this field is used to specify the minimum and maximum values of the parameter.
When used with an enumerated list (Enum) data type, this field contains a space-delimited list of the enumerated values (if list items contain a space or special characters, the name should be enclosed in double quotes).

Modulation Mode

Typeint

Sets the Modulation Mode used by the Live application. The modulation modes are:

None
Unipolar
Bipolar
Additive
Absolute

Modulation Range

Typelist

This parameter is only used with the Absolute modulation mode. It specifies defines the range of values used.

Initial Enable

Typeint

When checked (set to 1), the UI object can store an initialization value. The value is set using the Initial attribute (see below).

Initial

Typelist

Sets the initial value to be stored and used when the Initial Enable attribute is checked.

Unit Style

Typeint

Sets the unit style to be used when displaying values. The unit style values are: Int: displays integer values
Float: displays floating point values
Time: displays time values in milliseconds (ms)
Hertz: displays frequency values (Hz/kHz).
deciBel: displays loudness (dB)
%: Percentage
Pan: displays Left and Right values
Semitones: displays steps (st)
MIDI: displays pitch corresponding to the MIDI note number
Custom: displays custom data type
Native: defaults to floating point values

Custom Units

Typesymbol

Sets the units to be used with the 'Custom' unit style (see "Unit Style", above). Custom unit strings may be simple symbols (e.g. "Harmonic(s)"), in which case the parameter's value will be displayed in its 'Native' display mode, followed by the symbol (e.g. "12 Harmonic(s)" for an Int-typed parameter or "12.54 Harmonic(s)" for a Float-typed parameter). For additional control over the numerical component displayed, a sprintf-style string may be used (e.g. "%0.2f Bogon(s)", which would display a value such as ".87 Bogons").

Exponent

Typefloat

When set to a value other than 1., the parameter's input and output values will be exponentially scaled according to the factor entered in this column.

Steps

Typeint

The number of steps available between the minimum and maximum values of a parameter. For instance, if the parameter has a range from 0.-64., with Steps set to 4, the user can only set the parameter to 0, 21.33, 42.66 and 64.

Parameter Visibility

Typeint

For automatable parameters (Int, Float, Enum), 'Stored Only' disables automation, although parameter values are stored in presets. 'Hidden' causes the parameter's value to be ignored when storing and recalling data. Non-automatable parameters (Blob) are 'Stored Only' by default, and can be set to 'Hidden', if desired.

Update Limit (ms)

Typeint

Speed limits values triggered by automation.

Defer Automation Output

Typeint

Defers values triggered by automation.

Messages

bang

bang message will retrigger the object's output.

int

Arguments

tab [int]
The number specifies a tab item to be sent out, and causes tab to display that item and send the index out the first outlet and the tab text out the second outlet. The items are numbered starting at 0. A tab can also be chosen with the mouse.

float

Arguments

tab [float]
Converted to int .

(mouse)

Clicking on a tab button will highlight and set the selection and send the index out the first outlet and the tab text out the second outlet.

next

Selects the next index to the tab object and causes tab to display that item and send the new index out the first outlet and the tab text out the second outlet. If the last index is currently displayed, it wraps around to the first index.

prev

Selects the previous index to the tab object and causes tab to display that item and send the new index out the first outlet and the tab text out the second outlet. If the first index is currently displayed, it wraps around to the last index.

set

Arguments

tab [list]
The word set , followed by a number, specifies a tab item to be selected, and causes tab to display that item, but does not cause any output.

setsymbol

Arguments

tab [list]
The word setsymbol , followed by a symbol that specifies a tab item, causes tab to display that item but does not send output.

symbol

Arguments

tab name [list]
The word symbol , followed by a symbol that specifies a tab item, causes tab to display that item and send the index out the first outlet and the tab text out the second outlet.

See Also

Name Description
matrixctrl Matrix switch control
pictctrl Picture-based control
pictslider Picture-based slider control
textbutton Button with text
ubutton Transparent button