QWindowsRemovableDriveListener Class Reference

Inheritance diagram for QWindowsRemovableDriveListener:

Collaboration diagram for QWindowsRemovableDriveListener:

Classes
struct	RemovableDriveEntry

Public Types
enum	VolumeUuid {   UnknownUuid , UuidIoVolumeLock , UuidIoVolumeLockFailed , UuidIoVolumeUnlock ,   UuidIoMediaRemoval , UnknownUuid , UuidIoVolumeLock , UuidIoVolumeLockFailed ,   UuidIoVolumeUnlock , UuidIoMediaRemoval }
enum	VolumeUuid {   UnknownUuid , UuidIoVolumeLock , UuidIoVolumeLockFailed , UuidIoVolumeUnlock ,   UuidIoMediaRemoval , UnknownUuid , UuidIoVolumeLock , UuidIoVolumeLockFailed ,   UuidIoVolumeUnlock , UuidIoMediaRemoval }

Signals
void	driveAdded ()
void	driveRemoved ()
void	driveRemoved (const QString &)
void	driveLockForRemoval (const QString &)
void	driveLockForRemovalFailed (const QString &)
void	driveAdded ()
void	driveRemoved ()
void	driveRemoved (const QString &)
void	driveLockForRemoval (const QString &)
void	driveLockForRemovalFailed (const QString &)
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
	QWindowsRemovableDriveListener (QObject *parent=nullptr)
	~QWindowsRemovableDriveListener ()
void	addPath (const QString &path)
bool	nativeEventFilter (const QByteArray &, void *messageIn, qintptr *) override
	This method is called for every native event.
	QWindowsRemovableDriveListener (QObject *parent=nullptr)
	~QWindowsRemovableDriveListener ()
void	addPath (const QString &path)
bool	nativeEventFilter (const QByteArray &, void *messageIn, qintptr *) override
	This method is called for every native event.
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	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
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< QString >	bindableObjectName ()
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).
QThread *	thread () 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 >
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 >
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 QObjectList &	children () 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< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () 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.
Public Member Functions inherited from QAbstractNativeEventFilter
	QAbstractNativeEventFilter ()
	Creates a native event filter.
virtual	~QAbstractNativeEventFilter ()
	Destroys the native event filter.

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
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)
Protected Member Functions inherited from QObject
QObject *	sender () 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)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Properties inherited from QObject
QString	objectName
	the name of this object
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 57 of file qfilesystemwatcher_win.cpp.

Member Enumeration Documentation

VolumeUuid [1/2]

enum QWindowsRemovableDriveListener::VolumeUuid

Enumerator
UnknownUuid
UuidIoVolumeLock
UuidIoVolumeLockFailed
UuidIoVolumeUnlock
UuidIoMediaRemoval
UnknownUuid
UuidIoVolumeLock
UuidIoVolumeLockFailed
UuidIoVolumeUnlock
UuidIoMediaRemoval

Definition at line 62 of file qfilesystemwatcher_win.cpp.

VolumeUuid [2/2]

enum QWindowsRemovableDriveListener::VolumeUuid

Enumerator
UnknownUuid
UuidIoVolumeLock
UuidIoVolumeLockFailed
UuidIoVolumeUnlock
UuidIoMediaRemoval
UnknownUuid
UuidIoVolumeLock
UuidIoVolumeLockFailed
UuidIoVolumeUnlock
UuidIoMediaRemoval

Definition at line 62 of file qfilesystemwatcher_win.cpp.

Constructor & Destructor Documentation

QWindowsRemovableDriveListener() [1/2]

QWindowsRemovableDriveListener::QWindowsRemovableDriveListener ( QObject * parent = nullptr )

explicit

Definition at line 94 of file qfilesystemwatcher_win.cpp.

References QWindowsRemovableDriveListener().

Referenced by QWindowsRemovableDriveListener().

Here is the call graph for this function:

Here is the caller graph for this function:

~QWindowsRemovableDriveListener() [1/2]

QWindowsRemovableDriveListener::~QWindowsRemovableDriveListener

(

)

