Base class for all menu items. More...

#include <menu_item.h>

Inheritance diagram for MenuItem:

[legend]

Collaboration diagram for MenuItem:

[legend]

Public Member Functions
	MenuItem (deluge::l10n::String newName, deluge::l10n::String newTitle=deluge::l10n::String::EMPTY_STRING)
	MenuItem (const MenuItem &other)=delete
	MenuItem (const MenuItem &&other)=delete
MenuItem &	operator= (const MenuItem &other)=delete
MenuItem &	operator= (const MenuItem &&other)=delete
Input Handling
virtual ActionResult	buttonAction (deluge::hid::Button b, bool on, bool inCardRoutine)
	Handle an arbitrary button.
virtual void	horizontalEncoderAction (int32_t offset)
	Handle horizontal encoder movement.
virtual void	verticalEncoderAction (int32_t offset)
	Handle vertical encoder movement.
virtual void	selectEncoderAction (int32_t offset)
	Handle select encoder movement.
virtual bool	selectEncoderActionEditsInstrument ()
	Used by the sound editor to mark the current instrument as edited when the select encoder is scrolled.
virtual MenuItem *	selectButtonPress ()
	Handle a select button press.
virtual ActionResult	timerCallback ()
	Handle a TimerName::UI_SPECIFIC event.
virtual bool	usesAffectEntire ()
	Claim support for Kit AFFECT_ENTIRE editing.
Session Management
virtual MenuPermission	checkPermissionToBeginSession (ModControllableAudio modControllable, int32_t whichThing, MultiRange *currentRange)
	Double-check that this MenuItem will work with the currently selected sound range.
virtual void	beginSession (MenuItem *navigatedBackwardFrom=nullptr)
	Begin an editing session with this menu item.
virtual void	endSession ()
	End an editing session with this menu item.
virtual void	readValueAgain ()
	Re-read the value from the system and redraw the display to match.
virtual void	readCurrentValue ()
	Like readValueAgain, but does not redraw.
Patching support
virtual uint8_t	getIndexOfPatchedParamToBlink ()
virtual deluge::modulation::params::Kind	getParamKind ()
virtual uint32_t	getParamIndex ()
virtual uint8_t	shouldBlinkPatchingSourceShortcut (PatchSource s, uint8_t *colour)
virtual MenuItem *	patchingSourceShortcutPress (PatchSource s, bool previousPressStillActive=false)
	Action to take when a source shortcut is pressed.
Parameter learning
virtual void	learnKnob (MIDICable *cable, int32_t whichKnob, int32_t modKnobMode, int32_t midiChannel)
virtual bool	allowsLearnMode ()
	Used by SoundEditor to determine if the current menu item can accept MIDI learning.
virtual bool	learnNoteOn (MIDICable &cable, int32_t channel, int32_t noteCode)
	Attempt to bind this menu item to a note code.
virtual void	learnProgramChange (MIDICable &cable, int32_t channel, int32_t programNumber)
virtual void	learnCC (MIDICable &cable, int32_t channel, int32_t ccNumber, int32_t value)
virtual bool	shouldBlinkLearnLed ()
virtual void	unlearnAction ()
	Unlearn the parameter controlled by this menu.
virtual bool	isRangeDependent ()
	Returns true if this parameter is only relevant to some note ranges.
Rendering
virtual void	renderOLED ()
	Root rendering routine for OLED.
virtual void	drawPixelsForOled ()
	Paints the pixels below the standard title block.

Submenu entry support
Things that deluge::gui::menu_item::Submenu -like MenuItem s will query.
deluge::l10n::String	title
	Can get overridden by getTitle(). Actual max num chars for OLED display is 14.
const deluge::l10n::String	name
	Default name for use on OLED for deluge::gui::menu_item::Submenu s.
virtual std::string_view	getTitle () const
	Get the title to be used when rendering on OLED, both as a deluge::gui::menu_item::Submenu and when displaying ourselves (using the default renderOLED implementation).
virtual uint8_t	shouldDrawDotOnName ()
	Get the "draw dot state".
virtual void	drawName ()
	Draw the name we want to use when selecting this in a deluge::gui::menu_item::Submenu to the 7SEG.
