live.menu Reference

Pop-up menu

live.menu

Description

The live.menu object can be used to display text associated with incoming numbers and provide a general user interface. Item numbering starts from zero (0).

Examples

Arguments

None.

Attributes

active [int] (default: 1)

Toggles the object's active mode. When the active attribute is set to 0, the mouse action does not cause output and the inactive colors are used. The default is 1 (on).

activebgcolor [4 floats]

Sets the background color of the display when the active attribute is set to 1.

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)8.0.0

Defines the display style.

Possible values:

0 = 'Default'
The text appears with the boundaries of the text box. All attributes, except those with 'lcd' in the name, are functional.

1 = 'LCD'
The text appears with the boundaries of the text box. To adjust the colors of the object you must use the attributes with 'lcd' in the name, such as inactivelcdcolor, lcdbgcolor, and lcdcolor.

bordercolor [4 floats]

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

focusbordercolor [4 floats]

Sets the border color in RGBA format to be used when the live.menu has the focus.

hltcolor [4 floats]

Sets the highlight color in RGBA format to be used when you select an item with the mouse.

hlttextcolor [4 floats]

Sets the highlight text color in RGBA format to be used when you select an item with the mouse.

inactivelcdcolor [4 floats]8.0.0

Sets the text and highlight color when the appearance attribute is set to 1:LCD, and the active attribute is set to 0.

lcdbgcolor [4 floats]8.0.0

Sets the background color of the display when the appearance attribute is set to 1:LCD.

lcdcolor [4 floats]8.0.0

Sets the text and highlight color when the appearance attribute is set to 1:LCD.

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 [64 symbols]

Sets the paths of any 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 color that the SVG image will use. When usepicture is set to 1, and remapsvgcolors is set to 0, the color supplied by the SVG file are used; if set to 1, the color attributes for the appropriate display mode are used.

textcolor [4 floats]

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

tricolor [4 floats]

Sets the triangle color in RGBA format.

usepicture [int] (default: 0)

Toggles the use of the pictures instead of text 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

Sends the current item out the outlets.

int

Arguments

item-index [int]
An integer specifies a menu item to be displayed, and causes the live.menu object to display that item and output information about its index and the symbol associated with that menu index. Menu item numbering starts at 0.

float

Arguments

item-index [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.menu 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)

Clicking with the mouse lets you select a menu item to be displayed and outputs information about its index and the symbol associated with that menu index.

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, stored, displayed by live.menu, and the current item is sent out the outlets.

set

Arguments

item index [float]
The word set, followed by a number, specifies a menu item to be displayed by the live.menu object without triggering any output.

setsymbol

Arguments

menu item [list]
The word setsymbol, followed by a message, selects a menu item to be displayed by name without triggering any output.

symbol

Arguments

menu item [list]
The word symbol, followed by a message, selects a menu item to be displayed by name. If the item is found, the menu item is displayed and information about its index and the symbol associated with that menu index.

Output

anything

Out middle outlet: The text of the selected menu item is sent out as a message.

float

Out right outlet: When an output is triggered, a raw normalized value (between 0. and 1.) is sent out this outlet.

int

Out left outlet: The number of the selected menu item is sent out. Menu items are numbered beginning with 0.

See Also

Name Description
Max For Live Max For Live
live.tab
umenu