Public Types | Public Member Functions | List of all members
ihotf::IDirectoryMonitorParams Class Referenceabstract

Interface for a folder monitor parameters. More...

#include <IDirectoryMonitorParams.h>

Inheritance diagram for ihotf::IDirectoryMonitorParams:
iser::ISerializable istd::IChangeable istd::IPolymorphic ihotf::CDirectoryMonitorParams ihotf::CDirectoryMonitorParamsComp

Public Types

enum  ObserveItems { OI_DIR = 0x1, OI_FILES = 0x2, OI_DRIVES = 0x4, OI_ALL = OI_DIR | OI_FILES | OI_DRIVES }
 
enum  ObserveChanges {
  OC_ADD = 0x1, OC_REMOVE = 0x2, OC_MODIFIED = 0x4, OC_ATTR_CHANGED = 0x8,
  OC_ALL = OC_ADD | OC_REMOVE | OC_MODIFIED | OC_ATTR_CHANGED
}
 
enum  FileTimeStampMode { FTM_MODIFIED = 0x1, FTM_CREATED = 0x2 }
 

Public Member Functions

 I_DECLARE_FLAGS (FileTimeStampMode, FTM_MODIFIED, FTM_CREATED)
 
virtual double GetPoolingIntervall () const =0
 Get pooling intervall for directory changes in seconds. More...
 
virtual void SetPoolingIntervall (double poolingIntervall)=0
 Set pooling intervall for directory changes in seconds. More...
 
