FileFilter Class Reference

Interface for deciding which files are suitable for something. More...

Inherited by FileBrowserComponent [private], and WildcardFileFilter.

List of all members.

Public Member Functions

 FileFilter (const String &filterDescription)
 Creates a filter with the given description.
virtual ~FileFilter ()
 Destructor.
const StringgetDescription () const throw ()
 Returns the description that the filter was created with.
virtual bool isFileSuitable (const File &file) const =0
 Should return true if this file is suitable for inclusion in whatever context the object is being used.
virtual bool isDirectorySuitable (const File &file) const =0
 Should return true if this directory is suitable for inclusion in whatever context the object is being used.

Protected Attributes

String description

Detailed Description

Interface for deciding which files are suitable for something.

For example, this is used by DirectoryContentsList to select which files go into the list.

See also:
WildcardFileFilter, DirectoryContentsList, FileListComponent, FileBrowserComponent

Constructor & Destructor Documentation

FileFilter::FileFilter ( const String filterDescription  ) 

Creates a filter with the given description.

The description can be returned later with the getDescription() method.

virtual FileFilter::~FileFilter (  )  [virtual]

Destructor.


Member Function Documentation

const String& FileFilter::getDescription (  )  const throw ()

Returns the description that the filter was created with.

virtual bool FileFilter::isFileSuitable ( const File file  )  const [pure virtual]

Should return true if this file is suitable for inclusion in whatever context the object is being used.

Implemented in FileBrowserComponent, and WildcardFileFilter.

virtual bool FileFilter::isDirectorySuitable ( const File file  )  const [pure virtual]

Should return true if this directory is suitable for inclusion in whatever context the object is being used.

Implemented in FileBrowserComponent, and WildcardFileFilter.


Member Data Documentation


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Mon Apr 26 11:42:12 2010 for JUCE by  doxygen 1.6.3