virtual std::string_view	getName () const
	Get the actual name for use on OLED for deluge::gui::menu_item::Submenu s.
virtual bool	isRelevant (ModControllableAudio *modControllable, int32_t whichThing)
	Check if this MenuItem should show up in a containing deluge::gui::menu_item::Submenu.
virtual bool	shouldEnterSubmenu ()
	Check if selecting this menu item (with select encoder) should enter a submenu.
virtual int32_t	getSubmenuItemTypeRenderLength ()
	Handle rendering of submenu item types.
virtual int32_t	getSubmenuItemTypeRenderIconStart ()
virtual void	renderSubmenuItemTypeForOled (int32_t yPixel)
virtual bool	isSubmenu ()
virtual void	setupNumberEditor ()
virtual void	updatePadLights ()
virtual void	updateAutomationViewParameter ()
static void	drawItemsForOled (std::span< std::string_view > options, int32_t selectedOption, int32_t offset=0)
	Internal helper which can draw the standard deluge::gui::menu_item::Submenu layout.

Horizontal menus
Get the name for use on Horizontal menus. By default this redirects to getName(), but can be overridden.
deluge::gui::menu_item::Submenu *	parent {nullptr}
virtual void	getColumnLabel (StringBuf &label)
virtual bool	showColumnLabel () const
	Show a label for the parameter in Horizontal menu.
virtual int32_t	getColumnSpan () const
	Get the number of occupied virtual columns in Horizontal menu.
virtual bool	showNotification () const
	Show a popup with the full name and value of the editing parameter at the top of Horizontal menu.
virtual bool	allowToBeginSessionFromHorizontalMenu ()
	Allow entering menu session by selecting the menu item twice in Horizontal menu.
virtual void	getNotificationValue (StringBuf &valueBuf)
	Get the parameter value string to show in the popup.
virtual void	renderInHorizontalMenu (int32_t startX, int32_t width, int32_t startY, int32_t height)

Detailed Description

Base class for all menu items.

Member Function Documentation

◆ allowsLearnMode()

virtual bool MenuItem::allowsLearnMode ( )

inlinevirtual

Used by SoundEditor to determine if the current menu item can accept MIDI learning.

Reimplemented in deluge::gui::menu_item::audio_clip::Transpose, deluge::gui::menu_item::MasterTranspose, deluge::gui::menu_item::midi::Command, deluge::gui::menu_item::midi::FollowChannel, deluge::gui::menu_item::midi::FollowKitRootNote, deluge::gui::menu_item::PatchCableStrength, deluge::gui::menu_item::patched_param::Integer, deluge::gui::menu_item::Submenu, deluge::gui::menu_item::Transpose, and deluge::gui::menu_item::UnpatchedParam.

◆ allowToBeginSessionFromHorizontalMenu()

virtual bool MenuItem::allowToBeginSessionFromHorizontalMenu ( )

inlinenodiscardvirtual

Allow entering menu session by selecting the menu item twice in Horizontal menu.

false by default, but can be overridden

Reimplemented in deluge::gui::menu_item::audio_clip::SampleMarkerEditor, deluge::gui::menu_item::FileSelector, deluge::gui::menu_item::osc::AudioRecorder, deluge::gui::menu_item::sample::End, and deluge::gui::menu_item::sample::Start.

◆ beginSession()

virtual void MenuItem::beginSession ( MenuItem * navigatedBackwardFrom = nullptr )

inlinevirtual

Begin an editing session with this menu item.

Should make sure the menu's internal state matches the system and redraw the display.

◆ buttonAction()

virtual ActionResult MenuItem::buttonAction	(	deluge::hid::Button	b,
		bool	on,
		bool	inCardRoutine )

inlinevirtual

Handle an arbitrary button.

The returned result is forwarded up the View stack, so returning ActionResult::DEALT_WITH will suppress buttons going to the current View.

This is called with (b == SELECT_ENC && on) immediately after the menu is entered, or after selectButtonPress is called and returns NO_NAVIGATION.

Reimplemented in deluge::gui::menu_item::HorizontalMenu, deluge::gui::menu_item::PatchCableStrength, deluge::gui::menu_item::patched_param::Integer, deluge::gui::menu_item::Submenu, and deluge::gui::menu_item::UnpatchedParam.

