 |
Deluge Firmware 1.3.0
Build date: 2025.08.10
|
|
Deluge Firmware 1.3.0
Build date: 2025.08.10
|
Public Member Functions | |
| Segment (l10n::String newName, l10n::String title, int32_t newP, uint8_t source_id) | |
| 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). | |
| void | getColumnLabel (StringBuf &label) override |
| Public Member Functions inherited from deluge::gui::menu_item::source::PatchedParam | |
| PatchedParam (l10n::String newName, int32_t newP, uint8_t source_id) | |
| PatchedParam (l10n::String newName, l10n::String title, int32_t newP, uint8_t source_id) | |
| uint8_t | getP () override |
| Public Member Functions inherited from deluge::gui::menu_item::patched_param::Integer | |
| Integer (l10n::String newName, int32_t newP=0) | |
| Integer (l10n::String newName, l10n::String title, int32_t newP=0) | |
| void | drawValue () override |
| bool | usesAffectEntire () override |
| Claim support for Kit AFFECT_ENTIRE editing. | |
| ParamDescriptor | getLearningThing () final |
| int32_t | getMaxValue () const override |
| int32_t | getMinValue () const override |
| uint8_t | shouldBlinkPatchingSourceShortcut (PatchSource s, uint8_t *colour) final |
| uint8_t | shouldDrawDotOnName () final |
| MenuItem * | selectButtonPress () final |
| Handle a select button press. | |
| ActionResult | buttonAction (deluge::hid::Button b, bool on, bool inCardRoutine) final |
| Handle an arbitrary button. | |
| void | horizontalEncoderAction (int32_t offset) final |
| Handle horizontal encoder movement. | |
| deluge::modulation::params::Kind | getParamKind () final |
| uint32_t | getParamIndex () final |
| MenuItem * | patchingSourceShortcutPress (PatchSource s, bool previousPressStillActive=false) final |
| Action to take when a source shortcut is pressed. | |
| void | unlearnAction () final |
| Unlearn the parameter controlled by this menu. | |
| bool | allowsLearnMode () final |
| Used by SoundEditor to determine if the current menu item can accept MIDI learning. | |
| void | learnKnob (MIDICable *cable, int32_t whichKnob, int32_t modKnobMode, int32_t midiChannel) final |
| int32_t | getParamValue () |
| void | updateAutomationViewParameter () override |
| Public Member Functions inherited from deluge::gui::menu_item::PatchedParam | |
| PatchedParam (int32_t newP) | |
| MenuItem * | selectButtonPress () |
| ActionResult | buttonAction (deluge::hid::Button b, bool on, bool inCardRoutine) |
| void | horizontalEncoderAction (int32_t offset) |
| ParamDescriptor | getLearningThing () override |
| uint8_t | shouldBlinkPatchingSourceShortcut (PatchSource s, uint8_t *colour) |
| MenuItem * | patchingSourceShortcutPress (PatchSource s, bool previousPressStillActive=false) |
| ModelStackWithAutoParam * | getModelStack (void *memory) override |
| Public Member Functions inherited from deluge::gui::menu_item::Param | |
| Param (int32_t newP=0) | |
| MenuItem * | selectButtonPress () |
| ActionResult | buttonAction (deluge::hid::Button b, bool on, bool inCardRoutine) |
| void | horizontalEncoderAction (int32_t offset) |
| ModelStackWithAutoParam * | getModelStackWithParam (void *memory) override |
| Public Member Functions inherited from deluge::gui::menu_item::Automation | |
| MenuItem * | selectButtonPress () |
| ActionResult | buttonAction (deluge::hid::Button b, bool on, bool inCardRoutine) |
| virtual PatchSource | getPatchSource () |
| void | selectAutomationViewParameter (bool clipMinder) |
| void | handleAutomationViewParameterUpdate () |
| MenuItem::updateAutomationViewParameter forwards here when necessary. | |
| Public Member Functions inherited from MenuItemWithCCLearning | |
| void | unlearnAction () |
| bool | allowsLearnMode () const |
| void | learnKnob (MIDICable *cable, int32_t whichKnob, int32_t modKnobMode, int32_t midiChannel) |
| Public Member Functions inherited from deluge::gui::menu_item::Integer | |
| void | selectEncoderAction (int32_t offset) override |
| Handle select encoder movement. | |
| Public Member Functions inherited from deluge::gui::menu_item::Number | |
| void | drawHorizontalBar (int32_t yTop, int32_t marginL, int32_t marginR=-1, int32_t height=8) |
| 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) |
| int32_t | getValue () |
| 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 void | verticalEncoderAction (int32_t offset) |
| Handle vertical encoder movement. | |
| virtual ActionResult | timerCallback () |
| Handle a TimerName::UI_SPECIFIC event. | |
| 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 uint8_t | getIndexOfPatchedParamToBlink () |
| 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 bool | isRangeDependent () |
| Returns true if this parameter is only relevant to some note ranges. | |
| virtual void | renderOLED () |
| Root rendering routine for OLED. | |
| 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 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. | |
Static Private Member Functions | |
| static l10n::String | getShortEnvelopeParamName (uint8_t param) |
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::Param | |
| uint8_t | p |
| 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::Submenu * | parent {nullptr} |
| Protected Member Functions inherited from deluge::gui::menu_item::patched_param::Integer | |
| void | readCurrentValue () override |
| Like readValueAgain, but does not redraw. | |
| void | writeCurrentValue () final |
| virtual int32_t | getFinalValue () |
| Protected Member Functions inherited from deluge::gui::menu_item::PatchedParam | |
| ParamSet * | getParamSet () override |
| Protected Member Functions inherited from deluge::gui::menu_item::IntegerContinuous | |
| void | drawPixelsForOled () override |
| Paints the pixels below the standard title block. | |
| Protected Member Functions inherited from deluge::gui::menu_item::Integer | |
| virtual int32_t | getDisplayValue () |
| virtual const char * | getUnit () |
| virtual void | drawInteger (int32_t textWidth, int32_t textHeight, int32_t yPixel) |
| Protected Member Functions inherited from deluge::gui::menu_item::Number | |
| virtual NumberStyle | getNumberStyle () const |
| float | getNormalizedValue () |
| void | renderInHorizontalMenu (int32_t startX, int32_t width, int32_t startY, int32_t height) override |
| void | drawKnob (int32_t startX, int32_t startY, int32_t width, int32_t height) |
| void | drawVerticalBar (int32_t startX, int32_t startY, int32_t slotWidth, int32_t slotHeight) |
| void | drawLevel (int32_t startX, int32_t startY, int32_t slotWidth, int32_t slotHeight) |
| void | drawPercent (int32_t startX, int32_t startY, int32_t width, int32_t height) |
| void | drawSlider (int32_t startX, int32_t startY, int32_t slotWidth, int32_t slotHeight) |
| void | drawLengthSlider (int32_t startX, int32_t startY, int32_t slotWidth, int32_t slotHeight, bool minSliderPos=3) |
| void | getNotificationValue (StringBuf &value) |
| Get the parameter value string to show in the popup. | |
| Protected Attributes inherited from deluge::gui::menu_item::source::PatchedParam | |
| uint8_t | source_id_ |
| Private Member Functions inherited from deluge::gui::menu_item::FormattedTitle | |
| FormattedTitle (l10n::String format_str, std::optional< uint8_t > arg=std::nullopt) | |
| void | format (int32_t arg) const |
| std::string_view | title () const |
|
inlineoverridevirtual |
Reimplemented from MenuItem.
|
inlinenodiscardoverridevirtual |
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.