#include <FileFilter.h>
A filter that allows grouping of other filters.
- See Also
- Compressing Data
-
CDirEnumerator::Start
Definition at line 393 of file FileFilter.h.
The grouping type.
- Enumerator:
And |
Logical AND. All the grouped filters must accept a file for the file to be processed.
|
Or |
Logical OR. At least one of the grouped filters must accept a file for the file to be processed.
|
Definition at line 401 of file FileFilter.h.
virtual bool ZipArchiveLib::CGroupFileFilter::Accept |
( |
LPCTSTR |
lpszParentDir, |
|
|
LPCTSTR |
lpszName, |
|
|
const CFileInfo & |
info |
|
) |
| |
|
protectedvirtual |
This method is directly called by the Evaluate method during an enumeration process.
If this method returns true
, the file will later be processed by the CDirEnumerator::Process method. If this method returns false
for a directory, the directory is not enumerated at all.
The meaning of the return value can be reversed by the SetInverted method. If this filter handles the inversion internally, the return value from this method is not reversed by the Evaluate method.
- Parameters
-
lpszParentDir | The parent directory containing the file to accept. |
lpszName | The name of the file to accept (without a path). |
info | The structure containing the information about the current file. |
- Returns
true
, if the file is accepted; false
otherwise.
- See Also
- Evaluate
-
HandlesInversion
-
CDirEnumerator::Start
-
CDirEnumerator::Process
Reimplemented from ZipArchiveLib::CFileFilter.
void ZipArchiveLib::CGroupFileFilter::Add |
( |
CFileFilter * |
pFilter | ) |
|
|
inline |
Adds pFilter to the filter's group.
- Parameters
-
pFilter | The filter to add. |
Definition at line 442 of file FileFilter.h.
void ZipArchiveLib::CGroupFileFilter::Clear |
( |
| ) |
|
|
inline |
Removes all contained filters from the collection.
The removed filters are deleted from memory, if the CGroupFileFilter object is in the auto-delete mode.
- See Also
- SetAutoDelete
Definition at line 522 of file FileFilter.h.
CFileFilter* ZipArchiveLib::CGroupFileFilter::GetAt |
( |
ZIP_ARRAY_SIZE_TYPE |
uIndex | ) |
|
|
inline |
Returns the filter at the given position.
- Parameters
-
uIndex | The index of the filter to return. |
Definition at line 453 of file FileFilter.h.
const CFileFilter* ZipArchiveLib::CGroupFileFilter::GetAt |
( |
ZIP_ARRAY_SIZE_TYPE |
uIndex | ) |
const |
|
inline |
Returns the filter at the given position.
- Parameters
-
uIndex | The index of the filter to return. |
Definition at line 464 of file FileFilter.h.
ZIP_ARRAY_SIZE_TYPE ZipArchiveLib::CGroupFileFilter::GetSize |
( |
| ) |
|
|
inline |
Returns the number of grouped filters.
- Returns
- The number of grouped filters.
Definition at line 544 of file FileFilter.h.
GroupType ZipArchiveLib::CGroupFileFilter::GetType |
( |
| ) |
const |
|
inline |
Returns the type of grouping.
- Returns
- The type of grouping. It can be one of the GroupType values.
- See Also
- SetType
Definition at line 569 of file FileFilter.h.
bool ZipArchiveLib::CGroupFileFilter::HandlesFile |
( |
const CFileInfo & |
info | ) |
|
|
inlinevirtual |
Returns the value indicating whether the filter can decide about processing of the info file. The CGroupFileFilter returns the value depending on the value returned by the grouped filters.
- Parameters
-
info | The structure containing the information about the file. |
- Returns
true
, if any of the grouped filters accepts info; false
otherwise.
Reimplemented from ZipArchiveLib::CFileFilter.
Definition at line 607 of file FileFilter.h.
bool ZipArchiveLib::CGroupFileFilter::HandlesInversion |
( |
| ) |
const |
|
inlineprotectedvirtual |
bool ZipArchiveLib::CGroupFileFilter::IsAutoDelete |
( |
| ) |
const |
|
inline |
Returns the value indicating whether the auto-deletion is enabled.
- Returns
true
, if the auto-deletion is enabled; false
otherwise.
- See Also
- SetAutoDelete
Definition at line 594 of file FileFilter.h.
const CFileFilter* ZipArchiveLib::CGroupFileFilter::operator[] |
( |
ZIP_ARRAY_SIZE_TYPE |
uIndex | ) |
const |
|
inline |
Returns the filter at the given position.
- Parameters
-
uIndex | The index of the filter to return. |
Definition at line 475 of file FileFilter.h.
CFileFilter* ZipArchiveLib::CGroupFileFilter::operator[] |
( |
ZIP_ARRAY_SIZE_TYPE |
uIndex | ) |
|
|
inline |
Returns the filter at the given position.
- Parameters
-
uIndex | The index of the filter to return. |
Definition at line 486 of file FileFilter.h.
void ZipArchiveLib::CGroupFileFilter::RemoveAt |
( |
ZIP_ARRAY_SIZE_TYPE |
uIndex | ) |
|
|
inline |
Remove the filter at the given position. The removed filter is deleted from memory, if the CGroupFileFilter object is in the auto-delete mode.
- Parameters
-
uIndex | The index of the filter to remove. |
- See Also
- SetAutoDelete
Definition at line 502 of file FileFilter.h.
void ZipArchiveLib::CGroupFileFilter::SetAutoDelete |
( |
bool |
bAutoDelete | ) |
|
|
inline |
Enables or disables auto-deletion of grouped filters. If auto-deletion is enabled, the grouped filters are released from memory when they are removed from the group or when the CGroupFileFilter object is destroyed.
- Parameters
-
bAutoDelete | true , to enable auto-deletion; false to disable. |
- See Also
- IsAutoDelete
Definition at line 583 of file FileFilter.h.
void ZipArchiveLib::CGroupFileFilter::SetType |
( |
GroupType |
iType | ) |
|
|
inline |
Sets the type of grouping.
- Parameters
-
iType | The type of grouping. Should be one of the GroupType values. |
- See Also
- GetType
Definition at line 558 of file FileFilter.h.
bool ZipArchiveLib::CGroupFileFilter::m_bAutoDelete |
|
protected |
GroupType ZipArchiveLib::CGroupFileFilter::m_iType |
|
protected |
The documentation for this class was generated from the following file: