#include <FileFilter.h>

Inheritance diagram for ZipArchiveLib::CGroupFileFilter:

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 ()
CFileFilter *	GetAt (ZIP_ARRAY_SIZE_TYPE uIndex)
const CFileFilter *	GetAt (ZIP_ARRAY_SIZE_TYPE uIndex) const
ZIP_ARRAY_SIZE_TYPE	GetSize ()
GroupType	GetType () const
bool	HandlesFile (const CFileInfo &info)
bool	IsAutoDelete () const
CFileFilter *	operator[] (ZIP_ARRAY_SIZE_TYPE uIndex)
const CFileFilter *	operator[] (ZIP_ARRAY_SIZE_TYPE uIndex) const
void	RemoveAt (ZIP_ARRAY_SIZE_TYPE uIndex)
void	SetAutoDelete (bool bAutoDelete)
void	SetType (GroupType iType)
Public Member Functions inherited from ZipArchiveLib::CFileFilter
	CFileFilter (bool bInverted=false)
bool	Evaluate (LPCTSTR lpszParentDir, LPCTSTR lpszName, const CFileInfo &info)
bool	IsInverted () const
void	SetInverted (bool bInverted=true)

Protected Member Functions
virtual bool	Accept (LPCTSTR lpszParentDir, LPCTSTR lpszName, const CFileInfo &info)
bool	HandlesInversion () const
Protected Member Functions inherited from ZipArchiveLib::CFileFilter
virtual bool	Accept (LPCTSTR ZIP_UNUSED lpszParentDir, LPCTSTR ZIP_UNUSED lpszName, const CFileInfo &ZIP_UNUSED info)

Protected Attributes
bool	m_bAutoDelete
	Set with the SetAutoDelete or in constructor.
GroupType	m_iType
	Set with the SetType method or in constructor.
Protected Attributes inherited from ZipArchiveLib::CFileFilter
bool	m_bInverted

Detailed Description

A filter that allows grouping of other filters.

See also: Compressing Data; CDirEnumerator::Start

Member Enumeration Documentation

◆ GroupType

enum ZipArchiveLib::CGroupFileFilter::GroupType

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.

Constructor & Destructor Documentation

◆ CGroupFileFilter()

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

Member Function Documentation

◆ Accept()

virtual bool ZipArchiveLib::CGroupFileFilter::Accept	(	LPCTSTR	lpszParentDir,
		LPCTSTR	lpszName,
		const CFileInfo &	info )

protectedvirtual

Accepts a file based on the grouped filters.

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 by the grouped filters; false otherwise.

◆ Add()

void ZipArchiveLib::CGroupFileFilter::Add ( CFileFilter * pFilter )

inline

Adds pFilter to the filter's group.

Parameters

pFilter The filter to add.

◆ Clear()

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

◆ GetAt() [1/2]

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.

◆ GetAt() [2/2]

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.

◆ GetSize()

ZIP_ARRAY_SIZE_TYPE ZipArchiveLib::CGroupFileFilter::GetSize ( )

inline

Returns the number of grouped filters.

Returns: The number of grouped filters.

◆ GetType()

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

◆ HandlesFile()

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.

◆ HandlesInversion()

bool ZipArchiveLib::CGroupFileFilter::HandlesInversion ( ) const

inlineprotectedvirtual

This filter handles the inversion mode internally.

Returns: This method returns true for this class.

See also: CFileFilter::HandlesInversion

Reimplemented from ZipArchiveLib::CFileFilter.

◆ IsAutoDelete()

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

◆ operator[]() [1/2]

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.

◆ operator[]() [2/2]

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.

◆ RemoveAt()

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

◆ SetAutoDelete()

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

◆ SetType()

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

Member Data Documentation

◆ m_bAutoDelete

bool ZipArchiveLib::CGroupFileFilter::m_bAutoDelete

protected

Set with the SetAutoDelete or in constructor.

◆ m_iType

GroupType ZipArchiveLib::CGroupFileFilter::m_iType

protected

Set with the SetType method or in constructor.

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

FileFilter.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ GroupType

Constructor & Destructor Documentation

◆ CGroupFileFilter()

Member Function Documentation

◆ Accept()

◆ Add()

◆ Clear()

◆ GetAt() [1/2]

◆ GetAt() [2/2]

◆ GetSize()

◆ GetType()

◆ HandlesFile()

◆ HandlesInversion()

◆ IsAutoDelete()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ RemoveAt()

◆ SetAutoDelete()

◆ SetType()

Member Data Documentation

◆ m_bAutoDelete

◆ m_iType