MenuAction : AbstractMenuAction : QObject : Object

Description

A MenuAction represents a single action that can occupy multiple Menus or a ToolBars, and will evaluate a function when activated. When added to a menu, these are displayed as menu items. When added to a toolbar, they appear as buttons.

Class Methods

MenuAction.new(string, function)

MenuAction.separator(string)

Inherited class methods

Undocumented class methods

MenuAction.qtClass

Instance Methods

.string

.string = str

.menu

.menu = b

.shortcut

.shortcut = str

.checked

.checked = b

.toolTip

.toolTip = str

.separator

.separator = b

.iconVisible

.iconVisible = b

.checkable

.checkable = b

.enabled

.enabled = b

.icon = icon

.font

.font = font

Events

Menu actions broadcast several kinds of events that can be registered for with the standard Object: -addDependant calls. Events broadcast by menu:

• \changed (issued when one of the actions properties changes)
• \triggered (issued when the action is clicked / activated - value is a boolean representing whether the action is checked)
• \hovered
• \toggled

Events example( m = Menu( a = MenuAction("Option A"), b = MenuAction("Option B") ).title_("Event Example"); f = { |action, what, value| "MenuAction '%' sent event %, value = %".format(action.string, "\\" ++ what, value).postln; if (what == \hovered) { "Hovering over: %".format(action).postln }; if (what == \triggered) { "Action triggered: %".format(value).postln; m.destroy }; }; a.addDependant(f); b.addDependant(f); m.onClose_({ a.removeDependant(f); b.removeDependant(f) }).front; )

Inherited instance methods

Undocumented instance methods

.asMenu

Examples

Simple checkable menu item( ~view = View().layout_(HLayout( Button() .states_([["Options..."]]) .action_({ ~menu.front }) )); ~menu = Menu( MenuAction("enabled") .checkable_(true) .action_({ |a, enabled| if (enabled) { "Enabled".postln; ~view.background = Color.green(1, 0.5); } { "Disabled".postln; ~view.background = Color.clear; } }) ); ~view.front; )

Action help strings( ~view = View(bounds:300@100).layout_(VLayout( Button() .states_([["Options..."]]) .action_({ ~menu.front }), ~text = TextView() )); ~menu = Menu ( MenuAction("Option A").toolTip_("I like option A..."), MenuAction("Option B").toolTip_("But option B is better..."), MenuAction("Option C").toolTip_("No one really likes C."), ); ~actionFunc = { |obj, what, action| if (what == \hovered) { ~text.string = action.toolTip }; if (what == \aboutToHide) { ~text.string = "" } }; ~menu.addDependant(~actionFunc); ~view.onClose_({ ~menu.removeDependant(~actionFunc) }).front; )

A more complex example( s.waitForBoot { ~startIcon = Image(40).draw({ Pen.fillColor = Color.green; Pen.moveTo(5@5); Pen.lineTo(35@20); Pen.lineTo(5@35); Pen.lineTo(5@5); Pen.fill; }); ~stopIcon = Image(40).draw({ Pen.fillColor = Color.red; Pen.fillRect(Rect(10, 10, 20, 20)); }); ~startAction = MenuAction("start") .action_({ ~playSynth.() }) .icon_(~startIcon) .toolTip_("Start playing synth.") .shortcut_("space") .font_(Font(bold:true, size:18)); ~stopAction = MenuAction("stop") .action_({ ~stopSynth.() }) .icon_(~stopIcon) .toolTip_("Stop the synth.") .enabled_(false) .shortcut_(".") .font_(Font(bold:true, size:18)); ~playing = MenuAction("playing") .enabled_(false) .checkable_(true) .checked_(false); ~view = View(bounds:300@200).layout_(VLayout( ToolBar(~startAction, ~stopAction, MenuAction.separator, ~playing).focus, nil, Button().states_([["Options..."]]).action_({ Menu(~startAction, ~stopAction, MenuAction.separator, ~playing).front; }) )); ~view.onClose_({ ~stopSynth.() }); ~synth = nil; ~playSynth = { if (~synth.isNil) { ~synth = { SinOsc.ar(440) * 0.1 }.play; ~startAction.enabled = false; ~stopAction.enabled = true; ~playing.checked = true; ~synth.onFree({ ~synth = nil; { ~playing.checked = false; ~startAction.enabled = true; ~stopAction.enabled = false; }.defer }) } }; ~stopSynth = { ~synth !? { ~synth.free }; }; ~view.front; } )