RenameUI Class Reference

Inheritance diagram for RenameUI:

Collaboration diagram for RenameUI:

Public Member Functions
	RenameUI (const char *title_)
bool	opened ()
void	displayText (bool blinkImmediately=false) override
void	renderOLED (deluge::hid::display::oled_canvas::Canvas &canvas) override
bool	getGreyoutColsAndRows (uint32_t *cols, uint32_t *rows) override
bool	exitUI () override
	returns whether a UI exited
ActionResult	buttonAction (deluge::hid::Button b, bool on, bool inCardRoutine) override
ActionResult	padAction (int32_t x, int32_t y, int32_t velocity) override
ActionResult	verticalEncoderAction (int32_t offset, bool inCardRoutine) override
UIType	getUIType () override
Public Member Functions inherited from QwertyUI
ActionResult	horizontalEncoderAction (int32_t offset) override
ActionResult	timerCallback () override
bool	renderMainPads (uint32_t whichRows, RGB image[][kDisplayWidth+kSideBarWidth]=nullptr, uint8_t occupancyMask[][kDisplayWidth+kSideBarWidth]=nullptr, bool drawUndefinedArea=true) override
Public Member Functions inherited from UI
virtual void	selectEncoderAction (int8_t offset)
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 void	focusRegained ()
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	renderSidebar (uint32_t whichRows=0, RGB image[][kDisplayWidth+kSideBarWidth]=nullptr, uint8_t occupancyMask[][kDisplayWidth+kSideBarWidth]=nullptr)
void	close ()

Protected Member Functions
void	enterKeyPress () override
virtual bool	trySetName (String *)=0
virtual String	getName () const =0
virtual bool	canRename () const
virtual bool	allowEmpty () const
Protected Member Functions inherited from QwertyUI
virtual bool	predictExtendedText ()
void	drawKeys ()
virtual void	processBackspace ()
void	drawTextForOLEDEditing (int32_t textStartX, int32_t xPixelMax, int32_t yPixel, int32_t maxChars, deluge::hid::display::oled_canvas::Canvas &canvas)
void	renderFavourites ()

Additional Inherited Members
Public Attributes inherited from UI
bool	oledShowsUIUnderneath
Static Public Attributes inherited from QwertyUI
static bool	predictionInterrupted
static String	enteredText {}
Protected Attributes inherited from QwertyUI
char const *	title
Protected Attributes inherited from UI
UIType	uiType
Static Protected Attributes inherited from QwertyUI
static uint8_t	favouriteRow = 6
static constexpr uint8_t	favouriteBankRow = 7
static int16_t	enteredTextEditPos
static int32_t	scrollPosHorizontal
static bool	favouritesVisible = false
static bool	banksVisible = false

Member Function Documentation

buttonAction()

ActionResult RenameUI::buttonAction ( deluge::hid::Button b, bool on, bool inCardRoutine )

overridevirtual

Reimplemented from UI.

displayText()

void RenameUI::displayText ( bool blinkImmediately = false )

overridevirtual

Reimplemented from QwertyUI.

enterKeyPress()

void RenameUI::enterKeyPress ( )

overrideprotectedvirtual

Implements QwertyUI.

exitUI()

bool RenameUI::exitUI ( )

overridevirtual

returns whether a UI exited

Reimplemented from UI.

getGreyoutColsAndRows()

bool RenameUI::getGreyoutColsAndRows ( uint32_t * cols, uint32_t * rows )

overridevirtual

Reimplemented from UI.

getUIType()

UIType RenameUI::getUIType ( )

inlineoverridevirtual

Implements UI.

opened()

bool RenameUI::opened ( )

virtual

Reimplemented from QwertyUI.

padAction()

ActionResult RenameUI::padAction ( int32_t x, int32_t y, int32_t velocity )

overridevirtual

Reimplemented from QwertyUI.

renderOLED()

void RenameUI::renderOLED ( deluge::hid::display::oled_canvas::Canvas & canvas )

overridevirtual

Implements UI.

verticalEncoderAction()

ActionResult RenameUI::verticalEncoderAction ( int32_t offset, bool inCardRoutine )

overridevirtual

Reimplemented from UI.

---

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

• src/deluge/gui/ui/rename/rename_ui.h
• src/deluge/gui/ui/rename/rename_ui.cpp