deluge::gui::menu_item::PatchCables Class Reference

Inheritance diagram for deluge::gui::menu_item::PatchCables:

Collaboration diagram for deluge::gui::menu_item::PatchCables:

Public Member Functions
void	beginSession (MenuItem *navigatedBackwardFrom=nullptr) final
	Begin an editing session with this menu item.
void	selectEncoderAction (int32_t offset) final
	Handle select encoder movement.
void	readValueAgain () final
	Re-read the value from the system and redraw the display to match.
MenuItem *	selectButtonPress () final
	Handle a select button press.
uint8_t	shouldBlinkPatchingSourceShortcut (PatchSource s, uint8_t *colour) final
void	drawPixelsForOled () final
	Paints the pixels below the standard title block.
void	drawValue ()
void	renderOptions ()
void	blinkShortcuts ()
void	blinkShortcutsSoon ()
ActionResult	timerCallback () override
	Handle a TimerName::UI_SPECIFIC event.
	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
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 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	readCurrentValue ()
	Like readValueAgain, but does not redraw.
virtual uint8_t	getIndexOfPatchedParamToBlink ()
virtual deluge::modulation::params::Kind	getParamKind ()
virtual uint32_t	getParamIndex ()
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	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.
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 void	getColumnLabel (StringBuf &label)
	Get the name for use on horizontal menus.
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 void	renderInHorizontalMenu (int32_t startX, int32_t width, int32_t startY, int32_t height)
virtual bool	isSubmenu ()
virtual void	setupNumberEditor ()
virtual void	updatePadLights ()
virtual void	updateAutomationViewParameter ()
void	renderColumnLabel (int32_t startX, int32_t width, int32_t startY)

Public Attributes
int	scrollPos = 0
int32_t	savedVal = 0
int32_t	currentValue = 0
deluge::vector< std::string_view >	options
PatchSource	blinkSrc = PatchSource::NOT_AVAILABLE
PatchSource	blinkSrc2 = PatchSource::NOT_AVAILABLE
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.

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

beginSession()

void deluge::gui::menu_item::PatchCables::beginSession ( MenuItem * navigatedBackwardFrom = nullptr )

finalvirtual

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::PatchCables::drawPixelsForOled ( )

finalvirtual

Paints the pixels below the standard title block.

Reimplemented from MenuItem.

readValueAgain()

void deluge::gui::menu_item::PatchCables::readValueAgain ( )

finalvirtual

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

Reimplemented from MenuItem.

selectButtonPress()

MenuItem * deluge::gui::menu_item::PatchCables::selectButtonPress ( )

finalvirtual

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.

Reimplemented from MenuItem.

selectEncoderAction()

void deluge::gui::menu_item::PatchCables::selectEncoderAction ( int32_t offset )

finalvirtual

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.

shouldBlinkPatchingSourceShortcut()

uint8_t deluge::gui::menu_item::PatchCables::shouldBlinkPatchingSourceShortcut ( PatchSource s, uint8_t * colour )

finalvirtual

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

timerCallback()

ActionResult deluge::gui::menu_item::PatchCables::timerCallback ( )

overridevirtual

Handle a TimerName::UI_SPECIFIC event.

Reimplemented from MenuItem.

---

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

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