OpenShot Library | OpenShotAudio  0.2.2
juce::WildcardFileFilter Class Reference

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

#include <juce_WildcardFileFilter.h>

+ Inheritance 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...
 
bool isFileSuitable (const File &file) const override
 Returns true if the filename matches one of the patterns specified. More...
 
bool isDirectorySuitable (const File &file) const override
 This always returns true. More...
 
- Public Member Functions inherited from juce::FileFilter
 FileFilter (const String &filterDescription)
 Creates a filter with the given description. More...
 
virtual ~FileFilter ()
 Destructor. More...
 
const StringgetDescription () const noexcept
 Returns the description that the filter was created with. More...
 

Additional Inherited Members

- Protected Attributes inherited from juce::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

Definition at line 41 of file juce_WildcardFileFilter.h.

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".

Definition at line 50 of file juce_WildcardFileFilter.cpp.

◆ ~WildcardFileFilter()

juce::WildcardFileFilter::~WildcardFileFilter ( )
override

Destructor.

Definition at line 60 of file juce_WildcardFileFilter.cpp.

Member Function Documentation

◆ isFileSuitable()

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

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

Implements juce::FileFilter.

Definition at line 64 of file juce_WildcardFileFilter.cpp.

◆ isDirectorySuitable()

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

This always returns true.

Implements juce::FileFilter.

Definition at line 69 of file juce_WildcardFileFilter.cpp.


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