◆ drawName()

void MenuItem::drawName ( )

virtual

Draw the name we want to use when selecting this in a deluge::gui::menu_item::Submenu to the 7SEG.

This is based on getName and shouldDrawDotOnName.

Reimplemented in deluge::gui::menu_item::ActiveScaleMenu, deluge::gui::menu_item::defaults::DefaultScale, and deluge::gui::menu_item::submenu::ActualSource.

◆ drawPixelsForOled()

virtual void MenuItem::drawPixelsForOled ( )

inlinevirtual

Paints the pixels below the standard title block.

◆ endSession()

void MenuItem::endSession ( )

virtual

End an editing session with this menu item.

Reimplemented in deluge::gui::menu_item::HorizontalMenu, and deluge::gui::menu_item::PatchCableStrength.

◆ getColumnSpan()

virtual int32_t MenuItem::getColumnSpan ( ) const

inlinenodiscardvirtual

Get the number of occupied virtual columns in Horizontal menu.

1 by default, but can be overridden

Reimplemented in deluge::gui::menu_item::arpeggiator::midi_cv::Rhythm, deluge::gui::menu_item::arpeggiator::Randomizer, deluge::gui::menu_item::arpeggiator::Rhythm, deluge::gui::menu_item::audio_compressor::Blend, deluge::gui::menu_item::FilterRouting, deluge::gui::menu_item::mod_fx::Type, deluge::gui::menu_item::osc::AudioRecorder, deluge::gui::menu_item::Submenu, and deluge::gui::menu_item::SyncLevel.

◆ getIndexOfPatchedParamToBlink()

virtual uint8_t MenuItem::getIndexOfPatchedParamToBlink ( )

inlinevirtual

Returns: the parameter index (deluge::modulation::params) that the SoundEditor should look for in paramShortcutsForSounds.

Reimplemented in deluge::gui::menu_item::PatchCableStrength, and deluge::gui::menu_item::SourceSelection.

◆ getName()

virtual std::string_view MenuItem::getName ( ) const

inlinenodiscardvirtual

Get the actual name for use on OLED for deluge::gui::menu_item::Submenu s.

By default this is just the l10n string for name, but can be overriden.

◆ getNotificationValue()

virtual void MenuItem::getNotificationValue ( StringBuf & valueBuf )

inlinevirtual

Get the parameter value string to show in the popup.

Needs to be overridden

◆ getParamIndex()

virtual uint32_t MenuItem::getParamIndex ( )

inlinevirtual

Returns: the parameter index (deluge::modulation::params) we edit if we're a patched param, otherwise 255.

Reimplemented in deluge::gui::menu_item::MasterTranspose, deluge::gui::menu_item::PatchCableStrength, deluge::gui::menu_item::Submenu, deluge::gui::menu_item::Transpose, and deluge::gui::menu_item::UnpatchedParam.

◆ getParamKind()

virtual deluge::modulation::params::Kind MenuItem::getParamKind ( )

inlinevirtual

Declares which parameter we intend to edit. SoundEditor uses this to find which shortcut pad to blink based on paramShortcutsForSounds.

Returns: the parameter kind (deluge::modulation::params::Kind) we edit if we're a patched param, otherwise Kind::NONE

Reimplemented in deluge::gui::menu_item::PatchCableStrength, deluge::gui::menu_item::Submenu, and deluge::gui::menu_item::UnpatchedParam.

◆ getTitle()

virtual std::string_view MenuItem::getTitle ( ) const

inlinenodiscardvirtual

Get the title to be used when rendering on OLED, both as a deluge::gui::menu_item::Submenu and when displaying ourselves (using the default renderOLED implementation).

If not overridden, defaults to returning title.

The returned pointer must live long enough for us to draw the title, which for practical purposes means "the lifetime of this menu item"

◆ horizontalEncoderAction()

virtual void MenuItem::horizontalEncoderAction ( int32_t offset )

inlinevirtual

Handle horizontal encoder movement.

Parameters

offset must be either -1 or 1, jumping is not supported by many children.

