API reference - Class QFileSystemWatcher

Notation used in Ruby API documentation

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

voidaddPath(string file)Method void QFileSystemWatcher::addPath(const QString &file)
voidaddPaths(string[] files)Method void QFileSystemWatcher::addPaths(const QStringList &files)
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QFileSystemWatcher::destroyed(QObject *)
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]string[]directoriesMethod QStringList QFileSystemWatcher::directories()
[event]voiddirectoryChanged(string path)Signal declaration for QFileSystemWatcher::directoryChanged(const QString &path)
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QFileSystemWatcher::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QFileSystemWatcher::eventFilter(QObject *, QEvent *)
[event]voidfileChanged(string path)Signal declaration for QFileSystemWatcher::fileChanged(const QString &path)
[const]string[]filesMethod QStringList QFileSystemWatcher::files()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
voidremovePath(string file)Method void QFileSystemWatcher::removePath(const QString &file)
voidremovePaths(string[] files)Method void QFileSystemWatcher::removePaths(const QStringList &files)

Public static methods and constants

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

Protected methods (static, non-static and constructors)

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

Detailed description

void addPath(string file)

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

void addPaths(string[] files)

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

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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.

[virtual] void customEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroy the object

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

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[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.

[const] string[] directories

Description: Method QStringList QFileSystemWatcher::directories()

[event] void directoryChanged(string path)

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

You can bind a procedure to this signal.

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QFileSystemWatcher::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] 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.

[event] void fileChanged(string path)

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

You can bind a procedure to this signal.

[const] string[] files

Description: Method QStringList QFileSystemWatcher::files()

[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.

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

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

This method creates an object of class QFileSystemWatcher.

[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.

[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.

void removePath(string file)

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

void removePaths(string[] files)

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

[const] QObject ptr sender

Description: Method QObject *QFileSystemWatcher::sender()

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

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[static] string tr(string s,string c = 0)

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

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

[static] string tr(string s,string c,int n)

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.

[static] string trUtf8(string s,string c = 0)

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

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

[static] string trUtf8(string s,string c,int n)

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.