Definition at line 113 of file qfilesystemwatcher_win.cpp.

QWindowsRemovableDriveListener() [2/2]

QWindowsRemovableDriveListener::QWindowsRemovableDriveListener ( QObject * parent = nullptr )

explicit

~QWindowsRemovableDriveListener() [2/2]

QWindowsRemovableDriveListener::~QWindowsRemovableDriveListener

(

)

Member Function Documentation

addPath() [1/2]

void QWindowsRemovableDriveListener::addPath

(

const QString &

path

)

Definition at line 241 of file qfilesystemwatcher_win.cpp.

References QWindowsRemovableDriveListener::RemovableDriveEntry::drive.

addPath() [2/2]

void QWindowsRemovableDriveListener::addPath

(

const QString &

path

)

driveAdded [1/2]

void QWindowsRemovableDriveListener::driveAdded ( )

signal

driveAdded [2/2]

void QWindowsRemovableDriveListener::driveAdded ( )

signal

driveLockForRemoval [1/2]

void QWindowsRemovableDriveListener::driveLockForRemoval ( const QString & )

signal

driveLockForRemoval [2/2]

void QWindowsRemovableDriveListener::driveLockForRemoval ( const QString & )

signal

driveLockForRemovalFailed [1/2]

void QWindowsRemovableDriveListener::driveLockForRemovalFailed ( const QString & )

signal

driveLockForRemovalFailed [2/2]

void QWindowsRemovableDriveListener::driveLockForRemovalFailed ( const QString & )

signal

driveRemoved [1/4]

void QWindowsRemovableDriveListener::driveRemoved ( )

signal

driveRemoved [2/4]

void QWindowsRemovableDriveListener::driveRemoved ( )

signal

driveRemoved [3/4]

void QWindowsRemovableDriveListener::driveRemoved ( const QString & )

signal

driveRemoved [4/4]

void QWindowsRemovableDriveListener::driveRemoved ( const QString & )

signal

nativeEventFilter() [1/2]

bool QWindowsRemovableDriveListener::nativeEventFilter ( const QByteArray & eventType, void * message, qintptr * result )

overridevirtual

This method is called for every native event.

Note

The filter function here receives native messages, for example, MSG or XCB event structs.

It is called by the QPA platform plugin. On Windows, it is called by the event dispatcher.

The type of event eventType is specific to the platform plugin chosen at run-time, and can be used to cast message to the right type.

On X11, eventType is set to "xcb_generic_event_t", and the message can be casted to a xcb_generic_event_t pointer.

On Windows, eventType is set to "windows_generic_MSG" for messages sent to toplevel windows, and "windows_dispatcher_MSG" for system-wide messages such as messages from a registered hot key. In both cases, the message can be casted to a MSG pointer. The result pointer is only used on Windows, and corresponds to the LRESULT pointer.

On macOS, eventType is set to "mac_generic_NSEvent", and the message can be casted to an NSEvent pointer.

In your reimplementation of this function, if you want to filter the message out, i.e. stop it being handled further, return true; otherwise return false.

{Linux example}

class MyXcbEventFilter : public QAbstractNativeEventFilter
{
public:
    bool nativeEventFilter(const QByteArray &eventType, void *message, qintptr *) override
    {
        if (eventType == "xcb_generic_event_t") {
            xcb_generic_event_t* ev = static_cast<xcb_generic_event_t *>(message);
            // ...
        }
        return false;
    }
};

{Windows example}

class MyMSGEventFilter : public QAbstractNativeEventFilter
{
public:
    bool nativeEventFilter(const QByteArray &eventType, void *message, qintptr *) override
    {
        if (eventType == "windows_generic_MSG") {
            MSG *msg = static_cast<MSG *>(message);
            // ...
        } else if (eventType == "windows_dispatcher_MSG") {
            MSG *msg = static_cast<MSG *>(message);
            // ...
        }
        return false;
    }
};

{macOS example}

mycocoaeventfilter.h:

#include <QAbstractNativeEventFilter>
 
