ZipArchiveLib::CGroupFileFilter Class Reference

#include <FileFilter.h>

Inheritance diagram for ZipArchiveLib::CGroupFileFilter:

Inheritance graph
[legend]

List of all members.

Public Types

enum  GroupType { And, Or }

Public Member Functions

void Add (CFileFilter *pFilter)
 CGroupFileFilter (GroupType groupType=CGroupFileFilter::And, bool bAutoDelete=true, bool bInverted=false)
void Clear ()
const CFileFilterGetAt (ZIP_ARRAY_SIZE_TYPE uIndex) const
CFileFilterGetAt (ZIP_ARRAY_SIZE_TYPE uIndex)
ZIP_ARRAY_SIZE_TYPE GetSize ()
GroupType GetType () const
bool HandlesFile (const CFileInfo &info)
bool IsAutoDelete () const
CFileFilteroperator[] (ZIP_ARRAY_SIZE_TYPE uIndex)
const CFileFilteroperator[] (ZIP_ARRAY_SIZE_TYPE uIndex) const
void RemoveAt (ZIP_ARRAY_SIZE_TYPE uIndex)
void SetAutoDelete (bool bAutoDelete)
void SetType (GroupType iType)

Protected Member Functions

virtual bool Accept (LPCTSTR lpszParentDir, LPCTSTR lpszName, const CFileInfo &info)
bool HandlesInversion () const

Protected Attributes

bool m_bAutoDelete
 Set with the SetAutoDelete or in constructor.
GroupType m_iType
 Set with the SetType method or in constructor.


Detailed Description

A filter that allows grouping of other filters.

See also:
Compressing Data

CDirEnumerator::Start

Definition at line 389 of file FileFilter.h.


Member Enumeration Documentation

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 397 of file FileFilter.h.


Constructor & Destructor Documentation

ZipArchiveLib::CGroupFileFilter::CGroupFileFilter ( GroupType  groupType = CGroupFileFilter::And,
bool  bAutoDelete = true,
bool  bInverted = false 
) [inline]

Initializes a new instance of the CGroupFileFilter class.

Parameters:
groupType The grouping type. Should be one of the GroupType values.
bAutoDelete true, if the grouped filters should be automatically destroyed by this filter; false otherwise.
bInverted Set to true to invert the behavior of the filter or to false for the normal behavior. This filter handles the inversion mode internally.
See also:
Compressing Data

SetType

SetAutoDelete

SetInverted

HandlesInversion

Definition at line 427 of file FileFilter.h.


Member Function Documentation

virtual bool ZipArchiveLib::CGroupFileFilter::Accept ( LPCTSTR  lpszParentDir,
LPCTSTR  lpszName,
const CFileInfo info 
) [protected, virtual]

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 438 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 518 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 460 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 449 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 540 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 565 of file FileFilter.h.

bool ZipArchiveLib::CGroupFileFilter::HandlesFile ( const CFileInfo info  )  [inline, virtual]

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 603 of file FileFilter.h.

bool ZipArchiveLib::CGroupFileFilter::HandlesInversion (  )  const [inline, protected, virtual]

This filter handles the inversion mode internally.

Returns:
This method returns true for this class.
See also:
CFileFilter::HandlesInversion

Reimplemented from ZipArchiveLib::CFileFilter.

Definition at line 630 of file FileFilter.h.

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 590 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 482 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 471 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 498 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 579 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 554 of file FileFilter.h.


Member Data Documentation

Set with the SetAutoDelete or in constructor.

Definition at line 635 of file FileFilter.h.

Set with the SetType method or in constructor.

Definition at line 634 of file FileFilter.h.


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

The ZipArchive Library Copyright © 2000 - 2009 Artpol Software - Tadeusz Dracz. Generated at Fri Apr 24 16:46:41 2009.