openshot-audio  0.1.4
Classes | Public Member Functions | List of all members
juce::DirectoryContentsList Class Reference

#include <juce_gui_basics.h>

Inheritance diagram for juce::DirectoryContentsList:
juce::ChangeBroadcaster juce::TimeSliceClient

Classes

struct  FileInfo
 

Public Member Functions

 DirectoryContentsList (const FileFilter *fileFilter, TimeSliceThread &threadToUse)
 
 ~DirectoryContentsList ()
 
const FilegetDirectory () const noexcept
 
void setDirectory (const File &directory, bool includeDirectories, bool includeFiles)
 
bool isFindingDirectories () const noexcept
 
bool isFindingFiles () const noexcept
 
void clear ()
 
void refresh ()
 
bool isStillLoading () const
 
void setIgnoresHiddenFiles (bool shouldIgnoreHiddenFiles)
 
bool ignoresHiddenFiles () const
 
void setFileFilter (const FileFilter *newFileFilter)
 
int getNumFiles () const noexcept
 
bool getFileInfo (int index, FileInfo &resultInfo) const
 
File getFile (int index) const
 
const FileFiltergetFilter () const noexcept
 
bool contains (const File &) const
 
TimeSliceThreadgetTimeSliceThread () const noexcept
 
- Public Member Functions inherited from juce::ChangeBroadcaster
 ChangeBroadcaster () noexcept
 
virtual ~ChangeBroadcaster ()
 
void addChangeListener (ChangeListener *listener)
 
void removeChangeListener (ChangeListener *listener)
 
void removeAllChangeListeners ()
 
void sendChangeMessage ()
 
void sendSynchronousChangeMessage ()
 
void dispatchPendingMessages ()
 

Detailed Description

A class to asynchronously scan for details about the files in a directory.

This keeps a list of files and some information about them, using a background thread to scan for more files. As files are found, it broadcasts change messages to tell any listeners.

See also
FileListComponent, FileBrowserComponent

Constructor & Destructor Documentation

◆ DirectoryContentsList()

DirectoryContentsList::DirectoryContentsList ( const FileFilter fileFilter,
TimeSliceThread threadToUse 
)

Creates a directory list.

To set the directory it should point to, use setDirectory(), which will also start it scanning for files on the background thread.

When the background thread finds and adds new files to this list, the ChangeBroadcaster class will send a change message, so you can register listeners and update them when the list changes.

Parameters
fileFilteran optional filter to select which files are included in the list. If this is nullptr, then all files and directories are included. Make sure that the filter doesn't get deleted during the lifetime of this object
threadToUsea thread object that this list can use to scan for files as a background task. Make sure that the thread you give it has been started, or you won't get any files!

◆ ~DirectoryContentsList()

DirectoryContentsList::~DirectoryContentsList ( )

Destructor.

Member Function Documentation

◆ clear()

void DirectoryContentsList::clear ( )

Clears the list, and stops the thread scanning for files.

◆ contains()

bool DirectoryContentsList::contains ( const File targetFile) const

Returns true if the list contains the specified file.

◆ getDirectory()

const File& juce::DirectoryContentsList::getDirectory ( ) const
inlinenoexcept

Returns the directory that's currently being used.

◆ getFile()

File DirectoryContentsList::getFile ( int  index) const

Returns one of the files in the list.

Parameters
indexshould be less than getNumFiles(). If this is out-of-range, the return value will be File::nonexistent
See also
getNumFiles, getFileInfo

◆ getFileInfo()

bool DirectoryContentsList::getFileInfo ( int  index,
FileInfo resultInfo 
) const

Returns the cached information about one of the files in the list.

If the index is in-range, this will return true and will copy the file's details to the structure that is passed-in.

If it returns false, then the index wasn't in range, and the structure won't be affected.

See also
getNumFiles, getFile

◆ getFilter()

const FileFilter* juce::DirectoryContentsList::getFilter ( ) const
inlinenoexcept

Returns the file filter being used. The filter is specified in the constructor.

◆ getNumFiles()

int juce::DirectoryContentsList::getNumFiles ( ) const
inlinenoexcept

Returns the number of files currently available in the list.

The info about one of these files can be retrieved with getFileInfo() or getFile().

Obviously as the background thread runs and scans the directory for files, this number will change.

See also
getFileInfo, getFile

◆ getTimeSliceThread()

TimeSliceThread& juce::DirectoryContentsList::getTimeSliceThread ( ) const
inlinenoexcept

◆ ignoresHiddenFiles()

bool DirectoryContentsList::ignoresHiddenFiles ( ) const

Returns true if hidden files are ignored.

See also
setIgnoresHiddenFiles

◆ isFindingDirectories()

bool juce::DirectoryContentsList::isFindingDirectories ( ) const
inlinenoexcept

Returns true if this list contains directories.

See also
setDirectory

◆ isFindingFiles()

bool juce::DirectoryContentsList::isFindingFiles ( ) const
inlinenoexcept

Returns true if this list contains files.

See also
setDirectory

◆ isStillLoading()

bool DirectoryContentsList::isStillLoading ( ) const

True if the background thread hasn't yet finished scanning for files.

◆ refresh()

void DirectoryContentsList::refresh ( )

Clears the list and restarts scanning the directory for files.

◆ setDirectory()

void DirectoryContentsList::setDirectory ( const File directory,
bool  includeDirectories,
bool  includeFiles 
)

Sets the directory to look in for files.

If the directory that's passed in is different to the current one, this will also start the background thread scanning it for files.

◆ setFileFilter()

void DirectoryContentsList::setFileFilter ( const FileFilter newFileFilter)

Replaces the current FileFilter. This can be nullptr to have no filter. The DirectoryContentList does not take ownership of this object - it just keeps a pointer to it, so you must manage its lifetime. Note that this only replaces the filter, it doesn't refresh the list - you'll probably want to call refresh() after calling this.

◆ setIgnoresHiddenFiles()

void DirectoryContentsList::setIgnoresHiddenFiles ( bool  shouldIgnoreHiddenFiles)

Tells the list whether or not to ignore hidden files. By default these are ignored.


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