Inheritance diagram for SampleBrowser:

[legend]

Collaboration diagram for SampleBrowser:

[legend]

Public Member Functions
bool	getGreyoutColsAndRows (uint32_t cols, uint32_t rows) override
bool	opened () override
void	focusRegained () override
ActionResult	buttonAction (deluge::hid::Button b, bool on, bool inCardRoutine) override
ActionResult	verticalEncoderAction (int32_t offset, bool inCardRoutine) override
ActionResult	horizontalEncoderAction (int32_t offset) override
ActionResult	padAction (int32_t x, int32_t y, int32_t velocity) override
bool	canSeeViewUnderneath () override
Error	claimAudioFileForInstrument (bool makeWaveTableWorkAtAllCosts=false)
Error	claimAudioFileForAudioClip ()
void	scrollFinished () override
bool	importFolderAsKit ()
bool	importFolderAsMultisamples ()
ActionResult	timerCallback () override
bool	claimCurrentFile (int32_t mayDoPitchDetection=1, int32_t mayDoSingleCycle=1, int32_t mayDoWaveTable=1, bool loadWithoutExiting=false)
bool	renderMainPads (uint32_t whichRows, RGB image[][kDisplayWidth+kSideBarWidth], uint8_t occupancyMask[][kDisplayWidth+kSideBarWidth], bool drawUndefinedArea=true) override
void	exitAndNeverDeleteDrum ()
UIType	getUIType () override
	What type of UI is this? e.g. UIType::ARRANGER.
Public Member Functions inherited from Browser
void	close ()
void	currentFileDeleted ()
Error	goIntoFolder (char const *folderName)
Error	createFolder ()
Error	createFoldersRecursiveIfNotExists (const char *path)
void	selectEncoderAction (int8_t offset) override
Error	readFileItemsForFolder (char const filePrefixHere, bool allowFolders, char const allowedFileExtensionsHere, char const filenameToStartAt, int32_t newMaxNumFileItems, int32_t newCatalogSearchDirection=CATALOG_SEARCH_BOTH)
Error	setFileByFullPath (OutputType outputType, char const *fullPath)
void	sortFileItems ()
FileItem *	getNewFileItem ()
Error	getUnusedSlot (OutputType outputType, String newName, char const thingName)
void	cullSomeFileItems ()
bool	checkFP ()
void	renderOLED (deluge::hid::display::oled_canvas::Canvas &canvas) override
bool	exitUI () override
	returns whether a UI exited
Public Member Functions inherited from UI
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	displayOrLanguageChanged ()
virtual ClipMinder *	toClipMinder ()
virtual TimelineView *	toTimelineView ()
	Convert this view to a TimelineView.
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 ()
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
String	lastFilePathLoaded
Public Attributes inherited from UI
bool	oledShowsUIUnderneath

Protected Member Functions
void	enterKeyPress () override
void	exitAction () override
ActionResult	backButtonAction () override
void	folderContentsReady (int32_t entryDirection) override
void	currentFileChanged (int32_t movementDirection) override
Protected Member Functions inherited from Browser
Error	setEnteredTextFromCurrentFilename ()
Error	goUpOneDirectoryLevel ()
virtual Error	arrivedInNewFolder (int32_t direction, char const filenameToStartAt=nullptr, char const defaultDir=nullptr)
bool	predictExtendedText () override
void	goIntoDeleteFileContextMenu ()
ActionResult	mainButtonAction (bool on)
void	displayText (bool blinkImmediately=false) override
Error	readFileItemsFromFolderAndMemory (Song song, OutputType outputType, char const filePrefixHere, char const filenameToStartAt, char const defaultDirToAlsoTry, bool allowFoldersint, Availability availabilityRequirement=Availability::ANY, int32_t newCatalogSearchDirection=CATALOG_SEARCH_RIGHT)
void	favouritesChanged ()
Protected Member Functions inherited from QwertyUI
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 ()

Private Member Functions
void	displayCurrentFilename ()
void	previewIfPossible (int32_t movementDirection=1)
void	audioFileIsNowSet ()
bool	canImportWholeKit ()
bool	loadAllSamplesInFolder (bool detectPitch, int32_t getNumSamples, Sample *getSortArea, bool getDoingSingleCycle=nullptr, int32_t *getNumCharsInPrefix=nullptr)
Error	getCurrentFilePath (String *path) override
void	drawKeysOverWaveform ()
void	autoDetectSideChainSending (SoundDrum drum, Source source, char const *fileName)
void	possiblySetUpBlinking ()

Private Attributes
bool	autoLoadEnabled
bool	currentlyShowingSamplePreview
bool	qwertyCurrentlyDrawnOnscreen

