Deluge Firmware 1.3.0
Build date: 2025.06.05
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
deluge::gui::ContextMenu Class Referenceabstract
Inheritance diagram for deluge::gui::ContextMenu:
Inheritance graph
[legend]
Collaboration diagram for deluge::gui::ContextMenu:
Collaboration graph
[legend]

Public Member Functions

void focusRegained () override
 
void selectEncoderAction (int8_t offset) override
 
ActionResult buttonAction (deluge::hid::Button b, bool on, bool inCardRoutine) override
 
void drawCurrentOption ()
 
virtual bool isCurrentOptionAvailable ()
 
virtual bool acceptCurrentOption ()
 
virtual std::span< char const * > getOptions ()=0
 
bool getGreyoutColsAndRows (uint32_t *cols, uint32_t *rows) override
 
ActionResult padAction (int32_t x, int32_t y, int32_t velocity) override
 
virtual bool setupAndCheckAvailability ()
 
virtual deluge::hid::Button getAcceptButton ()
 
void renderOLED (deluge::hid::display::oled_canvas::Canvas &canvas) override
 
virtual char const * getTitle ()=0
 
UIType getUIType () override
 What type of UI is this? e.g. UIType::ARRANGER.
 
- Public Member Functions inherited from UI
virtual ActionResult horizontalEncoderAction (int32_t offset)
 
virtual ActionResult verticalEncoderAction (int32_t offset, bool inCardRoutine)
 
virtual void modEncoderAction (int32_t whichModEncoder, int32_t offset)
 
virtual void modButtonAction (uint8_t whichButton, bool on)
 
virtual void modEncoderButtonAction (uint8_t whichModEncoder, bool on)
 
virtual void graphicsRoutine ()
 
virtual ActionResult timerCallback ()
 
virtual bool opened ()
 
virtual void displayOrLanguageChanged ()
 
virtual bool canSeeViewUnderneath ()
 
virtual ClipMinder * toClipMinder ()
 
virtual TimelineView * toTimelineView ()
 Convert this view to a TimelineView.
 
virtual void scrollFinished ()
 
virtual bool pcReceivedForMidiLearn (MIDICable &fromCable, int32_t channel, int32_t program)
 
virtual bool noteOnReceivedForMidiLearn (MIDICable &fromCable, int32_t channel, int32_t note, int32_t velocity)
 
virtual bool renderMainPads (uint32_t whichRows=0, RGB image[][kDisplayWidth+kSideBarWidth]=nullptr, uint8_t occupancyMask[][kDisplayWidth+kSideBarWidth]=nullptr, bool drawUndefinedArea=true)
 
virtual bool renderSidebar (uint32_t whichRows=0, RGB image[][kDisplayWidth+kSideBarWidth]=nullptr, uint8_t occupancyMask[][kDisplayWidth+kSideBarWidth]=nullptr)
 
virtual bool exitUI ()
 returns whether a UI exited
 
void close ()
 
virtual UI * getUI ()
 When entering a UI (e.g. automationView), you may wish to open a different UI based on the current context (e.g. automationViewArranger, automationViewAudioClip, etc.)
 
virtual UIType getUIContextType ()
 What context does UI relate to? e.g. UIType could be AUTOMATION but UIContextType could be ARRANGER, AUDIO CLIP, INSTRUMENT CLIP.
 
virtual UIModControllableContext getUIModControllableContext ()
 What mod controllable context is this UI using? E.g. Automation View can use the Song ModControllable when in Arranger but the Clip ModControllable when in a Clip.
 

Public Attributes

int32_t currentOption = 0
 
int32_t scrollPos = 0
 
- Public Attributes inherited from UI
bool oledShowsUIUnderneath
 

Additional Inherited Members

- Protected Attributes inherited from UI
UIType uiType
 

Member Function Documentation

◆ buttonAction()

ActionResult deluge::gui::ContextMenu::buttonAction ( deluge::hid::Button b,
bool on,
bool inCardRoutine )
overridevirtual

Reimplemented from UI.

◆ focusRegained()

void deluge::gui::ContextMenu::focusRegained ( )
overridevirtual

Reimplemented from UI.

◆ getGreyoutColsAndRows()

bool deluge::gui::ContextMenu::getGreyoutColsAndRows ( uint32_t * cols,
uint32_t * rows )
overridevirtual

Reimplemented from UI.

◆ getOptions()

virtual std::span< char const * > deluge::gui::ContextMenu::getOptions ( )
pure virtual

Implemented in deluge::gui::context_menu::AudioInputSelector, deluge::gui::context_menu::clip_settings::ClipSettingsMenu, deluge::gui::context_menu::clip_settings::LaunchStyleMenu, and deluge::gui::context_menu::clip_settings::NewClipType.

◆ getTitle()

virtual char const * deluge::gui::ContextMenu::getTitle ( )
pure virtual

Implemented in deluge::gui::context_menu::AudioInputSelector, deluge::gui::context_menu::clip_settings::ClipSettingsMenu, deluge::gui::context_menu::clip_settings::LaunchStyleMenu, and deluge::gui::context_menu::clip_settings::NewClipType.

◆ getUIType()

UIType deluge::gui::ContextMenu::getUIType ( )
inlineoverridevirtual

What type of UI is this? e.g. UIType::ARRANGER.

Implements UI.

◆ padAction()

ActionResult deluge::gui::ContextMenu::padAction ( int32_t x,
int32_t y,
int32_t velocity )
overridevirtual

Reimplemented from UI.

◆ renderOLED()

void deluge::gui::ContextMenu::renderOLED ( deluge::hid::display::oled_canvas::Canvas & canvas)
overridevirtual

Implements UI.

◆ selectEncoderAction()

void deluge::gui::ContextMenu::selectEncoderAction ( int8_t offset)
overridevirtual

Reimplemented from UI.

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