VCF::FileSearchFilter Class Reference

FileSearchFilter is an abstract class for any user defined Filter object working with the Directory::Finder. More...

#include <vcf/FoundationKit/Directory.h>

Inheritance diagram for VCF::FileSearchFilter:


Public Member Functions
virtual	~FileSearchFilter ()
virtual File *	passSearchFilter (const File file, const Directory subdir, const Directory::Finder *finder)=0
	the filtering function of the object, called by the Directory::Finder during the search
virtual String	toString () const

Detailed Description

FileSearchFilter is an abstract class for any user defined Filter object working with the Directory::Finder.

Constructor & Destructor Documentation

virtual VCF::FileSearchFilter::~FileSearchFilter ( ) [inline, virtual]

Member Function Documentation

virtual File* VCF::FileSearchFilter::passSearchFilter ( const File * file,

const Directory * subdir,

const Directory::Finder * finder

) [pure virtual]

the filtering function of the object, called by the Directory::Finder during the search

Parameters:

File* the pointer to the File object and its informations retrieved by the Finder, file can also represent a directory on the file system.

Directory* the pointer to the object representing the subdirectory containing file.

Finder* the pointer to the active Directory::Finder* object performing the search when the call to this function is made. The user is allowed to assume that all these arguments are never NULL.

Returns:
File* the passed argument File* itself if filter is passed, but it must return NULL if File dind't pass the filter

Implemented in VCF::FileSearchFilterStandard.

virtual String VCF::FileSearchFilter::toString ( ) const [inline, virtual]

Reimplemented in VCF::FileSearchFilterStandard.

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

vcf/FoundationKit/Directory.h

VCF::FileSearchFilter Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation