#include <juce_DirectoryContentsList.h>
Classes | |
| struct | FileInfo |
Private Member Functions | |
| int | useTimeSlice () override |
| void | stopSearching () |
| void | changed () |
| bool | checkNextFile (bool &hasChanged) |
| bool | addFile (const File &, bool isDir, int64 fileSize, Time modTime, Time creationTime, bool isReadOnly) |
| void | setTypeFlags (int) |
| Private Member Functions inherited from juce::TimeSliceClient | |
| virtual | ~TimeSliceClient ()=default |
Private Attributes | |
| File | root |
| const FileFilter * | fileFilter = nullptr |
| TimeSliceThread & | thread |
| int | fileTypeFlags = File::ignoreHiddenFiles | File::findFiles |
| CriticalSection | fileListLock |
| OwnedArray< FileInfo > | files |
| std::unique_ptr< RangedDirectoryIterator > | fileFindHandle |
| std::atomic< bool > | shouldStop { true } |
| std::atomic< bool > | isSearching { false } |
| bool | wasEmpty = true |
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
@tags{GUI}
Constructor & Destructor Documentation
◆ DirectoryContentsList()
| juce::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
-
fileFilter an 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 threadToUse a 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()
|
override |
Destructor.
Member Function Documentation
◆ addFile()
|
private |
◆ changed()
|
private |
◆ checkNextFile()
|
private |
◆ clear()
| void juce::DirectoryContentsList::clear | ( | ) |
Clears the list, and stops the thread scanning for files.
◆ contains()
Returns true if the list contains the specified file.
◆ getDirectory()
Returns the directory that's currently being used.
◆ getFile()
Returns one of the files in the list.
- Parameters
-
index should be less than getNumFiles(). If this is out-of-range, the return value will be a default File() object
- See also
- getNumFiles, getFileInfo
◆ getFileInfo()
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()
|
inlinenoexcept |
Returns the file filter being used. The filter is specified in the constructor.
◆ getNumFiles()
|
noexcept |
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()
|
inlinenoexcept |
◆ ignoresHiddenFiles()
| bool juce::DirectoryContentsList::ignoresHiddenFiles | ( | ) | const |
Returns true if hidden files are ignored.
- See also
- setIgnoresHiddenFiles
◆ isFindingDirectories()
|
inlinenoexcept |
Returns true if this list contains directories.
- See also
- setDirectory
◆ isFindingFiles()
|
inlinenoexcept |
Returns true if this list contains files.
- See also
- setDirectory
◆ isStillLoading()
| bool juce::DirectoryContentsList::isStillLoading | ( | ) | const |
True if the background thread hasn't yet finished scanning for files.
◆ refresh()
| void juce::DirectoryContentsList::refresh | ( | ) |
Clears the list and restarts scanning the directory for files.
◆ setDirectory()
| void juce::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 juce::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 juce::DirectoryContentsList::setIgnoresHiddenFiles | ( | bool | shouldIgnoreHiddenFiles | ) |
Tells the list whether or not to ignore hidden files. By default these are ignored.
◆ setTypeFlags()
◆ stopSearching()
|
private |
◆ useTimeSlice()
|
overrideprivatevirtual |
Called back by a TimeSliceThread.
When you register this class with it, a TimeSliceThread will repeatedly call this method.
The implementation of this method should use its time-slice to do something that's quick - never block for longer than absolutely necessary.
- Returns
- Your method should return the number of milliseconds which it would like to wait before being called again. Returning 0 will make the thread call again as soon as possible (after possibly servicing other busy clients). If you return a value below zero, your client will be removed from the list of clients, and won't be called again. The value you specify isn't a guarantee, and is only used as a hint by the thread - the actual time before the next callback may be more or less than specified. You can force the TimeSliceThread to wake up and poll again immediately by calling its notify() method.
Implements juce::TimeSliceClient.
Member Data Documentation
◆ fileFilter
|
private |
◆ fileFindHandle
|
private |
◆ fileListLock
|
private |
◆ files
|
private |
◆ fileTypeFlags
|
private |
◆ isSearching
|
private |
◆ root
|
private |
◆ shouldStop
|
private |
◆ thread
|
private |
◆ wasEmpty
|
private |
The documentation for this class was generated from the following files:
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/filebrowser/juce_DirectoryContentsList.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/filebrowser/juce_DirectoryContentsList.cpp
Generated on for LMMS by
1.16.1