API reference - Class QFileSystemWatcher

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QFileSystemWatcher

Class hierarchy: QFileSystemWatcher » QObject

Public constructors

new QFileSystemWatchernew(QObject ptr parent = 0)Constructor QFileSystemWatcher::QFileSystemWatcher(QObject *parent)
new QFileSystemWatchernew(string[] paths,
QObject ptr parent = 0)
Constructor QFileSystemWatcher::QFileSystemWatcher(const QStringList &paths, QObject *parent)

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
booladdPath(string file)Method bool QFileSystemWatcher::addPath(const QString &file)
string[]addPaths(string[] files)Method QStringList QFileSystemWatcher::addPaths(const QStringList &files)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QFileSystemWatcher::destroyed(QObject *)
[const]string[]directoriesMethod QStringList QFileSystemWatcher::directories()
[signal]voiddirectoryChanged(string path)Signal declaration for QFileSystemWatcher::directoryChanged(const QString &path)
voidemit_destroyed(QObject ptr arg1 = 0)Emitter for signal void QFileSystemWatcher::destroyed(QObject *)
voidemit_directoryChanged(string path)Emitter for signal void QFileSystemWatcher::directoryChanged(const QString &path)
voidemit_fileChanged(string path)Emitter for signal void QFileSystemWatcher::fileChanged(const QString &path)
voidemit_objectNameChanged(string objectName)Emitter for signal void QFileSystemWatcher::objectNameChanged(const QString &objectName)
boolevent(QEvent ptr arg1)Virtual method bool QFileSystemWatcher::event(QEvent *)
booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QFileSystemWatcher::eventFilter(QObject *, QEvent *)
[signal]voidfileChanged(string path)Signal declaration for QFileSystemWatcher::fileChanged(const QString &path)
[const]string[]filesMethod QStringList QFileSystemWatcher::files()
[signal]voidobjectNameChanged(string objectName)Signal declaration for QFileSystemWatcher::objectNameChanged(const QString &objectName)
boolremovePath(string file)Method bool QFileSystemWatcher::removePath(const QString &file)
string[]removePaths(string[] files)Method QStringList QFileSystemWatcher::removePaths(const QStringList &files)

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QFileSystemWatcher::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QFileSystemWatcher::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr arg1)Virtual method void QFileSystemWatcher::childEvent(QChildEvent *)
voidcustomEvent(QEvent ptr arg1)Virtual method void QFileSystemWatcher::customEvent(QEvent *)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QFileSystemWatcher::disconnectNotify(const QMetaMethod &signal)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QFileSystemWatcher::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QFileSystemWatcher::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QFileSystemWatcher::sender()
[const]intsenderSignalIndexMethod int QFileSystemWatcher::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QFileSystemWatcher::timerEvent(QTimerEvent *)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

addPath

Signature: bool addPath (string file)

Description: Method bool QFileSystemWatcher::addPath(const QString &file)

addPaths

Signature: string[] addPaths (string[] files)

Description: Method QStringList QFileSystemWatcher::addPaths(const QStringList &files)

childEvent

Signature: void childEvent (QChildEvent ptr arg1)

Description: Virtual method void QFileSystemWatcher::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

customEvent

Signature: void customEvent (QEvent ptr arg1)

Description: Virtual method void QFileSystemWatcher::customEvent(QEvent *)

This method can be reimplemented in a derived class.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QFileSystemWatcher::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

directories

Signature: [const] string[] directories

Description: Method QStringList QFileSystemWatcher::directories()

directoryChanged

Signature: [signal] void directoryChanged (string path)

Description: Signal declaration for QFileSystemWatcher::directoryChanged(const QString &path)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'directoryChanged'. This is the getter.
The object exposes a writable attribute 'directoryChanged'. This is the setter.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QFileSystemWatcher::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = 0)

Description: Emitter for signal void QFileSystemWatcher::destroyed(QObject *)

Call this method to emit this signal.

emit_directoryChanged

Signature: void emit_directoryChanged (string path)

Description: Emitter for signal void QFileSystemWatcher::directoryChanged(const QString &path)

Call this method to emit this signal.

emit_fileChanged

Signature: void emit_fileChanged (string path)

Description: Emitter for signal void QFileSystemWatcher::fileChanged(const QString &path)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QFileSystemWatcher::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr arg1)

Description: Virtual method bool QFileSystemWatcher::event(QEvent *)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr arg1, QEvent ptr arg2)

Description: Virtual method bool QFileSystemWatcher::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

fileChanged

Signature: [signal] void fileChanged (string path)

Description: Signal declaration for QFileSystemWatcher::fileChanged(const QString &path)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'fileChanged'. This is the getter.
The object exposes a writable attribute 'fileChanged'. This is the setter.

files

Signature: [const] string[] files

Description: Method QStringList QFileSystemWatcher::files()

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QFileSystemWatcher::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

new

(1) Signature: [static] new QFileSystemWatcher new (QObject ptr parent = 0)

Description: Constructor QFileSystemWatcher::QFileSystemWatcher(QObject *parent)

This method creates an object of class QFileSystemWatcher.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QFileSystemWatcher new (string[] paths, QObject ptr parent = 0)

Description: Constructor QFileSystemWatcher::QFileSystemWatcher(const QStringList &paths, QObject *parent)

This method creates an object of class QFileSystemWatcher.

Python specific notes:
This method is the default initializer of the object.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QFileSystemWatcher::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QFileSystemWatcher::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

removePath

Signature: bool removePath (string file)

Description: Method bool QFileSystemWatcher::removePath(const QString &file)

removePaths

Signature: string[] removePaths (string[] files)

Description: Method QStringList QFileSystemWatcher::removePaths(const QStringList &files)

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QFileSystemWatcher::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QFileSystemWatcher::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr arg1)

Description: Virtual method void QFileSystemWatcher::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QFileSystemWatcher::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QFileSystemWatcher::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.