Additional Inherited Members
Static Public Member Functions inherited from Browser
static FileItem *	getCurrentFileItem ()
static void	emptyFileItems ()
static void	deleteSomeFileItems (int32_t startAt, int32_t stopAt)
static void	deleteFolderAndDuplicateItems (Availability instrumentAvailabilityRequirement=Availability::ANY)
Static Public Attributes inherited from Browser
static String	currentDir {}
static CStringArray	fileItems {sizeof(FileItem)}
static int32_t	numFileItemsDeletedAtStart
static int32_t	numFileItemsDeletedAtEnd
static char const *	firstFileItemRemaining
static char const *	lastFileItemRemaining
static OutputType	outputTypeToLoad
static char const *	filenameToStartSearchAt
Static Public Attributes inherited from QwertyUI
static bool	predictionInterrupted
static String	enteredText {}
Static Protected Member Functions inherited from Browser
static Slot	getSlot (char const *displayName)
Protected Attributes inherited from Browser
const uint8_t *	fileIcon
const uint8_t *	fileIconPt2
int32_t	fileIconPt2Width
bool	shouldWrapFolderContents
bool	mayDefaultToBrandNewNameOnEntry
bool	qwertyAlwaysVisible
char const *	filePrefix
bool	shouldInterpretNoteNamesForThisBrowser
Protected Attributes inherited from QwertyUI
char const *	title
Protected Attributes inherited from UI
UIType	uiType
Static Protected Attributes inherited from Browser
static int32_t	fileIndexSelected
static int32_t	scrollPosVertical
static int32_t	numCharsInPrefix
static bool	qwertyVisible
static bool	arrivedAtFileByTyping
static bool	allowFoldersSharingNameWithFile
static char const **	allowedFileExtensions
static int8_t	numberEditPos
static NumericLayerScrollingText *	scrollingText
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

◆ backButtonAction()

ActionResult SampleBrowser::backButtonAction ( )

overrideprotectedvirtual

Reimplemented from Browser.

◆ buttonAction()

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

overridevirtual

Reimplemented from Browser.

◆ canSeeViewUnderneath()

bool SampleBrowser::canSeeViewUnderneath ( )

overridevirtual

Reimplemented from UI.

◆ currentFileChanged()

void SampleBrowser::currentFileChanged ( int32_t movementDirection )

overrideprotectedvirtual

Reimplemented from Browser.

◆ enterKeyPress()

void SampleBrowser::enterKeyPress ( )

overrideprotectedvirtual

Implements QwertyUI.

◆ exitAction()

void SampleBrowser::exitAction ( )

overrideprotectedvirtual

Reimplemented from Browser.

◆ focusRegained()

void SampleBrowser::focusRegained ( )

overridevirtual

Reimplemented from UI.

◆ folderContentsReady()

void SampleBrowser::folderContentsReady ( int32_t entryDirection )

overrideprotectedvirtual

Reimplemented from Browser.

◆ getCurrentFilePath()

Error SampleBrowser::getCurrentFilePath ( String * path )

overrideprivatevirtual

Implements Browser.

◆ getGreyoutColsAndRows()

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

overridevirtual

Reimplemented from UI.

◆ getUIType()

UIType SampleBrowser::getUIType ( )

inlineoverridevirtual

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

Implements UI.

◆ horizontalEncoderAction()

ActionResult SampleBrowser::horizontalEncoderAction ( int32_t offset )

overridevirtual

Reimplemented from QwertyUI.

◆ opened()

bool SampleBrowser::opened ( )

overridevirtual

Reimplemented from Browser.

◆ padAction()

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

overridevirtual

Reimplemented from Browser.

◆ renderMainPads()

bool SampleBrowser::renderMainPads	(	uint32_t	whichRows,
		RGB	image[][kDisplayWidth+kSideBarWidth],
		uint8_t	occupancyMask[][kDisplayWidth+kSideBarWidth],
		bool	drawUndefinedArea = true )

overridevirtual

Reimplemented from QwertyUI.

◆ scrollFinished()

void SampleBrowser::scrollFinished ( )

overridevirtual

Reimplemented from UI.

◆ timerCallback()

ActionResult SampleBrowser::timerCallback ( )

overridevirtual

Reimplemented from QwertyUI.

◆ verticalEncoderAction()

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

overridevirtual

Reimplemented from Browser.

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

src/deluge/gui/ui/browser/sample_browser.h
src/deluge/gui/ui/browser/sample_browser.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Function Documentation

◆ backButtonAction()

◆ buttonAction()

◆ canSeeViewUnderneath()

◆ currentFileChanged()

◆ enterKeyPress()

◆ exitAction()

◆ focusRegained()

◆ folderContentsReady()

◆ getCurrentFilePath()

◆ getGreyoutColsAndRows()

◆ getUIType()

◆ horizontalEncoderAction()

◆ opened()

◆ padAction()

◆ renderMainPads()

◆ scrollFinished()

◆ timerCallback()

◆ verticalEncoderAction()