 |
Deluge Firmware 1.3.0
Build date: 2025.08.10
|
|
Deluge Firmware 1.3.0
Build date: 2025.08.10
|
Public Member Functions | |
| 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). | |
| Submenu (l10n::String newName, std::initializer_list< MenuItem * > newItems) | |
| Submenu (l10n::String newName, std::span< MenuItem * > newItems) | |
| Submenu (l10n::String newName, l10n::String title, std::initializer_list< MenuItem * > newItems) | |
| Submenu (l10n::String newName, l10n::String title, std::span< MenuItem * > newItems) | |
| Public Member Functions inherited from deluge::gui::menu_item::Submenu | |
| Submenu (l10n::String newName, std::initializer_list< MenuItem * > newItems) | |
| Submenu (l10n::String newName, std::span< MenuItem * > newItems) | |
| Submenu (l10n::String newName, l10n::String title, std::initializer_list< MenuItem * > newItems) | |
| Submenu (l10n::String newName, l10n::String title, std::span< MenuItem * > newItems) | |
| void | beginSession (MenuItem *navigatedBackwardFrom=nullptr) override |
| Begin an editing session with this menu item. | |
| void | updateDisplay () |
| void | selectEncoderAction (int32_t offset) override |
| Handle select encoder movement. | |
| MenuItem * | selectButtonPress () final |
| Handle a select button press. | |
| ActionResult | buttonAction (deluge::hid::Button b, bool on, bool inCardRoutine) override |
| Handle an arbitrary button. | |
| void | readValueAgain () final |
| Re-read the value from the system and redraw the display to match. | |
| void | unlearnAction () final |
| Unlearn the parameter controlled by this menu. | |
| bool | usesAffectEntire () override |
| Claim support for Kit AFFECT_ENTIRE editing. | |
| 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 |
| void | learnProgramChange (MIDICable &cable, int32_t channel, int32_t programNumber) override |
| bool | learnNoteOn (MIDICable &cable, int32_t channel, int32_t noteCode) final |
| Attempt to bind this menu item to a note code. | |
| virtual RenderingStyle | renderingStyle () const |
| void | renderInHorizontalMenu (int32_t startX, int32_t width, int32_t startY, int32_t height) override |
| void | drawPixelsForOled () override |
| Paints the pixels below the standard title block. | |
| void | drawSubmenuItemsForOled (std::span< MenuItem * > options, const int32_t selectedOption) |
| bool | wrapAround () |
| Indicates if the menu-like object should wrap-around. Destined to be virtualized. At the moment implements the legacy behaviour of wrapping on 7seg but not on OLED. | |
| bool | isSubmenu () override |
| virtual bool | focusChild (const MenuItem *child) |
| void | updatePadLights () override |
| MenuItem * | patchingSourceShortcutPress (PatchSource s, bool previousPressStillActive=false) override |
| Action to take when a source shortcut is pressed. | |
| deluge::modulation::params::Kind | getParamKind () override |
| uint32_t | getParamIndex () override |
| int32_t | getColumnSpan () const override |
| Get the number of occupied virtual columns in Horizontal menu. | |
| bool | showNotification () const override |
| Show a popup with the full name and value of the editing parameter at the top of Horizontal menu. | |
| 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 | 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 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 void | readCurrentValue () |
| Like readValueAgain, but does not redraw. | |
| virtual uint8_t | getIndexOfPatchedParamToBlink () |
| virtual uint8_t | shouldBlinkPatchingSourceShortcut (PatchSource s, uint8_t *colour) |
| 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 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 void | setupNumberEditor () |
| virtual void | updateAutomationViewParameter () |
| virtual void | getColumnLabel (StringBuf &label) |
| virtual bool | showColumnLabel () const |
| Show a label for the parameter in 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. | |
Additional Inherited Members | |
| Public Types inherited from deluge::gui::menu_item::Submenu | |
| enum | RenderingStyle { VERTICAL , HORIZONTAL } |
| 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. | |
| 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 Attributes inherited from deluge::gui::menu_item::Submenu | |
| uint32_t | initial_index_ = 0 |
| deluge::vector< MenuItem * > | items |
| decltype(items) ::iterator | current_item_ |
|
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.