virtual int GetMinLastModificationTimeDifference () const =0
 Get the minimal time to wait since last modification of the file before operating with this (e.g. More...
 
virtual void SetMinLastModificationTimeDifference (int minLastModificationTimeDifference)=0
 Set the minimal time to wait since last modification of the file before operating with this. More...
 
virtual int GetObservedItemTypes () const =0
 Get the group of items to be observed. More...
 
virtual void SetObservedItemTypes (int observedItemTypes)=0
 Set the group of items to be observed. More...
 
virtual int GetObservedChanges () const =0
 Get the group of changes to be observed. More...
 
virtual void SetObservedChanges (int observedChanges)=0
 Set the changes to be observed. More...
 
virtual QStringList GetAcceptPatterns () const =0
 Get accept file filters, given as the list of regular expressions. More...
 
virtual void SetAcceptPatterns (const QStringList &acceptPatterns)=0
 Set the accept file filters. More...
 
virtual QStringList GetIgnorePatterns () const =0
 Get ignore file filters, given as the list of regular expressions. More...
 
virtual void SetIgnorePatterns (const QStringList &acceptPatterns)=0
 Set the ignore file filters. More...
 
virtual int GetFolderDepth () const =0
 Get depth of the folder monitoring. More...
 
virtual void SetFolderDepth (int folderDepth)=0
 Set depth of the folder monitoring. More...
 
virtual int GetFileTimeStampMode () const =0
 Get timestamp mode used for file detection and access check. More...
 
virtual void SetFileTimeStampMode (int fileTimeStampMode)=0
 Set timestamp mode used for file detection and access check. More...
 

Detailed Description

Interface for a folder monitor parameters.

Definition at line 17 of file IDirectoryMonitorParams.h.

Member Enumeration Documentation

Enumerator
FTM_MODIFIED 

File modification time will be get from 'Last Modified'-attribute.

FTM_CREATED 

File modification time will be get from 'Created'-attribute.

Definition at line 37 of file IDirectoryMonitorParams.h.

Enumerator
OC_ADD 
OC_REMOVE 
OC_MODIFIED 
OC_ATTR_CHANGED 
OC_ALL 

Definition at line 28 of file IDirectoryMonitorParams.h.

Enumerator
OI_DIR 
OI_FILES 
OI_DRIVES 
OI_ALL 

Definition at line 20 of file IDirectoryMonitorParams.h.

Member Function Documentation

virtual QStringList ihotf::IDirectoryMonitorParams::GetAcceptPatterns ( ) const
pure virtual

Get accept file filters, given as the list of regular expressions.

Implemented in ihotf::CDirectoryMonitorParams.

virtual int ihotf::IDirectoryMonitorParams::GetFileTimeStampMode ( ) const
pure virtual

Get timestamp mode used for file detection and access check.

See Also
FileTimestampMode

Implemented in ihotf::CDirectoryMonitorParams.

virtual int ihotf::IDirectoryMonitorParams::GetFolderDepth ( ) const
pure virtual

Get depth of the folder monitoring.

This value defines the depth of the folder tree to be monitored. A negative value means no limitation, 0 - defined root folder only and any other positive number - Number of sub-folders to be traversed.

Implemented in ihotf::CDirectoryMonitorParams.

virtual QStringList ihotf::IDirectoryMonitorParams::GetIgnorePatterns ( ) const
pure virtual

Get ignore file filters, given as the list of regular expressions.

Implemented in ihotf::CDirectoryMonitorParams.

virtual int ihotf::IDirectoryMonitorParams::GetMinLastModificationTimeDifference ( ) const
pure virtual

Get the minimal time to wait since last modification of the file before operating with this (e.g.

to add the file to the list of observed files).

Implemented in ihotf::CDirectoryMonitorParams.

virtual int ihotf::IDirectoryMonitorParams::GetObservedChanges ( ) const
pure virtual

Get the group of changes to be observed.

Implemented in ihotf::CDirectoryMonitorParams.

virtual int ihotf::IDirectoryMonitorParams::GetObservedItemTypes ( ) const
pure virtual

Get the group of items to be observed.

Implemented in ihotf::CDirectoryMonitorParams.

virtual double ihotf::IDirectoryMonitorParams::GetPoolingIntervall ( ) const
pure virtual

Get pooling intervall for directory changes in seconds.

Implemented in ihotf::CDirectoryMonitorParams.

ihotf::IDirectoryMonitorParams::I_DECLARE_FLAGS ( FileTimeStampMode  ,
FTM_MODIFIED  ,
FTM_CREATED   
)
virtual void ihotf::IDirectoryMonitorParams::SetAcceptPatterns ( const QStringList &  acceptPatterns)
pure virtual

Set the accept file filters.

Only file system items, that match the specified filters will be observed.

Implemented in ihotf::CDirectoryMonitorParams.

virtual void ihotf::IDirectoryMonitorParams::SetFileTimeStampMode ( int  fileTimeStampMode)
pure virtual

Set timestamp mode used for file detection and access check.

See Also
FileTimestampMode

Implemented in ihotf::CDirectoryMonitorParams.

virtual void ihotf::IDirectoryMonitorParams::SetFolderDepth ( int  folderDepth)
pure virtual

Set depth of the folder monitoring.

See Also
GetFolderDepth

Implemented in ihotf::CDirectoryMonitorParams.

virtual void ihotf::IDirectoryMonitorParams::SetIgnorePatterns ( const QStringList &  acceptPatterns)
pure virtual

Set the ignore file filters.

The file system items, that match the specified filters will be ignored.

Implemented in ihotf::CDirectoryMonitorParams.

virtual void ihotf::IDirectoryMonitorParams::SetMinLastModificationTimeDifference ( int  minLastModificationTimeDifference)
pure virtual

Set the minimal time to wait since last modification of the file before operating with this.

Implemented in ihotf::CDirectoryMonitorParams.

virtual void ihotf::IDirectoryMonitorParams::SetObservedChanges ( int  observedChanges)
pure virtual

Set the changes to be observed.

Implemented in ihotf::CDirectoryMonitorParams.

virtual void ihotf::IDirectoryMonitorParams::SetObservedItemTypes ( int  observedItemTypes)
pure virtual

Set the group of items to be observed.

Implemented in ihotf::CDirectoryMonitorParams.

virtual void ihotf::IDirectoryMonitorParams::SetPoolingIntervall ( double  poolingIntervall)
pure virtual

Set pooling intervall for directory changes in seconds.

Implemented in ihotf::CDirectoryMonitorParams.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy