Provide list of file pathes using recursive search of some file directory. More...

#include <CFileListProviderComp.h>

Inheritance diagram for ifile::CFileListProviderComp:

Public Types
typedef ilog::CLoggerComponentBase	BaseClass

Public Types inherited from ilog::TLoggerCompWrap< Base >
typedef Base	BaseClass
	Base class typedef for component functionality.

typedef ilog::CLoggerBase	BaseClass2
	Base class typedef for logger functionality.

Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ACF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING , CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...

enum	SupportedOperations { SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 , SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 }
	Flags for supported operations. More...

enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap

Public Member Functions
virtual const QFileInfoList &	GetFileList () const override
	Get list of files.

Public Member Functions inherited from ilog::CLoggerBase
	CLoggerBase ()
	Default constructor.

virtual void	SetLogPtr (ilog::IMessageConsumer *logPtr) override
	Attach a message consumer for logging.

virtual ilog::IMessageConsumer *	GetLogPtr () const override
	Get the currently attached message consumer.

Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.

virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual istd::TUniqueInterfacePtr< istd::IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this object.

virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.

virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.

virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.

virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.

virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Static Public Member Functions
static bool	CreateFileList (const QDir &root, int minRecursionDepth, int maxRecursionDepth, const QStringList &nameFilters, QDir::SortFlags sortSpec, QFileInfoList &fileList, istd::ILogger *loggerPtr=NULL)
	Creates the list of files in a root directory `root`.

static bool	CreateDirectoryList (const QDir &root, int minRecursionDepth, int maxRecursionDepth, const QStringList &nameFilters, QDir::SortFlags sortSpec, QFileInfoList &directoryList, istd::ILogger *loggerPtr=NULL)
	Several filters can be applied to the QDir object before call of this function.

Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Protected Member Functions
virtual void	OnUpdate (const istd::IChangeable::ChangeSet &changeSet) override
	Called on update of observed model.

virtual void	OnComponentCreated () override
	Called when component is created.

virtual void	OnComponentDestroyed () override
	Called when component is destroyed.

Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
bool	IsVerboseEnabled (int tracingLevel=0) const
	Check if verbose messages are enabled for a given tracing level.

void	SendVerboseMessage (const QString &message, const QString &messageSource=QString(), int tracingLevel=0) const
	Send a verbose message if enabled.

virtual void	DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const override
	Decorate message before sending.

Protected Member Functions inherited from ilog::CLoggerBase
bool	SendInfoMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send info message to log.

bool	SendWarningMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send warning message to log.

bool	SendErrorMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send error message to log.

bool	SendCriticalMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send critical message to log.

bool	SendInfoMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once info message to log.

bool	SendWarningMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once warning message to log.

bool	SendErrorMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once error message to log.

bool	SendCriticalMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once critical message to log.

bool	SendUserMessage (const istd::IInformationProvider *messagePtr) const
	Send message with user object.

bool	AllowMessageOnceAgain (int id)
	Reset message lock.

virtual bool	IsLogConsumed (const istd::IInformationProvider::InformationCategory categoryPtr=NULL, const int flagsPtr=NULL) const override
	Check if any log message is consumed.

