CeresEngine::FileVisitor Class Reference

The file file visitor interface. More...

#include <CeresEngine/Foundation/IO/FileHandle.hpp>

Inheritance diagram for CeresEngine::FileVisitor:

Public Member Functions
	FileVisitor ()
virtual	~FileVisitor ()

Protected Member Functions
virtual bool	onFileEntry (const FileHandle &handle)
	Called for each file entry visited (files and directories).
virtual void	onFile (const FileHandle &handle)
	Called for on each file visited.
virtual bool	onDirectory (const FileHandle &handle)
	Called for each visited directory.

Friends
class	FileHandle

Detailed Description

The file file visitor interface.

Constructor & Destructor Documentation

FileVisitor()

CeresEngine::FileVisitor::FileVisitor

(

)

~FileVisitor()

virtual CeresEngine::FileVisitor::~FileVisitor ( )

virtual

Member Function Documentation

onDirectory()

virtual bool CeresEngine::FileVisitor::onDirectory ( const FileHandle &  handle )

protectedvirtual

Called for each visited directory.

Parameters

handle

A handle to the visited directory.

Returns

true if the subdirectory should be traversed, else false.

Reimplemented in CeresEngine::FunctionalFileVisitor.

onFile()

virtual void CeresEngine::FileVisitor::onFile ( const FileHandle &  handle )

protectedvirtual

Called for on each file visited.

Parameters

handle

A Handle to visited file.

Reimplemented in CeresEngine::FunctionalFileVisitor.

onFileEntry()

virtual bool CeresEngine::FileVisitor::onFileEntry ( const FileHandle &  handle )

protectedvirtual

Called for each file entry visited (files and directories).

Note

The default implementation checks if the file handle points to a file or a directory and calls onFile() or onDirectory() respectively.

Parameters

handle

A handle to the visited file or directory.

Returns

true if the subdirectory should be traversed, else false.

Reimplemented in CeresEngine::FunctionalFileVisitor.

Friends And Related Symbol Documentation

FileHandle

friend class FileHandle

friend

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Foundation/IO/FileHandle.hpp