summaryrefslogtreecommitdiff
path: root/libopie2/opiecore/ofilenotify.h
Unidiff
Diffstat (limited to 'libopie2/opiecore/ofilenotify.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/opiecore/ofilenotify.h10
1 files changed, 8 insertions, 2 deletions
diff --git a/libopie2/opiecore/ofilenotify.h b/libopie2/opiecore/ofilenotify.h
index 41ba84d..3eb917e 100644
--- a/libopie2/opiecore/ofilenotify.h
+++ b/libopie2/opiecore/ofilenotify.h
@@ -120,31 +120,31 @@ class OFileNotification : public QObject
120 * bother with a timerEvent or to create a local QTimer object. 120 * bother with a timerEvent or to create a local QTimer object.
121 * 121 *
122 * Example: 122 * Example:
123 * <pre> 123 * <pre>
124 * 124 *
125 * #include <opie2/oapplication.h> 125 * #include <opie2/oapplication.h>
126 * #include <opie2/ofilenotify.h> 126 * #include <opie2/ofilenotify.h>
127 * using namespace Opie::Core; 127 * using namespace Opie::Core;
128 * 128 *
129 * int main( int argc, char **argv ) 129 * int main( int argc, char **argv )
130 * { 130 * {
131 * OApplication a( argc, argv, "File Notification Example" ); 131 * OApplication a( argc, argv, "File Notification Example" );
132 * OFileNotification::singleShot( "/tmp/quit", &a, SLOT(quit()), Create ); 132 * OFileNotification::singleShot( "/tmp/quit", &a, SLOT(quit()), Access );
133 * ... // create and show your widgets 133 * ... // create and show your widgets
134 * return a.exec(); 134 * return a.exec();
135 * } 135 * }
136 * </pre> 136 * </pre>
137 * 137 *
138 * This sample program automatically terminates when the file "/tmp/quit" has been created. 138 * This sample program automatically terminates when the file "/tmp/quit" has been accessed.
139 * 139 *
140 * 140 *
141 * The @a receiver is the receiving object and the @a member is the slot. 141 * The @a receiver is the receiving object and the @a member is the slot.
142 **/ 142 **/
143 static bool singleShot( const QString& path, QObject* receiver, const char* member, OFileNotificationType type = Modify ); 143 static bool singleShot( const QString& path, QObject* receiver, const char* member, OFileNotificationType type = Modify );
144 /** 144 /**
145 * Starts to watch for @a type changes to @a path. Set @a sshot to True if you want to be notified only once. 145 * Starts to watch for @a type changes to @a path. Set @a sshot to True if you want to be notified only once.
146 * Note that in that case it may be more convenient to use @ref OFileNotification::singleShot() then. 146 * Note that in that case it may be more convenient to use @ref OFileNotification::singleShot() then.
147 **/ 147 **/
148 int watch( const QString& path, bool sshot = false, OFileNotificationType type = Modify ); 148 int watch( const QString& path, bool sshot = false, OFileNotificationType type = Modify );
149 /** 149 /**
150 * Stop watching for file events. 150 * Stop watching for file events.
@@ -213,20 +213,26 @@ class ODirNotification : public QObject
213{ 213{
214 Q_OBJECT 214 Q_OBJECT
215 215
216 public: 216 public:
217 ODirNotification( QObject* parent = 0, const char* name = 0 ); 217 ODirNotification( QObject* parent = 0, const char* name = 0 );
218 ~ODirNotification(); 218 ~ODirNotification();
219 /** 219 /**
220 * Starts to watch for @a type changes to @a path. Recurse @a recurse levels down the filesystem tree, 220 * Starts to watch for @a type changes to @a path. Recurse @a recurse levels down the filesystem tree,
221 * use 0 for no recursion and -1 for unlimited recursion. 221 * use 0 for no recursion and -1 for unlimited recursion.
222 * Set @a sshot to True if you want to be notified only once. 222 * Set @a sshot to True if you want to be notified only once.
223 **/ 223 **/
224 int watch( const QString& path, bool sshot = false, OFileNotificationType type = Modify, int recurse = 0 ); 224 int watch( const QString& path, bool sshot = false, OFileNotificationType type = Modify, int recurse = 0 );
225
226 signals:
227 /**
228 * This signal is emitted if an event happens of the specified type happens to the directory being watched.
229 **/
230 void triggered( const QString& name );
225}; 231};
226 232
227 233
228} 234}
229} 235}
230 236
231#endif 237#endif
232 238