deluge::gui::menu_item::midi::Command Class Reference

Inheritance diagram for deluge::gui::menu_item::midi::Command:

Collaboration diagram for deluge::gui::menu_item::midi::Command:

Public Member Functions
	Command (l10n::String newName, GlobalMIDICommand newCommandNumber=GlobalMIDICommand::PLAYBACK_RESTART)
void	beginSession (MenuItem *navigatedBackwardFrom) override
	Begin an editing session with this menu item.
void	drawValue () const
void	selectEncoderAction (int32_t offset) override
	Handle select encoder movement.
bool	allowsLearnMode () override
	Used by SoundEditor to determine if the current menu item can accept MIDI learning.
bool	shouldBlinkLearnLed () override
void	unlearnAction () override
	Unlearn the parameter controlled by this menu.
bool	learnNoteOn (MIDICable &cable, int32_t channel, int32_t noteCode) override
	Attempt to bind this menu item to a note code.
void	learnProgramChange (MIDICable &cable, int32_t channel, int32_t programNumber) override
void	learnCC (MIDICable &cable, int32_t channel, int32_t ccNumber, int32_t value) override
void	drawPixelsForOled () override
	Paints the pixels below the standard title block.
Public Member Functions inherited from MenuItem
	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
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 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.
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	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.
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.
virtual void	learnKnob (MIDICable *cable, int32_t whichKnob, int32_t modKnobMode, int32_t midiChannel)
virtual bool	isRangeDependent ()
	Returns true if this parameter is only relevant to some note ranges.
virtual void	renderOLED ()
	Root rendering routine for OLED.
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	getColumnLabel (StringBuf &label)
virtual bool	showColumnLabel () const
	Show a label for the parameter in Horizontal menu.
virtual int32_t	getOccupiedSlots () const
	Get the number of occupied slots 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 (const SlotPosition &slot)

Public Attributes
GlobalMIDICommand	commandNumber
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.
deluge::gui::menu_item::HorizontalMenu *	parent {nullptr}

Additional Inherited Members
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.

Member Function Documentation

allowsLearnMode()

bool deluge::gui::menu_item::midi::Command::allowsLearnMode ( )

inlineoverridevirtual

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

Reimplemented from MenuItem.

beginSession()

void deluge::gui::menu_item::midi::Command::beginSession ( MenuItem * navigatedBackwardFrom )

overridevirtual

Begin an editing session with this menu item.

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

Reimplemented from MenuItem.

drawPixelsForOled()

void deluge::gui::menu_item::midi::Command::drawPixelsForOled ( )

overridevirtual

Paints the pixels below the standard title block.

Reimplemented from MenuItem.

learnCC()

void deluge::gui::menu_item::midi::Command::learnCC ( MIDICable & cable, int32_t channel, int32_t ccNumber, int32_t value )

overridevirtual

Reimplemented from MenuItem.

learnNoteOn()

bool deluge::gui::menu_item::midi::Command::learnNoteOn ( MIDICable & cable, int32_t channel, int32_t noteCode )

overridevirtual

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 from MenuItem.

learnProgramChange()

void deluge::gui::menu_item::midi::Command::learnProgramChange ( MIDICable & cable, int32_t channel, int32_t programNumber )

overridevirtual

Reimplemented from MenuItem.

selectEncoderAction()

void deluge::gui::menu_item::midi::Command::selectEncoderAction ( int32_t offset )

overridevirtual

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.

Reimplemented from MenuItem.

shouldBlinkLearnLed()

bool deluge::gui::menu_item::midi::Command::shouldBlinkLearnLed ( )

inlineoverridevirtual

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

Reimplemented from MenuItem.

unlearnAction()

void deluge::gui::menu_item::midi::Command::unlearnAction ( )

overridevirtual

Unlearn the parameter controlled by this menu.

Reimplemented from MenuItem.

---

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

• src/deluge/gui/menu_item/midi/command.h
• src/deluge/gui/menu_item/midi/command.cpp