Browser Class Reference

#include <Browser.h>

Inheritance diagram for Browser:

Collaboration diagram for Browser:

Public Member Functions
	Browser ()
void	close ()
virtual int	getCurrentFilePath (String *path)=0
int	buttonAction (int x, int y, bool on, bool inCardRoutine)
void	currentFileDeleted ()
int	goIntoFolder (char const *folderName)
int	createFolder ()
void	selectEncoderAction (int8_t offset)
bool	opened ()
Public Member Functions inherited from QwertyUI
	QwertyUI ()
int	padAction (int x, int y, int velocity)
int	horizontalEncoderAction (int offset)
int	timerCallback ()
bool	renderMainPads (uint32_t whichRows, uint8_t image[][displayWidth+sideBarWidth][3]=NULL, uint8_t occupancyMask[][displayWidth+sideBarWidth]=NULL, bool drawUndefinedArea=true)
Public Member Functions inherited from UI
	UI ()
virtual int	padAction (int x, int y, int velocity)
virtual int	buttonAction (int x, int y, bool on, bool inCardRoutine)
virtual int	horizontalEncoderAction (int offset)
virtual int	verticalEncoderAction (int offset, bool inCardRoutine)
virtual void	selectEncoderAction (int8_t offset)
virtual void	modEncoderAction (int whichModEncoder, int offset)
virtual void	modButtonAction (uint8_t whichButton, bool on)
virtual void	modEncoderButtonAction (uint8_t whichModEncoder, bool on)
virtual void	graphicsRoutine ()
virtual int	timerCallback ()
virtual bool	opened ()
virtual void	focusRegained ()
virtual bool	canSeeViewUnderneath ()
virtual ClipMinder *	toClipMinder ()
virtual void	scrollFinished ()
virtual bool	noteOnReceivedForMidiLearn (MIDIDevice *fromDevice, int channel, int note, int velocity)
virtual bool	getGreyoutRowsAndCols (uint32_t *cols, uint32_t *rows)
virtual bool	renderMainPads (uint32_t whichRows=0, uint8_t image[][displayWidth+sideBarWidth][3]=NULL, uint8_t occupancyMask[][displayWidth+sideBarWidth]=NULL, bool drawUndefinedArea=true)
virtual bool	renderSidebar (uint32_t whichRows=0, uint8_t image[][displayWidth+sideBarWidth][3]=NULL, uint8_t occupancyMask[][displayWidth+sideBarWidth]=NULL)
void	close ()

Static Public Member Functions
static FileItem *	getCurrentFileItem ()
static int	readFileItemsForFolder (char const *filePrefixHere, bool allowFolders, char const **allowedFileExtensionsHere, char const *filenameToStartAt, int newMaxNumFileItems, int newCatalogSearchDirection=CATALOG_SEARCH_BOTH)
static void	sortFileItems ()
static FileItem *	getNewFileItem ()
static void	emptyFileItems ()
static void	deleteSomeFileItems (int startAt, int stopAt)
static void	deleteFolderAndDuplicateItems (int instrumentAvailabilityRequirement=AVAILABILITY_ANY)
static PresetNavigationResult	doPresetNavigation (int offset, Instrument *oldInstrument, int availabilityRequirement, bool doBlink)
static int	getUnusedSlot (int instrumentType, String *newName, char const *thingName)
static ReturnOfConfirmPresetOrNextUnlaunchedOne	confirmPresetOrNextUnlaunchedOne (int instrumentType, String *searchName, int availabilityRequirement)
static ReturnOfConfirmPresetOrNextUnlaunchedOne	findAnUnlaunchedPresetIncludingWithinSubfolders (Song *song, int instrumentType, int availabilityRequirement)
static void	cullSomeFileItems ()

Static Public Attributes
static String	currentDir
static CStringArray	fileItems
static int	numFileItemsDeletedAtStart
static int	numFileItemsDeletedAtEnd
static char const *	firstFileItemRemaining
static char const *	lastFileItemRemaining
static int	instrumentTypeToLoad
static char const *	filenameToStartSearchAt
Static Public Attributes inherited from QwertyUI
static bool	predictionInterrupted
static String	enteredText

