JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | List of all members
WildcardFileFilter Class Reference

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

Inherits FileFilter.

Public Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from FileFilter
String description
 

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

Constructor & Destructor Documentation

WildcardFileFilter::WildcardFileFilter ( const String fileWildcardPatterns,
const String directoryWildcardPatterns,
const String description 
)

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::~WildcardFileFilter ( )

Destructor.

Member Function Documentation

bool WildcardFileFilter::isFileSuitable ( const File file) const
virtual

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

Implements FileFilter.

bool WildcardFileFilter::isDirectorySuitable ( const File file) const
virtual

This always returns true.

Implements FileFilter.


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