CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::FileEventHandler Class Reference

A handler that is informed about file system events. More...

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

Inheritance diagram for CeresEngine::FileEventHandler:
CeresEngine::FunctionalFileEventHandler

Public Member Functions

 FileEventHandler ()=default
 
virtual ~FileEventHandler ()=default
 

Protected Member Functions

virtual void onFileEvent (const FileHandle &handle, FileEvent event)
 
virtual void onFileCreated (const FileHandle &handle)
 Called when a file or directory has been created.
 
virtual void onFileRemoved (const FileHandle &handle)
 Called when a file or directory has been removed.
 
virtual void onFileModified (const FileHandle &handle)
 Called when a file or directory has been modified.
 
virtual void onFileAttributesChanged (const FileHandle &handle)
 Called when file attributes have been modified.
 

Friends

class FileWatcher
 

Detailed Description

A handler that is informed about file system events.

Note
Use FileWatcher to register file event handlers.

Constructor & Destructor Documentation

◆ FileEventHandler()

CeresEngine::FileEventHandler::FileEventHandler ( )
default

◆ ~FileEventHandler()

virtual CeresEngine::FileEventHandler::~FileEventHandler ( )
virtualdefault

Member Function Documentation

◆ onFileAttributesChanged()

virtual void CeresEngine::FileEventHandler::onFileAttributesChanged ( const FileHandle handle)
protectedvirtual

Called when file attributes have been modified.

Parameters
handleThe file handle that received the event.

◆ onFileCreated()

virtual void CeresEngine::FileEventHandler::onFileCreated ( const FileHandle handle)
protectedvirtual

Called when a file or directory has been created.

Parameters
handleThe file handle that received the event.

◆ onFileEvent()

virtual void CeresEngine::FileEventHandler::onFileEvent ( const FileHandle handle,
FileEvent  event 
)
protectedvirtual

◆ onFileModified()

virtual void CeresEngine::FileEventHandler::onFileModified ( const FileHandle handle)
protectedvirtual

Called when a file or directory has been modified.

Parameters
handleThe file handle that received the event.

◆ onFileRemoved()

virtual void CeresEngine::FileEventHandler::onFileRemoved ( const FileHandle handle)
protectedvirtual

Called when a file or directory has been removed.

Parameters
handleThe file handle that received the event.

Friends And Related Symbol Documentation

◆ FileWatcher


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