PLCore::FileSearch Class Reference

Class for searching inside a directory. More...

#include <FileSearch.h>

List of all members.

Public Member Functions
PLCORE_API	FileSearch (const Directory &cDirectory, SearchFilter *pFilter=nullptr)
	Constructor.
PLCORE_API	FileSearch (const Directory &cDirectory, const String &sFilter)
	Constructor.
PLCORE_API	FileSearch (const FileSearch &cFileSearch)
	Copy constructor.
PLCORE_API	~FileSearch ()
	Destructor.
PLCORE_API FileSearch &	operator= (const FileSearch &cFileSearch)
	Copy operator.
bool	HasNextFile ()
	Returns whether the file searcher has a next file.
String	GetNextFile ()
	Returns the next filename.

---

Detailed Description

Class for searching inside a directory.

Note:

• Implementation of the bridge design pattern, this class is the abstraction

---

Constructor & Destructor Documentation

PLCORE_API PLCore::FileSearch::FileSearch	(	const Directory &	cDirectory,
		SearchFilter *	pFilter = nullptr
	)

Constructor.

Parameters:

[in]	cDirectory	Directory to search in
[in]	pFilter	Search filter to use (can be a null pointer)

PLCORE_API PLCore::FileSearch::FileSearch	(	const Directory &	cDirectory,
		const String &	sFilter
	)

Constructor.

Parameters:

[in]	cDirectory	Directory to search in
[in]	sFilter	Wildcard search filter (e.g. "*.txt")

PLCORE_API PLCore::FileSearch::FileSearch

(

const FileSearch &

cFileSearch

)

Copy constructor.

Parameters:

[in]

cFileSearch

'FileSearch' to be copied

PLCORE_API PLCore::FileSearch::~FileSearch

(

)

Destructor.

---

Member Function Documentation

PLCORE_API FileSearch& PLCore::FileSearch::operator=

(

const FileSearch &

cFileSearch

)

Copy operator.

Parameters:

[in]

cFileSearch

'FileSearch' to be copied

Returns:

Reference to this instance

bool PLCore::FileSearch::HasNextFile

(

)

[inline]

Returns whether the file searcher has a next file.

Returns:

'true' if the file searcher has a next file, else 'false'

String PLCore::FileSearch::GetNextFile

(

)

[inline]

Returns the next filename.

Returns:

The next filename, empty on error

---

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

• FileSearch.h
• FileSearch.inl