Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QFileInfoGatherer Class Reference

#include <qfileinfogatherer_p.h>

+ Inheritance diagram for QFileInfoGatherer:
+ Collaboration diagram for QFileInfoGatherer:

Public Slots

void list (const QString &directoryPath)
 
void fetchExtendedInformation (const QString &path, const QStringList &files)
 Fetch extended information for all files in path.
 
void updateFile (const QString &path)
 Fetch extended information for all filePath.
 
void setResolveSymlinks (bool enable)
 
void setIconProvider (QAbstractFileIconProvider *provider)
 
- Public Slots inherited from QThread
void start (Priority=InheritPriority)
 
void terminate ()
 
void exit (int retcode=0)
 
void quit ()
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void updates (const QString &directory, const QList< std::pair< QString, QFileInfo > > &updates)
 
void newListOfFiles (const QString &directory, const QStringList &listOfFiles) const
 
void nameResolved (const QString &fileName, const QString &resolvedName) const
 
void directoryLoaded (const QString &path)
 
- Signals inherited from QThread
void started (QPrivateSignal)
 
void finished (QPrivateSignal)
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QFileInfoGatherer (QObject *parent=nullptr)
 Creates thread.
 
 ~QFileInfoGatherer ()
 Destroys thread.
 
QStringList watchedFiles () const
 
QStringList watchedDirectories () const
 
void watchPaths (const QStringList &paths)
 
void unwatchPaths (const QStringList &paths)
 
bool isWatching () const
 
void setWatching (bool v)
 
void clear ()
 
void removePath (const QString &path)
 
QExtendedInformation getInfo (const QFileInfo &info) const
 
QAbstractFileIconProvidericonProvider () const
 
bool resolveSymlinks () const
 
void requestAbort ()
 
- Public Member Functions inherited from QThread
 QThread (QObject *parent=nullptr)
 
 ~QThread ()
 
void setPriority (Priority priority)
 
Priority priority () const
 
bool isFinished () const
 
bool isRunning () const
 
void requestInterruption ()
 
bool isInterruptionRequested () const
 
void setStackSize (uint stackSize)
 
uint stackSize () const
 
QAbstractEventDispatchereventDispatcher () const
 
void setEventDispatcher (QAbstractEventDispatcher *eventDispatcher)
 
bool event (QEvent *event) override
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
int loopLevel () const
 
bool isCurrentThread () const
 
bool wait (QDeadlineTimer deadline=QDeadlineTimer(QDeadlineTimer::Forever))
 
bool wait (unsigned long time)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. time is the time to wait in milliseconds.
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Protected Member Functions

bool event (QEvent *event) override
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
- Protected Member Functions inherited from QThread
int exec ()
 
 QThread (QThreadPrivate &dd, QObject *parent=nullptr)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Private Member Functions

void run () override
 

Additional Inherited Members

- Public Types inherited from QThread
enum  Priority {
  IdlePriority , LowestPriority , LowPriority , NormalPriority ,
  HighPriority , HighestPriority , TimeCriticalPriority , InheritPriority
}
 
- Static Public Member Functions inherited from QThread
static Qt::HANDLE currentThreadId () noexcept Q_DECL_PURE_FUNCTION
 
static QThreadcurrentThread ()
 
static bool isMainThread ()
 
static int idealThreadCount () noexcept
 
static void yieldCurrentThread ()
 
template<typename Function , typename... Args>
static QThreadcreate (Function &&f, Args &&... args)
 
static void sleep (unsigned long)
 
static void msleep (unsigned long)
 
static void usleep (unsigned long)
 
static void sleep (std::chrono::nanoseconds nsec)
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Static Protected Member Functions inherited from QThread
static void setTerminationEnabled (bool enabled=true)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 123 of file qfileinfogatherer_p.h.

Constructor & Destructor Documentation

◆ QFileInfoGatherer()

QFileInfoGatherer::QFileInfoGatherer ( QObject * parent = nullptr)
explicit

Creates thread.

Definition at line 50 of file qfileinfogatherer.cpp.

References QThread::LowPriority.

◆ ~QFileInfoGatherer()

QFileInfoGatherer::~QFileInfoGatherer ( )

Destroys thread.

Definition at line 60 of file qfileinfogatherer.cpp.

References requestAbort(), and QThread::wait().

+ Here is the call graph for this function:

Member Function Documentation

◆ clear()

void QFileInfoGatherer::clear ( )

Definition at line 281 of file qfileinfogatherer.cpp.

References unwatchPaths(), watchedDirectories(), and watchedFiles().

+ Here is the call graph for this function:

◆ directoryLoaded

void QFileInfoGatherer::directoryLoaded ( const QString & path)
signal

Referenced by QFileSystemModelPrivate::init().

+ Here is the caller graph for this function:

◆ event()

bool QFileInfoGatherer::event ( QEvent * e)
overrideprotectedvirtual

This virtual function receives events to an object and should return true if the event e was recognized and processed.

The event() function can be reimplemented to customize the behavior of an object.

Make sure you call the parent event class implementation for all the events you did not handle.

Example:

class MyClass : public QWidget
{
public:
MyClass(QWidget *parent = nullptr);
bool event(QEvent* ev) override
{
if (ev->type() == QEvent::PolishRequest) {
// overwrite handling of PolishRequest if any
doThings();
return true;
} else if (ev->type() == QEvent::Show) {
// complement handling of Show if any
doThings2();
return true;
}
// Make sure the rest of events are handled
return QWidget::event(ev);
}
};
See also
installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), QCoreApplication::postEvent()

