Deluge Firmware 1.3.0
Build date: 2025.04.16
Loading...
Searching...
No Matches
deluge::gui::menu_item::note::IteranceStepToggle Class Reference
Inheritance diagram for deluge::gui::menu_item::note::IteranceStepToggle:
Collaboration diagram for deluge::gui::menu_item::note::IteranceStepToggle:

Public Member Functions

 IteranceStepToggle (l10n::String newName, l10n::String title, uint8_t newIndex)
 
void readCurrentValue () override
 Like readValueAgain, but does not redraw.
 
void writeCurrentValue () override
 
bool isRelevant (ModControllableAudio *modControllable, int32_t whichThing) override
 Check if this MenuItem should show up in a containing deluge::gui::menu_item::Submenu.
 
- Public Member Functions inherited from deluge::gui::menu_item::Toggle
void beginSession (MenuItem *navigatedBackwardFrom) override
 Begin an editing session with this menu item.
 
void selectEncoderAction (int32_t offset) override
 Handle select encoder movement.
 
virtual void drawValue ()
 
void drawPixelsForOled ()
 Paints the pixels below the standard title block.
 
void displayToggleValue ()
 
bool shouldEnterSubmenu () override
 Check if selecting this menu item (with select encoder) should enter a submenu.
 
void renderSubmenuItemTypeForOled (int32_t yPixel) override
 
void toggleValue ()
 
MenuItemselectButtonPress () override
 Handle a select button press.
 
bool getToggleValue ()
 
uint8_t shouldDrawDotOnName () override
 Get the "draw dot state".
 
- Public Member Functions inherited from deluge::gui::menu_item::Value< bool >
 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 (bool value)
 
void setValue (E value)
 
bool 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 uint8_t getIndexOfPatchedParamToBlink ()
 
virtual deluge::modulation::params::Kind getParamKind ()
 
virtual uint32_t getParamIndex ()
 
virtual uint8_t shouldBlinkPatchingSourceShortcut (PatchSource s, uint8_t *colour)
 
virtual MenuItempatchingSourceShortcutPress (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 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 int32_t getSubmenuItemTypeRenderLength ()
 Handle rendering of submenu item types.
 
virtual int32_t getSubmenuItemTypeRenderIconStart ()
 
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

uint8_t index
 
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

◆ isRelevant()

bool deluge::gui::menu_item::note::IteranceStepToggle::isRelevant ( ModControllableAudio * modControllable,
int32_t whichThing )
inlineoverridevirtual

Check if this MenuItem should show up in a containing deluge::gui::menu_item::Submenu.

Parameters
soundSound we would edit if we were to be entered.
whichThingSource index within the sound. Usually ignored, but matters for e.g. oscillator and FM modulator parameters.

Reimplemented from MenuItem.

◆ readCurrentValue()

void deluge::gui::menu_item::note::IteranceStepToggle::readCurrentValue ( )
inlineoverridevirtual

Like readValueAgain, but does not redraw.

Reimplemented from MenuItem.

◆ writeCurrentValue()

void deluge::gui::menu_item::note::IteranceStepToggle::writeCurrentValue ( )
inlineoverridevirtual

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