Reimplemented in deluge::gui::menu_item::cv::Volts, deluge::gui::menu_item::Decimal, deluge::gui::menu_item::DecimalWithoutScrolling, deluge::gui::menu_item::DxParam, deluge::gui::menu_item::osc::RetriggerPhase, deluge::gui::menu_item::PatchCableStrength, deluge::gui::menu_item::patched_param::Integer, deluge::gui::menu_item::Range, and deluge::gui::menu_item::UnpatchedParam.

◆ isRangeDependent()

virtual bool MenuItem::isRangeDependent ( )

inlinevirtual

Returns true if this parameter is only relevant to some note ranges.

Reimplemented in deluge::gui::menu_item::MultiRange, deluge::gui::menu_item::sample::LoopPoint, and deluge::gui::menu_item::sample::Transpose.

◆ isRelevant()

virtual bool MenuItem::isRelevant	(	ModControllableAudio *	modControllable,
		int32_t	whichThing )

inlinevirtual

Check if this MenuItem should show up in a containing deluge::gui::menu_item::Submenu.

Parameters

sound	Sound we would edit if we were to be entered.
whichThing	Source index within the sound. Usually ignored, but matters for e.g. oscillator and FM modulator parameters.

◆ learnKnob()

virtual void MenuItem::learnKnob	(	MIDICable *	cable,
		int32_t	whichKnob,
		int32_t	modKnobMode,
		int32_t	midiChannel )

inlinevirtual

Learn a mod knob to the parameter edited by this menu.

Parameters

cable The MIDI cable to learn from, or null if a mod knob is to be learned.

Reimplemented in deluge::gui::menu_item::audio_clip::Transpose, deluge::gui::menu_item::MasterTranspose, deluge::gui::menu_item::PatchCableStrength, deluge::gui::menu_item::patched_param::Integer, deluge::gui::menu_item::Submenu, and deluge::gui::menu_item::UnpatchedParam.

◆ learnNoteOn()

virtual bool MenuItem::learnNoteOn	(	MIDICable &	cable,
		int32_t	channel,
		int32_t	noteCode )

inlinevirtual

Attempt to bind this menu item to a note code.

Returns: True if the learn succeeded and the feature controlled by this menu item will now be bound to a MIDI note, false otherwise.

Reimplemented in deluge::gui::menu_item::midi::Command, deluge::gui::menu_item::midi::FollowChannel, deluge::gui::menu_item::midi::FollowKitRootNote, and deluge::gui::menu_item::Submenu.

◆ patchingSourceShortcutPress()

virtual MenuItem * MenuItem::patchingSourceShortcutPress	(	PatchSource	s,
		bool	previousPressStillActive = false )

inlinevirtual

Action to take when a source shortcut is pressed.

Potentially reconfigures some SoundEditor state so patching will work.

Parameters

s	The source being pressed.
previousPressStillActive	True if there is another patch source press still active. Useful to set up cable strength modulation.

Returns

NO_NAVIGATION if the SoundEditor should ask the menu 1 layer up in the stack what to do
nullptr if nothing should happen
A valid MenuItem if we should switch to that menu item.

Reimplemented in deluge::gui::menu_item::MasterTranspose, deluge::gui::menu_item::patch_cable_strength::Fixed, deluge::gui::menu_item::patch_cable_strength::Range, deluge::gui::menu_item::patch_cable_strength::Regular, deluge::gui::menu_item::patched_param::Integer, deluge::gui::menu_item::source_selection::Range, deluge::gui::menu_item::source_selection::Regular, deluge::gui::menu_item::Submenu, and deluge::gui::menu_item::Transpose.

◆ readCurrentValue()

virtual void MenuItem::readCurrentValue ( )

inlinevirtual

Like readValueAgain, but does not redraw.

◆ readValueAgain()

virtual void MenuItem::readValueAgain ( )

inlinevirtual

Re-read the value from the system and redraw the display to match.

Reimplemented in deluge::gui::menu_item::ActiveScaleMenu, deluge::gui::menu_item::DxCartridge, deluge::gui::menu_item::DxEngineSelect, deluge::gui::menu_item::DxGlobalParams, deluge::gui::menu_item::DxOperatorParams, deluge::gui::menu_item::DxParam, deluge::gui::menu_item::PatchCables, deluge::gui::menu_item::SourceSelection, deluge::gui::menu_item::Submenu, deluge::gui::menu_item::Value< T >, deluge::gui::menu_item::Value< bool >, and deluge::gui::menu_item::Value< int32_t >.

