File: qfilesystemwatcher.html

package info (click to toggle)
qt4-x11 4%3A4.8.2%2Bdfsg-11
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 701,696 kB
  • sloc: cpp: 2,686,179; ansic: 375,485; python: 25,859; sh: 19,349; xml: 17,091; perl: 14,765; yacc: 5,383; asm: 5,038; makefile: 1,259; lex: 555; ruby: 526; objc: 347; cs: 112; pascal: 112; php: 54; sed: 34
file content (175 lines) | stat: -rw-r--r-- 15,887 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qfilesystemwatcher.cpp -->
  <title>Qt 4.8: QFileSystemWatcher Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtcore.html">QtCore</a></li>
<li>QFileSystemWatcher</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QFileSystemWatcher Class Reference</h1>
<!-- $$$QFileSystemWatcher-brief -->
<p>The QFileSystemWatcher class provides an interface for monitoring files and directories for modifications. <a href="#details">More...</a></p>
<!-- @@@QFileSystemWatcher -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QFileSystemWatcher&gt;</span></pre><p><b>Inherits: </b><a href="qobject.html">QObject</a>.</p>
<p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
<p>This class was introduced in Qt 4.2.</p>
<ul>
<li><a href="qfilesystemwatcher-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qfilesystemwatcher.html#QFileSystemWatcher">QFileSystemWatcher</a></b> ( QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qfilesystemwatcher.html#QFileSystemWatcher-2">QFileSystemWatcher</a></b> ( const QStringList &amp; <i>paths</i>, QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qfilesystemwatcher.html#dtor.QFileSystemWatcher">~QFileSystemWatcher</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfilesystemwatcher.html#addPath">addPath</a></b> ( const QString &amp; <i>path</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfilesystemwatcher.html#addPaths">addPaths</a></b> ( const QStringList &amp; <i>paths</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qfilesystemwatcher.html#directories">directories</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qfilesystemwatcher.html#files">files</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfilesystemwatcher.html#removePath">removePath</a></b> ( const QString &amp; <i>path</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfilesystemwatcher.html#removePaths">removePaths</a></b> ( const QStringList &amp; <i>paths</i> )</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfilesystemwatcher.html#directoryChanged">directoryChanged</a></b> ( const QString &amp; <i>path</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfilesystemwatcher.html#fileChanged">fileChanged</a></b> ( const QString &amp; <i>path</i> )</td></tr>
</table>
<ul>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
<li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QFileSystemWatcher-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QFileSystemWatcher class provides an interface for monitoring files and directories for modifications.</p>
<p>QFileSystemWatcher monitors the file system for changes to files and directories by watching a list of specified paths.</p>
<p>Call <a href="qfilesystemwatcher.html#addPath">addPath</a>() to watch a particular file or directory. Multiple paths can be added using the <a href="qfilesystemwatcher.html#addPaths">addPaths</a>() function. Existing paths can be removed by using the <a href="qfilesystemwatcher.html#removePath">removePath</a>() and <a href="qfilesystemwatcher.html#removePaths">removePaths</a>() functions.</p>
<p>QFileSystemWatcher examines each path added to it. Files that have been added to the QFileSystemWatcher can be accessed using the <a href="qfilesystemwatcher.html#files">files</a>() function, and directories using the <a href="qfilesystemwatcher.html#directories">directories</a>() function.</p>
<p>The <a href="qfilesystemwatcher.html#fileChanged">fileChanged</a>() signal is emitted when a file has been modified, renamed or removed from disk. Similarly, the <a href="qfilesystemwatcher.html#directoryChanged">directoryChanged</a>() signal is emitted when a directory or its contents is modified or removed. Note that QFileSystemWatcher stops monitoring files once they have been renamed or removed from disk, and directories once they have been removed from disk.</p>
<p><b>Note:</b> On systems running a Linux kernel without inotify support, file systems that contain watched paths cannot be unmounted.</p>
<p><b>Note:</b> Windows CE does not support directory monitoring by default as this depends on the file system driver installed.</p>
<p><b>Note:</b> The act of monitoring files and directories for modifications consumes system resources. This implies there is a limit to the number of files and directories your process can monitor simultaneously. On Mac OS X 10.4 and all BSD variants, for example, an open file descriptor is required for each monitored file. Some system limits the number of open file descriptors to 256 by default. This means that <a href="qfilesystemwatcher.html#addPath">addPath</a>() and <a href="qfilesystemwatcher.html#addPaths">addPaths</a>() will fail if your process tries to add more than 256 files or directories to the file system monitor. Also note that your process may have other file descriptors open in addition to the ones for files being monitored, and these other open descriptors also count in the total. Mac OS X 10.5 and up use a different backend and do not suffer from this issue.</p>
</div>
<p><b>See also </b><a href="qfile.html">QFile</a> and <a href="qdir.html">QDir</a>.</p>
<!-- @@@QFileSystemWatcher -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QFileSystemWatcher[overload1]$$$QFileSystemWatcherQObject* -->
<h3 class="fn"><a name="QFileSystemWatcher"></a>QFileSystemWatcher::<span class="name">QFileSystemWatcher</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs a new file system watcher object with the given <i>parent</i>.</p>
<!-- @@@QFileSystemWatcher -->
<!-- $$$QFileSystemWatcher$$$QFileSystemWatcherconstQStringList&QObject* -->
<h3 class="fn"><a name="QFileSystemWatcher-2"></a>QFileSystemWatcher::<span class="name">QFileSystemWatcher</span> ( const <span class="type"><a href="qstringlist.html">QStringList</a></span> &amp; <i>paths</i>, <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs a new file system watcher object with the given <i>parent</i> which monitors the specified <i>paths</i> list.</p>
<!-- @@@QFileSystemWatcher -->
<!-- $$$~QFileSystemWatcher[overload1]$$$~QFileSystemWatcher -->
<h3 class="fn"><a name="dtor.QFileSystemWatcher"></a>QFileSystemWatcher::<span class="name">~QFileSystemWatcher</span> ()</h3>
<p>Destroys the file system watcher.</p>
<!-- @@@~QFileSystemWatcher -->
<!-- $$$addPath[overload1]$$$addPathconstQString& -->
<h3 class="fn"><a name="addPath"></a><span class="type">void</span> QFileSystemWatcher::<span class="name">addPath</span> ( const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>path</i> )</h3>
<p>Adds <i>path</i> to the file system watcher if <i>path</i> exists. The path is not added if it does not exist, or if it is already being monitored by the file system watcher.</p>
<p>If <i>path</i> specifies a directory, the <a href="qfilesystemwatcher.html#directoryChanged">directoryChanged</a>() signal will be emitted when <i>path</i> is modified or removed from disk; otherwise the <a href="qfilesystemwatcher.html#fileChanged">fileChanged</a>() signal is emitted when <i>path</i> is modified, renamed or removed.</p>
<p><b>Note:</b> There is a system dependent limit to the number of files and directories that can be monitored simultaneously. If this limit has been reached, <i>path</i> will not be added to the file system watcher, and a warning message will be printed to <i>stderr</i>.</p>
<p><b>See also </b><a href="qfilesystemwatcher.html#addPaths">addPaths</a>() and <a href="qfilesystemwatcher.html#removePath">removePath</a>().</p>
<!-- @@@addPath -->
<!-- $$$addPaths[overload1]$$$addPathsconstQStringList& -->
<h3 class="fn"><a name="addPaths"></a><span class="type">void</span> QFileSystemWatcher::<span class="name">addPaths</span> ( const <span class="type"><a href="qstringlist.html">QStringList</a></span> &amp; <i>paths</i> )</h3>
<p>Adds each path in <i>paths</i> to the file system watcher. Paths are not added if they not exist, or if they are already being monitored by the file system watcher.</p>
<p>If a path specifies a directory, the <a href="qfilesystemwatcher.html#directoryChanged">directoryChanged</a>() signal will be emitted when the path is modified or removed from disk; otherwise the <a href="qfilesystemwatcher.html#fileChanged">fileChanged</a>() signal is emitted when the path is modified, renamed, or removed.</p>
<p><b>Note:</b> There is a system dependent limit to the number of files and directories that can be monitored simultaneously. If this limit has been reached, the excess <i>paths</i> will not be added to the file system watcher, and a warning message will be printed to <i>stderr</i> for each path that could not be added.</p>
<p><b>See also </b><a href="qfilesystemwatcher.html#addPath">addPath</a>() and <a href="qfilesystemwatcher.html#removePaths">removePaths</a>().</p>
<!-- @@@addPaths -->
<!-- $$$directories[overload1]$$$directories -->
<h3 class="fn"><a name="directories"></a><span class="type"><a href="qstringlist.html">QStringList</a></span> QFileSystemWatcher::<span class="name">directories</span> () const</h3>
<p>Returns a list of paths to directories that are being watched.</p>
<p><b>See also </b><a href="qfilesystemwatcher.html#files">files</a>().</p>
<!-- @@@directories -->
<!-- $$$directoryChanged[overload1]$$$directoryChangedconstQString& -->
<h3 class="fn"><a name="directoryChanged"></a><span class="type">void</span> QFileSystemWatcher::<span class="name">directoryChanged</span> ( const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>path</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the directory at a specified <i>path</i>, is modified (e.g&#x2e;, when a file is added, modified or deleted) or removed from disk. Note that if there are several changes during a short period of time, some of the changes might not emit this signal. However, the last change in the sequence of changes will always generate this signal.</p>
<p><b>See also </b><a href="qfilesystemwatcher.html#fileChanged">fileChanged</a>().</p>
<!-- @@@directoryChanged -->
<!-- $$$fileChanged[overload1]$$$fileChangedconstQString& -->
<h3 class="fn"><a name="fileChanged"></a><span class="type">void</span> QFileSystemWatcher::<span class="name">fileChanged</span> ( const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>path</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the file at the specified <i>path</i> is modified, renamed or removed from disk.</p>
<p><b>See also </b><a href="qfilesystemwatcher.html#directoryChanged">directoryChanged</a>().</p>
<!-- @@@fileChanged -->
<!-- $$$files[overload1]$$$files -->
<h3 class="fn"><a name="files"></a><span class="type"><a href="qstringlist.html">QStringList</a></span> QFileSystemWatcher::<span class="name">files</span> () const</h3>
<p>Returns a list of paths to files that are being watched.</p>
<p><b>See also </b><a href="qfilesystemwatcher.html#directories">directories</a>().</p>
<!-- @@@files -->
<!-- $$$removePath[overload1]$$$removePathconstQString& -->
<h3 class="fn"><a name="removePath"></a><span class="type">void</span> QFileSystemWatcher::<span class="name">removePath</span> ( const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>path</i> )</h3>
<p>Removes the specified <i>path</i> from the file system watcher.</p>
<p><b>See also </b><a href="qfilesystemwatcher.html#removePaths">removePaths</a>() and <a href="qfilesystemwatcher.html#addPath">addPath</a>().</p>
<!-- @@@removePath -->
<!-- $$$removePaths[overload1]$$$removePathsconstQStringList& -->
<h3 class="fn"><a name="removePaths"></a><span class="type">void</span> QFileSystemWatcher::<span class="name">removePaths</span> ( const <span class="type"><a href="qstringlist.html">QStringList</a></span> &amp; <i>paths</i> )</h3>
<p>Removes the specified <i>paths</i> from the file system watcher.</p>
<p><b>See also </b><a href="qfilesystemwatcher.html#removePath">removePath</a>() and <a href="qfilesystemwatcher.html#addPaths">addPaths</a>().</p>
<!-- @@@removePaths -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
    <p>
      <acronym title="Copyright">&copy;</acronym> 2012 Nokia Corporation and/or its
      subsidiaries. Documentation contributions included herein are the copyrights of
      their respective owners.</p>
    <br />
    <p>
      The documentation provided herein is licensed under the terms of the
      <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
      License version 1.3</a> as published by the Free Software Foundation.</p>
    <p>
      Documentation sources may be obtained from <a href="http://www.qt-project.org">
      www.qt-project.org</a>.</p>
    <br />
    <p>
      Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
      in Finland and/or other countries worldwide. All other trademarks are property
      of their respective owners. <a title="Privacy Policy"
      href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>