Reimplemented from QObject.

Definition at line 66 of file qfileinfogatherer.cpp.

References QCoreApplication::closingDown(), QObject::connect(), QEvent::DeferredDelete, QThread::event(), QThread::finished(), QThread::isRunning(), requestAbort(), QThread::terminate(), and QThread::wait().

+ Here is the call graph for this function:

◆ fetchExtendedInformation

void QFileInfoGatherer::fetchExtendedInformation ( const QString & path,
const QStringList & files )
slot

Fetch extended information for all files in path.

See also
updateFile(), update(), resolvedName()

Definition at line 144 of file qfileinfogatherer.cpp.

References contains(), files, QString::lastIndexOf(), watchedDirectories(), and watchPaths().

Referenced by list(), and updateFile().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getInfo()

◆ iconProvider()

QAbstractFileIconProvider * QFileInfoGatherer::iconProvider ( ) const

Definition at line 134 of file qfileinfogatherer.cpp.

◆ isWatching()

bool QFileInfoGatherer::isWatching ( ) const

Definition at line 243 of file qfileinfogatherer.cpp.

◆ list

void QFileInfoGatherer::list ( const QString & directoryPath)
slot

Definition at line 310 of file qfileinfogatherer.cpp.

References fetchExtendedInformation().

+ Here is the call graph for this function:

◆ nameResolved

void QFileInfoGatherer::nameResolved ( const QString & fileName,
const QString & resolvedName ) const
signal

Referenced by getInfo(), and QFileSystemModelPrivate::init().

+ Here is the caller graph for this function:

◆ newListOfFiles

void QFileInfoGatherer::newListOfFiles ( const QString & directory,
const QStringList & listOfFiles ) const
signal

Referenced by QFileSystemModelPrivate::init().

+ Here is the caller graph for this function:

◆ removePath()

void QFileInfoGatherer::removePath ( const QString & path)

Definition at line 295 of file qfileinfogatherer.cpp.

References Q_UNUSED, and unwatchPaths().

+ Here is the call graph for this function:

◆ requestAbort()

void QFileInfoGatherer::requestAbort ( )

Definition at line 91 of file qfileinfogatherer.cpp.

References QThread::requestInterruption().

Referenced by ~QFileInfoGatherer(), and event().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ resolveSymlinks()

bool QFileInfoGatherer::resolveSymlinks ( ) const

Definition at line 120 of file qfileinfogatherer.cpp.

◆ run()

void QFileInfoGatherer::run ( void )
overrideprivatevirtual

Reimplemented from QThread.

Definition at line 318 of file qfileinfogatherer.cpp.

References forever, QString::front(), QThread::isInterruptionRequested(), QList< T >::pop_front(), QThread::setTerminationEnabled(), and QMutexLocker< Mutex >::unlock().

+ Here is the call graph for this function:

◆ setIconProvider

void QFileInfoGatherer::setIconProvider ( QAbstractFileIconProvider * provider)
slot

Definition at line 129 of file qfileinfogatherer.cpp.

◆ setResolveSymlinks

void QFileInfoGatherer::setResolveSymlinks ( bool enable)
slot

Definition at line 98 of file qfileinfogatherer.cpp.

References Q_UNUSED.

◆ setWatching()

void QFileInfoGatherer::setWatching ( bool v)

If v is false, the QFileSystemWatcher used internally will be deleted and subsequent calls to watchPaths() will do nothing.

If v is true, subsequent calls to watchPaths() will add those paths to the filesystem watcher; watchPaths() will initialize a QFileSystemWatcher if one hasn't already been initialized.

Definition at line 262 of file qfileinfogatherer.cpp.

References Q_UNUSED.

◆ unwatchPaths()

void QFileInfoGatherer::unwatchPaths ( const QStringList & paths)

Definition at line 233 of file qfileinfogatherer.cpp.

References Q_UNUSED.

Referenced by clear(), getInfo(), and removePath().

+ Here is the caller graph for this function:

◆ updateFile

void QFileInfoGatherer::updateFile ( const QString & filePath)
slot

Fetch extended information for all filePath.

See also
fetchExtendedInformation()

Definition at line 177 of file qfileinfogatherer.cpp.

References dir, fetchExtendedInformation(), fileName, QString::lastIndexOf(), QString::mid(), and QString::size().

+ Here is the call graph for this function:

◆ updates

void QFileInfoGatherer::updates ( const QString & directory,
const QList< std::pair< QString, QFileInfo > > & updates )
signal

Referenced by QFileSystemModelPrivate::init().

+ Here is the caller graph for this function:

◆ watchedDirectories()

QStringList QFileInfoGatherer::watchedDirectories ( ) const

Definition at line 193 of file qfileinfogatherer.cpp.

Referenced by clear(), and fetchExtendedInformation().

+ Here is the caller graph for this function:

◆ watchedFiles()

QStringList QFileInfoGatherer::watchedFiles ( ) const

Definition at line 184 of file qfileinfogatherer.cpp.

Referenced by clear(), and getInfo().

+ Here is the caller graph for this function:

◆ watchPaths()

void QFileInfoGatherer::watchPaths ( const QStringList & paths)

Definition at line 220 of file qfileinfogatherer.cpp.

References Q_UNUSED.

Referenced by fetchExtendedInformation(), and getInfo().

+ Here is the caller graph for this function:

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