◆ renderOLED()

void MenuItem::renderOLED ( )

virtual

Root rendering routine for OLED.

If you want a title, you probably want to override drawPixelsForOled instead or you will need to paint the title yourself. Uses the title from getTitle() when rendering.

Reimplemented in deluge::gui::menu_item::HorizontalMenu, and deluge::gui::menu_item::PatchCableStrength.

◆ selectButtonPress()

virtual MenuItem * MenuItem::selectButtonPress ( )

inlinevirtual

Handle a select button press.

Returns

NO_NAVIGATION if the SoundEditor should stay on the current menu.
nullptr if the SoundEditor should go up one level in the menu stack.
otherwise, enter the returned menu.

◆ selectEncoderAction()

virtual void MenuItem::selectEncoderAction ( int32_t offset )

inlinevirtual

Handle select encoder movement.

Child classes which override this should be careful to handle offsets larger than 1, as holding shift and scrolling will increase them.

◆ selectEncoderActionEditsInstrument()

virtual bool MenuItem::selectEncoderActionEditsInstrument ( )

inlinevirtual

Used by the sound editor to mark the current instrument as edited when the select encoder is scrolled.

Todo: Menu items should probably do that work themselves, rather than bubbling it out to the SoundEditor.

Reimplemented in deluge::gui::menu_item::Value< T >, deluge::gui::menu_item::Value< bool >, and deluge::gui::menu_item::Value< int32_t >.

◆ shouldBlinkLearnLed()

virtual bool MenuItem::shouldBlinkLearnLed ( )

inlinevirtual

Return true if the Learn LED should blink while this menu is active (otherwise, it blinks only while LEARN is held).

Reimplemented in deluge::gui::menu_item::midi::Command.

◆ shouldBlinkPatchingSourceShortcut()

virtual uint8_t MenuItem::shouldBlinkPatchingSourceShortcut	(	PatchSource	s,
		uint8_t *	colour )

inlinevirtual

Get the frequency at which this pad should blink the given source.

Parameters

colour Output parameter for the colour to use when blinking.

Returns: Blink time period (higher means more delay between flashes), or 255 if we shouldn't blink.

Reimplemented in deluge::gui::menu_item::MasterTranspose, deluge::gui::menu_item::patch_cable_strength::Fixed, deluge::gui::menu_item::patch_cable_strength::Range, deluge::gui::menu_item::patch_cable_strength::Regular, deluge::gui::menu_item::PatchCables, deluge::gui::menu_item::patched_param::Integer, deluge::gui::menu_item::SourceSelection, and deluge::gui::menu_item::Transpose.

◆ shouldDrawDotOnName()

virtual uint8_t MenuItem::shouldDrawDotOnName ( )

inlinevirtual

Get the "draw dot state".

This is a bitfield representation of which segments on the 7seg should have their '.' lit up.

The upper 4 bits determine how the lower 4 are interpreted. If the upper 4 bits are...

0b0000, the lower 4 bits are treated as an index describing which dot to light (where 0 is the leftmost 7seg).
0b1000, the lower 4 bits are a bitmask where the LSB is the leftmost 7seg and the MSB is the rightmost.

Warning: (sapphire): I didn't actually check LTR vs RTL, someone who actually has a 7seg should do that.

Reimplemented in deluge::gui::menu_item::MasterTranspose, deluge::gui::menu_item::Selection, deluge::gui::menu_item::Toggle, and deluge::gui::menu_item::Transpose.

◆ shouldEnterSubmenu()

virtual bool MenuItem::shouldEnterSubmenu ( )

inlinevirtual

Check if selecting this menu item (with select encoder) should enter a submenu.

◆ showColumnLabel()

virtual bool MenuItem::showColumnLabel ( ) const

inlinenodiscardvirtual

Show a label for the parameter in Horizontal menu.

true by default, but can be overridden

