Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   
VCF::FileSearchFilterStandard

VCF::FileSearchFilterStandard Class Reference

FileSearchFilterStandard is the predefined Filter object used for simple searches. More...

#include <vcf/FoundationKit/Directory.h>

Inheritance diagram for VCF::FileSearchFilterStandard:

VCF::FileSearchFilter List of all members.

Public Member Functions

 FileSearchFilterStandard (const String &basenameFilterList, const String &pathnameFilterList=L"", const String &separator=L";")
 the constructor
virtual ~FileSearchFilterStandard ()
virtual File * passSearchFilter (const File *file, const Directory *subdir, const Directory::Finder *finder)
 the filtering function of the object, called by the Directory::Finder during the search
void buildSearchFilters (const String &basenameFilterList, const String &pathnameFilterList=L"", const String &separator=L";")
 build the filter starting from the filter string
virtual String toString () const

Public Attributes

String basenameFilterList_
String pathnameFilterList_
std::vector< String > searchFiltersBasename_
std::vector< String > searchFiltersPathname_
std::vector< String >::iterator searchFilterIterator_
String separator_

Detailed Description

FileSearchFilterStandard is the predefined Filter object used for simple searches.

Constructor & Destructor Documentation

VCF::FileSearchFilterStandard::FileSearchFilterStandard (  const String &  basenameFilterList,
const String &  pathnameFilterList = L"",
const String &  separator = L";"
) 
 

the constructor

Parameters:
String the filter list for files.
String the filter list for subdirectories. The items in these list are separated by separator, which is the ';' character by default. The wildcard character '*' is accepted, as in the implementation of FilePath::wildCharsMatchName() A specification like "*.vpl" does not implies that we are excluding directories from the search. Please use setDisplayMode( Directory::Finder::dmFiles ) for this.
String the separator between items in filterFileList and filterDirList.
fileAttributes the file attributes of the files we want to retrieve.

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

Member Function Documentation

void VCF::FileSearchFilterStandard::buildSearchFilters (  const String &  basenameFilterList,
const String &  pathnameFilterList = L"",
const String &  separator = L";"
) 
 

build the filter starting from the filter string

Parameters:
String the filter string for files.
String the filter string for subdirectories.

virtual File* VCF::FileSearchFilterStandard::passSearchFilter (  const File *  file,
const Directory *  subdir,
const Directory::Finder *  finder
)  [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

Implements VCF::FileSearchFilter.

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

Reimplemented from VCF::FileSearchFilter.

Member Data Documentation

String VCF::FileSearchFilterStandard::basenameFilterList_
 

String VCF::FileSearchFilterStandard::pathnameFilterList_
 

std::vector<String>::iterator VCF::FileSearchFilterStandard::searchFilterIterator_
 

std::vector<String> VCF::FileSearchFilterStandard::searchFiltersBasename_
 

std::vector<String> VCF::FileSearchFilterStandard::searchFiltersPathname_
 

String VCF::FileSearchFilterStandard::separator_
 

The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information