Deluge Firmware 1.3.0
Build date: 2025.04.16
Loading...
Searching...
No Matches
deluge::gui::menu_item::source_selection::Range Class Referencefinal
Inheritance diagram for deluge::gui::menu_item::source_selection::Range:
Collaboration diagram for deluge::gui::menu_item::source_selection::Range:

Public Member Functions

ParamDescriptor getDestinationDescriptor () override
 
MenuItemselectButtonPress () override
 Handle a select button press.
 
MenuItempatchingSourceShortcutPress (PatchSource newS, bool previousPressStillActive) override
 Action to take when a source shortcut is pressed.
 
std::string_view getTitle () const override
 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).
 
- Public Member Functions inherited from deluge::gui::menu_item::SourceSelection
void beginSession (MenuItem *navigatedBackwardFrom=nullptr) override
 Begin an editing session with this menu item.
 
void selectEncoderAction (int32_t offset) final
 Handle select encoder movement.
 
uint8_t getIndexOfPatchedParamToBlink () final
 
uint8_t shouldBlinkPatchingSourceShortcut (PatchSource s, uint8_t *colour) final
 
void readValueAgain () final
 Re-read the value from the system and redraw the display to match.
 
void drawPixelsForOled ()
 Paints the pixels below the standard title block.
 
void drawValue () override
 
- Public Member Functions inherited from deluge::gui::menu_item::Value< int32_t >
 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
 
void beginSession (MenuItem *navigatedBackwardFrom) override
 Begin an editing session with this menu item.
 
void selectEncoderAction (int32_t offset) override
 Handle select encoder movement.
 
void readValueAgain () override
 Re-read the value from the system and redraw the display to match.
 
bool selectEncoderActionEditsInstrument () final
 Used by the sound editor to mark the current instrument as edited when the select encoder is scrolled.
 
void setValue (int32_t value)
 
void setValue (E value)
 
int32_t getValue ()
 
getValue ()
 
 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
 
MenuItemoperator= (const MenuItem &other)=delete
 
MenuItemoperator= (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 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 readCurrentValue ()
 Like readValueAgain, but does not redraw.
 
virtual deluge::modulation::params::Kind getParamKind ()
 
virtual uint32_t getParamIndex ()
 
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 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)
 

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.
 
- Public Attributes inherited from deluge::gui::menu_item::SourceSelection
int32_t scrollPos
 
PatchSource s
 
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.
 
- Static Public Attributes inherited from deluge::gui::menu_item::SourceSelection
static int32_t selectedRowOnScreen
 
- Protected Member Functions inherited from deluge::gui::menu_item::SourceSelection
bool sourceIsAllowed (PatchSource source)
 
uint8_t shouldDrawDotOnValue ()
 
- Protected Member Functions inherited from deluge::gui::menu_item::Value< int32_t >
virtual void writeCurrentValue ()
 

Member Function Documentation

◆ getDestinationDescriptor()

ParamDescriptor deluge::gui::menu_item::source_selection::Range::getDestinationDescriptor ( )
overridevirtual

◆ getTitle()

std::string_view deluge::gui::menu_item::source_selection::Range::getTitle ( ) const
inlineoverridevirtual

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"

Reimplemented from MenuItem.

◆ patchingSourceShortcutPress()

MenuItem * deluge::gui::menu_item::source_selection::Range::patchingSourceShortcutPress ( PatchSource s,
bool previousPressStillActive )
overridevirtual

Action to take when a source shortcut is pressed.

Potentially reconfigures some SoundEditor state so patching will work.

Parameters
sThe source being pressed.
previousPressStillActiveTrue 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 from MenuItem.

◆ selectButtonPress()

MenuItem * deluge::gui::menu_item::source_selection::Range::selectButtonPress ( )
overridevirtual

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.


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