JUCE  v6.1.6 (6.0.8-1114)
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::WildcardFileFilter Class Reference

A type of FileFilter that works by wildcard pattern matching. More...

#include <juce_WildcardFileFilter.h>

Inheritance diagram for juce::WildcardFileFilter:
Collaboration diagram for juce::WildcardFileFilter:

Public Member Functions

 WildcardFileFilter (const String &fileWildcardPatterns, const String &directoryWildcardPatterns, const String &filterDescription)
 Creates a wildcard filter for one or more patterns. More...
 
 ~WildcardFileFilter () override
 Destructor. More...
 
const StringgetDescription () const noexcept
 Returns the description that the filter was created with. More...
 
bool isDirectorySuitable (const File &file) const override
 This always returns true. More...
 
bool isFileSuitable (const File &file) const override
 Returns true if the filename matches one of the patterns specified. More...
 

Protected Attributes

String description
 

Private Attributes

StringArray directoryWildcards
 
StringArray fileWildcards
 

Detailed Description

A type of FileFilter that works by wildcard pattern matching.

This filter only allows files that match one of the specified patterns, but allows all directories through.

See also
FileFilter, DirectoryContentsList, FileListComponent, FileBrowserComponent

@tags{Core}

Constructor & Destructor Documentation

◆ WildcardFileFilter()

juce::WildcardFileFilter::WildcardFileFilter ( const String fileWildcardPatterns,
const String directoryWildcardPatterns,
const String filterDescription 
)

Creates a wildcard filter for one or more patterns.

The wildcardPatterns parameter is a comma or semicolon-delimited set of patterns, e.g. "*.wav;*.aiff" would look for files ending in either .wav or .aiff.

Passing an empty string as a pattern will fail to match anything, so by leaving either the file or directory pattern parameter empty means you can control whether files or directories are found.

The description is a name to show the user in a list of possible patterns, so for the wav/aiff example, your description might be "audio files".

◆ ~WildcardFileFilter()

juce::WildcardFileFilter::~WildcardFileFilter ( )
override

Destructor.

Member Function Documentation

◆ getDescription()

const String& juce::FileFilter::getDescription ( ) const
noexceptinherited

Returns the description that the filter was created with.

◆ isDirectorySuitable()

bool juce::WildcardFileFilter::isDirectorySuitable ( const File file) const
overridevirtual

This always returns true.

Implements juce::FileFilter.

◆ isFileSuitable()

bool juce::WildcardFileFilter::isFileSuitable ( const File file) const
overridevirtual

Returns true if the filename matches one of the patterns specified.

Implements juce::FileFilter.

Member Data Documentation

◆ description

String juce::FileFilter::description
protectedinherited

◆ directoryWildcards

StringArray juce::WildcardFileFilter::directoryWildcards
private

◆ fileWildcards

StringArray juce::WildcardFileFilter::fileWildcards
private

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