Protected Member Functions
int	setEnteredTextFromCurrentFilename ()
int	goUpOneDirectoryLevel ()
virtual int	arrivedInNewFolder (int direction, char const *filenameToStartAt=NULL, char const *defaultDir=NULL)
bool	predictExtendedText ()
void	goIntoDeleteFileContextMenu ()
int	mainButtonAction (bool on)
virtual void	exitAction ()
virtual int	backButtonAction ()
virtual void	folderContentsReady (int entryDirection)
virtual void	currentFileChanged (int movementDirection)
void	displayText (bool blinkImmediately=false)
Protected Member Functions inherited from QwertyUI
bool	opened ()
virtual bool	predictExtendedText ()
void	drawKeys ()
virtual void	processBackspace ()
virtual void	enterKeyPress ()=0
virtual void	displayText (bool blinkImmediately=false)

Static Protected Member Functions
static Slot	getSlot (char const *displayName)
static int	readFileItemsFromFolderAndMemory (Song *song, int instrumentType, char const *filePrefixHere, char const *filenameToStartAt, char const *defaultDirToAlsoTry, bool allowFoldersint, int availabilityRequirement=AVAILABILITY_ANY, int newCatalogSearchDirection=CATALOG_SEARCH_RIGHT)

Protected Attributes
bool	shouldWrapFolderContents
bool	allowBrandNewNames
bool	qwertyAlwaysVisible
char const *	filePrefix

Static Protected Attributes
static int	fileIndexSelected
static int	scrollPosVertical
static int	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 int16_t	enteredTextEditPos
static int	scrollPosHorizontal

Constructor & Destructor Documentation

Browser()

Browser::Browser

(

)

Member Function Documentation

arrivedInNewFolder()

int Browser::arrivedInNewFolder ( int  direction, char const *  filenameToStartAt = NULL, char const *  defaultDir = NULL  )

protectedvirtual

backButtonAction()

int Browser::backButtonAction ( )

protectedvirtual

Reimplemented in SampleBrowser.

buttonAction()

int Browser::buttonAction ( int  x, int  y, bool  on, bool  inCardRoutine  )

virtual

Reimplemented from UI.

Reimplemented in LoadInstrumentPresetUI, LoadSongUI, SampleBrowser, and SaveUI.

close()

void Browser::close

(

)

confirmPresetOrNextUnlaunchedOne()

ReturnOfConfirmPresetOrNextUnlaunchedOne Browser::confirmPresetOrNextUnlaunchedOne ( int  instrumentType, String *  searchName, int  availabilityRequirement  )

static

createFolder()

int Browser::createFolder

(

)

cullSomeFileItems()

void Browser::cullSomeFileItems ( )

static

currentFileChanged()

virtual void Browser::currentFileChanged ( int  movementDirection )

inlineprotectedvirtual

Reimplemented in LoadInstrumentPresetUI, LoadSongUI, and SampleBrowser.

currentFileDeleted()

void Browser::currentFileDeleted

(

)

deleteFolderAndDuplicateItems()

void Browser::deleteFolderAndDuplicateItems ( int  instrumentAvailabilityRequirement = AVAILABILITY_ANY )

static

deleteSomeFileItems()

void Browser::deleteSomeFileItems ( int  startAt, int  stopAt  )

static

displayText()

void Browser::displayText ( bool  blinkImmediately = false )

protectedvirtual

Reimplemented from QwertyUI.

Reimplemented in LoadSongUI.

doPresetNavigation()

PresetNavigationResult Browser::doPresetNavigation ( int  offset, Instrument *  oldInstrument, int  availabilityRequirement, bool  doBlink  )

static

emptyFileItems()

void Browser::emptyFileItems ( )

static

exitAction()

void Browser::exitAction ( )

protectedvirtual

Reimplemented in LoadSongUI, and SampleBrowser.

findAnUnlaunchedPresetIncludingWithinSubfolders()

ReturnOfConfirmPresetOrNextUnlaunchedOne Browser::findAnUnlaunchedPresetIncludingWithinSubfolders ( Song *  song, int  instrumentType, int  availabilityRequirement  )

static

folderContentsReady()

virtual void Browser::folderContentsReady ( int  entryDirection )

inlineprotectedvirtual

