live.text Reference

A user interface button/toggle

live.text

Description

live.text object is a user interface object used to create buttons and toggles.

Examples

Arguments

None.

Attributes

active [int] (default: 1)

Toggles the object's active mode. When active is set to 0, the mouse action does not cause output and the inactive colors are used.

activebgcolor [4 floats]

Sets the background color off displayed when the active attribute is set to 1.

activebgoncolor [4 floats]

Sets the background color on displayed when the active attribute is set to 1.

activetextcolor [4 floats]

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

activetextoncolor [4 floats]

Sets the display color for the live.text object's text when it is on.

annotation_name [symbol] (default: )

The string that is prepended to annotations. This shows up in the Info pane in Live, and the clue window in Max.

appearance [int] (default: 0)

Defines the display style. The options are:

0: Default. The text appears with the boundaries of the text box.
1: Label. The text box appears as a square button, with the text appearing to the right.
2: LCD. The text appears with the boundaries of the text box.

Possible values:

0 = 'Default'
1 = 'Label'
2 = 'LCD'

automation [symbol] (default: val1)

Sets the automation "off" label that will appear in Live.

automationon [symbol] (default: val2)

Sets the automation on label that will appear in Live.

bgcolor [4 floats]

Sets the background color "off" displayed when the active attribute is set to 0.

bgoncolor [4 floats]

Sets the background color on displayed when the active attribute is set to 0.

blinktime [int] (default: 100)

Blink Time in Milliseconds

bordercolor [4 floats]

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

focusbordercolor [4 floats]

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

inactivelcdcolor [4 floats]8.0.0

Sets the display color in the RGBA format for the live.text object in LCD mode when the active attribute is set to 0. In the off state this sets the text color, while in the on state it sets the background color.

labeltextcolor [4 floats]8.0.0

Sets the display color for the live.text object's text when it is in the label display mode.

lcdbgcolor [4 floats]8.0.0

Sets the display color in the RGBA format for the live.text object in LCD mode. In the off state this sets the background color, while in the on state it sets the text color.

lcdcolor [4 floats]8.0.0

Sets the display color in the RGBA format for the live.text object in LCD mode when the active attribute is set to 1. In the off state this sets the text color, while in the on state it sets the background color.

mode [int] (default: 1)

Sets the button mode. Button modes are:

0: Button mode
1: Toggle (switch) mode

Possible values:

0 = 'Button'
1 = 'Toggle'

outputmode [int] (default: 0)8.0.0

Sets the output mode for the live.text object when it's mode attribute is set to 1 (toggle). When outputmode is set to 0, output occurs on mousedown, when set to 1, output occurs on mouseup.

Possible values:

0 = 'Mouse down'
1 = 'Mouse up'

parameter_mappable [int] (default: 1)

When parameter_mappable is enabled, the object will be available for mapping to keyboard or MIDI input using the Mappings feature.

pictures [2 symbols] (default: <none> <none>)

Sets the paths for pictures used when the usepicture attribute is set to 1. Bitmap images such as PNG or vectorized images (SVG) can be used.

remapsvgcolors [int] (default: 0)8.0.0

Sets the SVG image colors to use when drawing the image. If remapsvgcolors is set to 0, the colors supplied by the SVG file are used; if set to 1, the color attributes for the appropriate display mode are used.

rounded [float]

Set the roundness of the border

text [symbol] (default: A)

Sets the button label when the button is in the off state.

textcolor [4 floats]

Sets the display color for the live.text object's text when the active attribute is set to 0.

textoffcolor [4 floats]8.0.0

Sets the display color for the live.text object's text when it is in the off state and the active attribute is set to 0.

texton [symbol] (default: B)

Sets the button label when the button is in the "on" state.

transition [int] (default: 0)

The parameter automation of live.text stores 0 and 1 values. The transition attribute specifies when a bang will be sent to the outlet.

Possible values:

0 = 'Zero->One'
1 = 'One->Zero'
2 = 'Both'

usepicture [int] (default: 0)

Toggles the use of pictures instead of text for display. Note that you need to provide enough pictures by setting the pictures attribute properly.

usesvgviewbox [int] (default: 0)8.0.0

Sets the viewbox for the svg files when usepicture is set to 1. If usesvgviewbox is set to 0, Max determines the viewbox; if set to 1, uses the viewbox flag supplied by the svg file.

Common Box Attributes

Parameter Attributes

Messages

bang

A bang message will toggle the state of the object. If it is off, it will switch on and output a 1. If it is on, it will switch off and output a 0.

int

Arguments

input [int]
In the toggle mode, any non-zero number will toggle the button to the "on" position, send the button text out the middle outlet and send a 1 out the left outlet. A zero sets the toggle to the "off" position, sends the button text out the middle outlet and sends a 0 out the left outlet.

float

Arguments

input [float]
Converted to int.

assign

Arguments

assign-input [float]
The word assign, followed by a floating point value, causes that value to be stored and displayed and sent out the live.text object's outlet. If the Parameter Visibility attribute is set to Stored Only, the assign message will not add the new value to the Live application’s undo chain.

init

Restore and output the initial value.

(mouse)

In button mode, a mouse click on live.text highlights it for as long as the mouse is held down, sending the text out the second outlet and a bang message out the left outlet.
In toggle mode, a mouse click behaves the same as a live.toggle. When the mouse is clicked, the live.text object will send a 1 out the left outlet if the cursor is inside of the live.text object's rectangle, and a 0 if it is not. The button text is also sent out the second outlet on mouse click.

outputvalue

Sends the current value out the outlet.

rawfloat

Arguments

input-value [float]
A raw normalized value (between 0. and 1.) received in the inlet is converted to a real value, and then functions like any other received int value in toggle mode.

set

Arguments

set-input [float]
In the toggle mode, the set messages toggles the "on" or "off" state without sending anything out the outlets. The word set, followed by any non-zero number, sets toggle to on. The message set 0 sets it to "off".

setsymbol

Arguments

button-text-item [list]
In the toggle mode, the word setsymbol, followed by a symbol that specifies a button text item, causes live.text to display that symbol and act as though the object were toggled to that state.

symbol

Arguments

button-text-item [list]
In the toggle mode, the word symbol, followed by a symbol that specifies a button text item, causes live.text to display that symbol and sends the current values out the outlets.

See Also

Name Description
Max For Live Max For Live
live.button
live.tab
live.toggle
textbutton