Livecode Wiki
Advertisement

A Message sent to a button when a menu item is chosen from the menu associated with that button. If there is a message handler by the same name in the message path, then it will be executed.

Message syntax:

menuPick <chosenItem> [, <previousTab>]

The parameter "chosenItem" is the label of the menu item the user chose. If the menu item is part of a submenu, the menu item label is followed by a vertical bar (|) and the submenu's label.

The parameter "previousTab" is the text of the menu item that was the previously-selected menu item. This parameter is included only if the button's menuMode property is set to "tabbed". Note: If the specification of a menu or submenu includes a tag, that tag will replace the menu label in the chosenItem parameter

The menuPick message is sent when the user clicks a tab in a tabbed button, when the user chooses a menu item from the menu associated with a button, or when a button's menuHistory property is set by a handler.

The menuPick message is sent every time a menu item is chosen, even if the menu is a type that retains its state (such as an option menu) and the chosen menu item has not changed. (However, no menuPick message is sent when an already-chosen tab in a tabbed button is clicked, since no menu is displayed.)

If the specification of a menu or submenu includes a tag, that tag will replace the menu label in the chosenItem parameter

Message handler example:

on menuPick theItem                                   -- in a pulldown menu
  if theItem is "Close" then close the defaultStack
  else if theItem is "Quit" then quit
end menuPick

Use the menuPick Message handler to do something when the user chooses a menu item from a button menu, or chooses a tab in a tabbed button.

To get the item number of the currently chosen menu item, use the menuHistory property.

The "&" and "/" characters can be used in a pulldown menu to create special effects. To be shown (instead of creating these effects), either character can be doubled. (For example, placing the line "This && That" in a menu item results in the menu item being displayed as "This & That", with one ampersand.) When the user chooses a menu item with these special characters, the chosenItem parameter is the text that appears in the menu as displayed, not the text of that line of the menu button.

See also: button, menuName, & menuHistory.

Advertisement