Reimplemented in LoadInstrumentPresetUI, LoadSongUI, and SampleBrowser.

getCurrentFileItem()

FileItem * Browser::getCurrentFileItem ( )

static

getCurrentFilePath()

virtual int Browser::getCurrentFilePath ( String *  path )

pure virtual

Implemented in SlotBrowser.

getNewFileItem()

FileItem * Browser::getNewFileItem ( )

static

getSlot()

Slot Browser::getSlot ( char const *  displayName )

staticprotected

getUnusedSlot()

int Browser::getUnusedSlot ( int  instrumentType, String *  newName, char const *  thingName  )

static

goIntoDeleteFileContextMenu()

void Browser::goIntoDeleteFileContextMenu ( )

protected

goIntoFolder()

int Browser::goIntoFolder

(

char const *

folderName

)

goUpOneDirectoryLevel()

int Browser::goUpOneDirectoryLevel ( )

protected

mainButtonAction()

int Browser::mainButtonAction ( bool  on )

protected

opened()

bool Browser::opened ( )

virtual

Reimplemented from UI.

Reimplemented in LoadInstrumentPresetUI, LoadSongUI, SampleBrowser, SaveInstrumentPresetUI, SaveSongUI, and SaveUI.

predictExtendedText()

bool Browser::predictExtendedText ( )

protectedvirtual

Reimplemented from QwertyUI.

readFileItemsForFolder()

int Browser::readFileItemsForFolder ( char const *  filePrefixHere, bool  allowFolders, char const **  allowedFileExtensionsHere, char const *  filenameToStartAt, int  newMaxNumFileItems, int  newCatalogSearchDirection = CATALOG_SEARCH_BOTH  )

static

readFileItemsFromFolderAndMemory()

int Browser::readFileItemsFromFolderAndMemory ( Song *  song, int  instrumentType, char const *  filePrefixHere, char const *  filenameToStartAt, char const *  defaultDirToAlsoTry, bool  allowFoldersint, int  availabilityRequirement = AVAILABILITY_ANY, int  newCatalogSearchDirection = CATALOG_SEARCH_RIGHT  )

staticprotected

selectEncoderAction()

void Browser::selectEncoderAction ( int8_t  offset )

virtual

Reimplemented from UI.

Reimplemented in LoadSongUI.

setEnteredTextFromCurrentFilename()

int Browser::setEnteredTextFromCurrentFilename ( )

protected

sortFileItems()

void Browser::sortFileItems ( )

static

Member Data Documentation

allowBrandNewNames

bool Browser::allowBrandNewNames

protected

allowedFileExtensions

char const ** Browser::allowedFileExtensions

staticprotected

allowFoldersSharingNameWithFile

bool Browser::allowFoldersSharingNameWithFile

staticprotected

arrivedAtFileByTyping

bool Browser::arrivedAtFileByTyping

staticprotected

currentDir

String Browser::currentDir

static

fileIndexSelected

int Browser::fileIndexSelected

staticprotected

fileItems

CStringArray Browser::fileItems

static

filenameToStartSearchAt

char const * Browser::filenameToStartSearchAt

static

filePrefix

char const* Browser::filePrefix

protected

firstFileItemRemaining

char const * Browser::firstFileItemRemaining

static

instrumentTypeToLoad

int Browser::instrumentTypeToLoad

static

lastFileItemRemaining

char const * Browser::lastFileItemRemaining

static

numberEditPos

int8_t Browser::numberEditPos

staticprotected

numCharsInPrefix

int Browser::numCharsInPrefix

staticprotected

numFileItemsDeletedAtEnd

int Browser::numFileItemsDeletedAtEnd

static

numFileItemsDeletedAtStart

int Browser::numFileItemsDeletedAtStart

static

qwertyAlwaysVisible

bool Browser::qwertyAlwaysVisible

protected

qwertyVisible

bool Browser::qwertyVisible

staticprotected

scrollingText

NumericLayerScrollingText * Browser::scrollingText

staticprotected

scrollPosVertical

int Browser::scrollPosVertical

staticprotected

shouldWrapFolderContents

bool Browser::shouldWrapFolderContents

protected

---

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

• src/Browser.h
• src/Browser.cpp