umenu

Sends out the currently displayed menu item.

The number specifies a menu item to be sent out, and causes umenu to display that item. The items are numbered starting at 0. A menu item can also be chosen from a umenu with the mouse, as with any pop-up menu.

Converted to int.

When a file folder is dragged from the Max File Browser to a umenu object, the folder's contents will be loaded into as menu choices.

When a file folder is dragged from the Max File Browser to a blank space in an unlocked patcher window, a umenu object containing the folder's contents loaded will be created.

The word append, followed by any message, appends that message as the new last item in the menu.

The word checkitem, followed by an item number and 1 or 0, places (1) or removes (0) a check mark next to the item number.

Removes all items from the umenu.

The word clearchecks removes check marks for all items.

Sends the number of items in the umenu out the right outlet, preceded by the word count.

The word delete, followed by one or more numbers that correspond to items in the list, deletes the item or items from the umenu.

The word dictionary, followed by a dictionary name, will set the menu items for umenu. You can also attach the first outlet of a dict object to the first inlet of umenu. In order for this to work, the dictionary needs to include an "items" entry. For example, the following dictionary entry will populate umenu with the items "hank, carol, andreas, roland":

"items" : [ "hank", "carol", "andreas", "roland" ]

Output is the word 'dump', the item's entry number, and the contents. ex: 'dump 1 one'.

The word enableitem, followed by a number that specifies a menu item and a 1 or 0, enables or disables the specified item number. Disabled menu items cannot be selected, but their text and item number are sent from the rightmost outlet if the mouse is released while above them, prefixed by the symbols disabled_eval and disabled_item, respectively.

Reports the current value of the umenu object's toggle state (1 or 0, for on or off), from the right outlet, preceded by the word toggle.

The word insert, followed by a number and a message, inserts the message at the address specified by the number, incrementing all equal or greater addresses by 1 if necessary.

Legacy message. Please use the menumode attribute. The word mode, followed by a number in the range 1-4, sets the appearance and behavior of the umenu object. The normal pop-up menu style is 1 (the default). Scrolling mode (2) lets you scroll through the individual menu items by dragging the mouse up or down, displaying one item at a time. Label mode (3) shows the text of the selected menu item with no border around it, and does not respond to the mouse. Toggle mode (4) sets a button style. Clicking on the object in mode 3 causes it to alternate between an active and inactive state. When changing from inactive to active, the object sends the message toggle 1 from its rightmost outlet. When changing from active to inactive, the object sends the message toggle 0 from its rightmost outlet, and changes to the color set using the bgcolor attribute. Whether activating or deactivating, the object also sends its current message from the middle outlet and its current item number from the left outlet.

Clicking with the mouse lets you select a menu item to be sent out, and causes umenu to display that item.

Selects the next menu item and causes the umenu object to display that item. This message will ignore disabled or separator menu items.

If the umenu object has a valid folder path as its prefix, the populate message will cause the menu to re-populate its items list, based on the current contents of the specified path (and filtered by the types list). After population is complete, the number of items added to the umenu object will be output from the right outlet, preceded by the word populate.

Selects the previous menu item and causes the umenu object to display that item. This message will ignore disabled or separator menu items.

The word set, followed by a number or symbol, specifies a menu item to be displayed by umenu, but does not send it out the outlet. If the set argument is a symbol, set searches for a menu item which begins with the symbol.

(Macintosh only) The word setcheck, followed by a number that specifies the decimal representation of a UTF-8 character (e.g. 8226 for a bullet or 62 for a greater than symbol), sets the character used to be the check mark. The word setcheck with no argument specifies the default square root checkbox.

The word setitem, followed by an item number and any message, sets the specified menu item to that message.

The word setrgb, followed by six numbers between 0 and 255 that specify RGB values, uses the first three numbers to set the foreground (text) color and the second three numbers to set the background (fill) color.

The word setsymbol, followed by a message, specifies a menu item to be displayed by name without triggering any output.

The word settoggle, followed by a one or zero, sets the umenu object to the specified state if it is in toggle mode and performs output as if the object were clicked on (the symbol toggle, followed by a zero or one, indicating the toggle state). Without an argument, the message simply toggles the object's state and triggers output.

This message operates as follows. If the currently displayed item is checked, do nothing. Otherwise, starting at the first item in the menu, find one that is checked and set the menu to display that item. If there isn't one, do nothing.

Identical to the set message with a symbol argument, except that the found item number is sent out (and the text of the item is sent out the right outlet, if the Evaluate Item Text feature is enabled).

The word toggle, followed by a one or zero, sets the umenu object to the specified state if it is in toggle mode and performs output as if the object were clicked on (the symbol toggle, followed by a zero or one, indicating the toggle state). Without an argument, the message simply toggles the object's state and triggers output.