class MyCocoaEventFilter : public QAbstractNativeEventFilter
{
public:
    bool nativeEventFilter(const QByteArray &eventType, void *message, qintptr *) override;
};

mycocoaeventfilter.mm:

#include "mycocoaeventfilter.h"
 
#import <AppKit/AppKit.h>
 
bool MyCocoaEventFilter::nativeEventFilter(const QByteArray &eventType, void *message, qintptr *)
{
    if (eventType == "mac_generic_NSEvent") {
        NSEvent *event = static_cast<NSEvent *>(message);
        if ([event type] == NSKeyDown) {
            // Handle key event
            qDebug() << QString::fromNSString([event characters]);
        }
    }
    return false;
}

myapp.pro:

HEADERS += mycocoaeventfilter.h
OBJECTIVE_SOURCES += mycocoaeventfilter.mm
LIBS += -framework AppKit

Implements QAbstractNativeEventFilter.

Definition at line 223 of file qfilesystemwatcher_win.cpp.

nativeEventFilter() [2/2]

bool QWindowsRemovableDriveListener::nativeEventFilter ( const QByteArray & eventType, void * message, qintptr * result )

overridevirtual

This method is called for every native event.

Note

The filter function here receives native messages, for example, MSG or XCB event structs.

It is called by the QPA platform plugin. On Windows, it is called by the event dispatcher.

The type of event eventType is specific to the platform plugin chosen at run-time, and can be used to cast message to the right type.

On X11, eventType is set to "xcb_generic_event_t", and the message can be casted to a xcb_generic_event_t pointer.

On Windows, eventType is set to "windows_generic_MSG" for messages sent to toplevel windows, and "windows_dispatcher_MSG" for system-wide messages such as messages from a registered hot key. In both cases, the message can be casted to a MSG pointer. The result pointer is only used on Windows, and corresponds to the LRESULT pointer.

On macOS, eventType is set to "mac_generic_NSEvent", and the message can be casted to an NSEvent pointer.

In your reimplementation of this function, if you want to filter the message out, i.e. stop it being handled further, return true; otherwise return false.

{Linux example}

class MyXcbEventFilter : public QAbstractNativeEventFilter
{
public:
    bool nativeEventFilter(const QByteArray &eventType, void *message, qintptr *) override
    {
        if (eventType == "xcb_generic_event_t") {
            xcb_generic_event_t* ev = static_cast<xcb_generic_event_t *>(message);
            // ...
        }
        return false;
    }
};

{Windows example}

class MyMSGEventFilter : public QAbstractNativeEventFilter
{
public:
    bool nativeEventFilter(const QByteArray &eventType, void *message, qintptr *) override
    {
        if (eventType == "windows_generic_MSG") {
            MSG *msg = static_cast<MSG *>(message);
            // ...
        } else if (eventType == "windows_dispatcher_MSG") {
            MSG *msg = static_cast<MSG *>(message);
            // ...
        }
        return false;
    }
};

{macOS example}

mycocoaeventfilter.h:

#include <QAbstractNativeEventFilter>
 
class MyCocoaEventFilter : public QAbstractNativeEventFilter
{
public:
    bool nativeEventFilter(const QByteArray &eventType, void *message, qintptr *) override;
};

mycocoaeventfilter.mm:

#include "mycocoaeventfilter.h"
 
#import <AppKit/AppKit.h>
 
bool MyCocoaEventFilter::nativeEventFilter(const QByteArray &eventType, void *message, qintptr *)
{
    if (eventType == "mac_generic_NSEvent") {
        NSEvent *event = static_cast<NSEvent *>(message);
        if ([event type] == NSKeyDown) {
            // Handle key event
            qDebug() << QString::fromNSString([event characters]);
        }
    }
    return false;
}

myapp.pro:

HEADERS += mycocoaeventfilter.h
OBJECTIVE_SOURCES += mycocoaeventfilter.mm
LIBS += -framework AppKit

Implements QAbstractNativeEventFilter.

---

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

• qtbase/src/corelib/io/qfilesystemwatcher_win.cpp (8fe793fe4b43c84f5d158e0d62fdd92ea4b2d851)