virtual bool	SendLogMessage (istd::IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const override
	Send any message to log.

Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.

virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Protected Member Functions inherited from imod::CSingleModelObserverBase
void	SetModelPtr (imod::IModel *modelPtr)
	Set internal model pointer to specified value.

	CSingleModelObserverBase ()

virtual	~CSingleModelObserverBase ()

imod::IModel *	GetObservedModel () const
	Get access to observed model.

imod::IModel *	GetModelPtr () const
	Get access to observed model.

void	EnsureModelDetached ()
	Make sure this observer is detached.

void	SetObservedIds (const istd::IChangeable::ChangeSet &changeMask)
	Set list of ID's beeing observed.

virtual bool	IsModelAttached (const imod::IModel *modelPtr=NULL) const override
	Checks if the specified model is currently attached to this observer.

virtual bool	OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
	Callback invoked when an observable model is about to be attached to this observer.

virtual bool	OnModelDetached (imod::IModel *modelPtr) override
	Callback invoked when an observable model is about to be detached from this observer.

virtual void	BeforeUpdate (imod::IModel *modelPtr) override
	Callback invoked before an update of the observer's content occurs.

virtual void	AfterUpdate (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
	Callback invoked after an update of the observer's content occurs.

Additional Inherited Members
Protected Types inherited from imod::CSingleModelObserverBase
typedef imod::IModel	ModelType

Protected Attributes inherited from ilog::CLoggerBase
QSet< int >	m_onceMessageIds

Static Protected Attributes inherited from imod::CSingleModelObserverBase
static const istd::IChangeable::ChangeSet	s_undoChanges

Detailed Description

Provide list of file pathes using recursive search of some file directory.

Definition at line 25 of file CFileListProviderComp.h.

Member Typedef Documentation

◆ BaseClass

typedef ilog::CLoggerComponentBase ifile::CFileListProviderComp::BaseClass

Definition at line 33 of file CFileListProviderComp.h.

Member Function Documentation

◆ CreateDirectoryList()

static bool ifile::CFileListProviderComp::CreateDirectoryList	(	const QDir &	root,
		int	minRecursionDepth,
		int	maxRecursionDepth,
		const QStringList &	nameFilters,
		QDir::SortFlags	sortSpec,
		QFileInfoList &	directoryList,
		istd::ILogger *	loggerPtr = `NULL`
	)

static

Several filters can be applied to the QDir object before call of this function.

Parameters

minRecursionDepth	minimal recursion depth. If it is 0, root will be included.
maxRecursionDepth	maximal recursion depth, if negative no depth is specified.

◆ CreateFileList()

static bool ifile::CFileListProviderComp::CreateFileList	(	const QDir &	root,
		int	minRecursionDepth,
		int	maxRecursionDepth,
		const QStringList &	nameFilters,
		QDir::SortFlags	sortSpec,
		QFileInfoList &	fileList,
		istd::ILogger *	loggerPtr = `NULL`
	)

static

Creates the list of files in a root directory root.

Several filters can be applied to the root before call of this function. So you can do a separate filtering of files and directories.

Parameters

minRecursionDepth	minimal recursion depth.
maxRecursionDepth	maximal recursion depth, if negative no depth is specified.

◆ GetFileList()

virtual const QFileInfoList & ifile::CFileListProviderComp::GetFileList ( ) const

overridevirtual

Get list of files.

Implements ifile::IFileListProvider.

◆ OnComponentCreated()

virtual void ifile::CFileListProviderComp::OnComponentCreated ( )

overrideprotectedvirtual

Called when component is created.

Automatically connects the log consumer from the "Log" reference.

Note: Override to add initialization, but always call base class:
virtual void OnComponentCreated() override {

// Custom initialization

BaseClass::OnComponentCreated();

}

ifile::CFileListProviderComp::OnComponentCreated
virtual void OnComponentCreated() override
Called when component is created.

ilog::TLoggerCompWrap::OnComponentCreated
virtual void OnComponentCreated() override
Called when component is created.
Definition TLoggerCompWrap.h:330

Reimplemented from ilog::TLoggerCompWrap< Base >.

◆ OnComponentDestroyed()

virtual void ifile::CFileListProviderComp::OnComponentDestroyed ( )

overrideprotectedvirtual

Called when component is destroyed.

Automatically disconnects the log consumer for cleanup.

Note: Override to add cleanup, but always call base class:
virtual void OnComponentDestroyed() override {

// Custom cleanup

BaseClass::OnComponentDestroyed();

}

ifile::CFileListProviderComp::OnComponentDestroyed
virtual void OnComponentDestroyed() override
Called when component is destroyed.

ilog::TLoggerCompWrap::OnComponentDestroyed
virtual void OnComponentDestroyed() override
Called when component is destroyed.
Definition TLoggerCompWrap.h:341

Reimplemented from ilog::TLoggerCompWrap< Base >.

◆ OnUpdate()

virtual void ifile::CFileListProviderComp::OnUpdate ( const istd::IChangeable::ChangeSet & changeSet )

overrideprotectedvirtual

Called on update of observed model.

This method is designed to be overload by derrived classes.

Reimplemented from imod::CSingleModelObserverBase.

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

Acf/Include/ifile/CFileListProviderComp.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ CreateDirectoryList()

◆ CreateFileList()

◆ GetFileList()

◆ OnComponentCreated()

◆ OnComponentDestroyed()

◆ OnUpdate()