Reimplemented in deluge::gui::menu_item::arpeggiator::PresetMode, deluge::gui::menu_item::arpeggiator::Randomizer, deluge::gui::menu_item::FilterRouting, deluge::gui::menu_item::lfo::Type, deluge::gui::menu_item::mod_fx::Type, deluge::gui::menu_item::osc::AudioRecorder, deluge::gui::menu_item::osc::Type, deluge::gui::menu_item::sidechain::GlobalVolume, deluge::gui::menu_item::sidechain::VolumeShortcut, and deluge::gui::menu_item::unison::Count.

◆ showNotification()

virtual bool MenuItem::showNotification ( ) const

inlinenodiscardvirtual

Show a popup with the full name and value of the editing parameter at the top of Horizontal menu.

true by default, but can be overridden

Reimplemented in deluge::gui::menu_item::FilterRouting, deluge::gui::menu_item::midi::Preset, deluge::gui::menu_item::mod_fx::Type, deluge::gui::menu_item::osc::AudioRecorder, and deluge::gui::menu_item::Submenu.

◆ timerCallback()

virtual ActionResult MenuItem::timerCallback ( )

inlinevirtual

Handle a TimerName::UI_SPECIFIC event.

Reimplemented in deluge::gui::menu_item::DxParam, and deluge::gui::menu_item::PatchCables.

◆ unlearnAction()

virtual void MenuItem::unlearnAction ( )

inlinevirtual

Unlearn the parameter controlled by this menu.

Reimplemented in deluge::gui::menu_item::audio_clip::Transpose, deluge::gui::menu_item::MasterTranspose, deluge::gui::menu_item::midi::Command, deluge::gui::menu_item::midi::FollowChannel, deluge::gui::menu_item::PatchCableStrength, deluge::gui::menu_item::patched_param::Integer, deluge::gui::menu_item::Submenu, deluge::gui::menu_item::Transpose, and deluge::gui::menu_item::UnpatchedParam.

◆ updateAutomationViewParameter()

virtual void MenuItem::updateAutomationViewParameter ( )

inlinevirtual

Called to inform automation view that the active parameter has changed. Parameters inheriting from Automation forward there, no-op for everything else.

Reimplemented in deluge::gui::menu_item::PatchCableStrength, and deluge::gui::menu_item::patched_param::Integer.

◆ usesAffectEntire()

virtual bool MenuItem::usesAffectEntire ( )

inlinevirtual

Claim support for Kit AFFECT_ENTIRE editing.

Returns: true if this Menu can edit parameters across an entire kit if changed with AFFECT_ENTIRE held down.

◆ verticalEncoderAction()

virtual void MenuItem::verticalEncoderAction ( int32_t offset )

inlinevirtual

Handle vertical encoder movement.

Parameters

offset must be either -1 or 1, jumping is not supported by many children.

Member Data Documentation

◆ name

const deluge::l10n::String MenuItem::name

Default name for use on OLED for deluge::gui::menu_item::Submenu s.

May be overridden by getName

The documentation for this class was generated from the following files:

src/deluge/gui/menu_item/menu_item.h
src/deluge/gui/menu_item/menu_item.cpp

Public Member Functions

Submenu entry support

Horizontal menus

Detailed Description

Member Function Documentation

◆ allowsLearnMode()

◆ allowToBeginSessionFromHorizontalMenu()

◆ beginSession()

◆ buttonAction()

◆ drawName()

◆ drawPixelsForOled()

◆ endSession()

◆ getColumnSpan()

◆ getIndexOfPatchedParamToBlink()

◆ getName()

◆ getNotificationValue()

◆ getParamIndex()

◆ getParamKind()

◆ getTitle()

◆ horizontalEncoderAction()

◆ isRangeDependent()

◆ isRelevant()

◆ learnKnob()

◆ learnNoteOn()

◆ patchingSourceShortcutPress()

◆ readCurrentValue()

◆ readValueAgain()

◆ renderOLED()

◆ selectButtonPress()

◆ selectEncoderAction()

◆ selectEncoderActionEditsInstrument()

◆ shouldBlinkLearnLed()

◆ shouldBlinkPatchingSourceShortcut()

◆ shouldDrawDotOnName()

◆ shouldEnterSubmenu()

◆ showColumnLabel()

◆ showNotification()

◆ timerCallback()

◆ unlearnAction()

◆ updateAutomationViewParameter()

◆ usesAffectEntire()

◆ verticalEncoderAction()

Member Data Documentation

◆ name