root / docstrings / pyinotify.Watch-class.html

Revision a17385ae4cd3f952f689cfeee0d6e04841a4325e, 10.4 kB (checked in by Sebastien Martini <seb@…>, 17 minutes ago)

Updated docstrings generated documentation.

  • Property mode set to 100644
Line 
1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3          "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6  <title>pyinotify.Watch</title>
7  <link rel="stylesheet" href="epydoc.css" type="text/css" />
8  <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12      alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15       bgcolor="#a0c0ff" cellspacing="0">
16  <tr valign="middle">
17  <!-- Home link -->
18      <th>&nbsp;&nbsp;&nbsp;<a
19        href="pyinotify-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21  <!-- Tree link -->
22      <th>&nbsp;&nbsp;&nbsp;<a
23        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25  <!-- Index link -->
26      <th>&nbsp;&nbsp;&nbsp;<a
27        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29  <!-- Help link -->
30      <th>&nbsp;&nbsp;&nbsp;<a
31        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33      <th class="navbar" width="100%"></th>
34  </tr>
35</table>
36<table width="100%" cellpadding="0" cellspacing="0">
37  <tr valign="top">
38    <td width="100%">
39      <span class="breadcrumbs">
40        <a href="pyinotify-module.html">Module&nbsp;pyinotify</a> ::
41        Class&nbsp;Watch
42      </span>
43    </td>
44    <td>
45      <table cellpadding="0" cellspacing="0">
46        <!-- hide/show private -->
47        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
48    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
49        <tr><td align="right"><span class="options"
50            >[<a href="frames.html" target="_top">frames</a
51            >]&nbsp;|&nbsp;<a href="pyinotify.Watch-class.html"
52            target="_top">no&nbsp;frames</a>]</span></td></tr>
53      </table>
54    </td>
55  </tr>
56</table>
57<!-- ==================== CLASS DESCRIPTION ==================== -->
58<h1 class="epydoc">Class Watch</h1><p class="nomargin-top"><span class="codelink"><a href="pyinotify-pysrc.html#Watch">source&nbsp;code</a></span></p>
59<center>
60<center>  <map id="uml_class_diagram_for_pyinotif_21" name="uml_class_diagram_for_pyinotif_21">
61<area shape="rect" href="pyinotify.Watch&#45;class.html#__init__" title="Initializations." alt="" coords="17,36,143,54"/>
62<area shape="rect" href="pyinotify.Watch&#45;class.html#__repr__" title="Returns: &#160;String representation." alt="" coords="17,54,143,73"/>
63<area shape="rect" href="pyinotify.Watch&#45;class.html" title="Represent a watch, i.e." alt="" coords="16,10,144,74"/>
64</map>
65  <img src="uml_class_diagram_for_pyinotif_21.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_21" ismap="ismap" class="graph-without-title" />
66</center>
67</center>
68<hr />
69<p>Represent a watch, i.e. a file or directory being watched.</p>
70
71<!-- ==================== INSTANCE METHODS ==================== -->
72<a name="section-InstanceMethods"></a>
73<table class="summary" border="1" cellpadding="3"
74       cellspacing="0" width="100%" bgcolor="white">
75<tr bgcolor="#70b0f0" class="table-header">
76  <td colspan="2" class="table-header">
77    <table border="0" cellpadding="0" cellspacing="0" width="100%">
78      <tr valign="top">
79        <td align="left"><span class="table-header">Instance Methods</span></td>
80        <td align="right" valign="top"
81         ><span class="options">[<a href="#section-InstanceMethods"
82         class="privatelink" onclick="toggle_private();"
83         >hide private</a>]</span></td>
84      </tr>
85    </table>
86  </td>
87</tr>
88<tr>
89    <td width="15%" align="right" valign="top" class="summary">
90      <span class="summary-type">&nbsp;</span>
91    </td><td class="summary">
92      <table width="100%" cellpadding="0" cellspacing="0" border="0">
93        <tr>
94          <td><span class="summary-sig"><a href="pyinotify.Watch-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
95        <span class="summary-sig-arg">**keys</span>)</span><br />
96      Initializations.</td>
97          <td align="right" valign="top">
98            <span class="codelink"><a href="pyinotify-pysrc.html#Watch.__init__">source&nbsp;code</a></span>
99           
100          </td>
101        </tr>
102      </table>
103     
104    </td>
105  </tr>
106<tr>
107    <td width="15%" align="right" valign="top" class="summary">
108      <span class="summary-type">str</span>
109    </td><td class="summary">
110      <table width="100%" cellpadding="0" cellspacing="0" border="0">
111        <tr>
112          <td><span class="summary-sig"><a href="pyinotify.Watch-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
113      Returns:
114      String representation.</td>
115          <td align="right" valign="top">
116            <span class="codelink"><a href="pyinotify-pysrc.html#Watch.__repr__">source&nbsp;code</a></span>
117           
118          </td>
119        </tr>
120      </table>
121     
122    </td>
123  </tr>
124  <tr>
125    <td colspan="2" class="summary">
126    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
127      <code>__delattr__</code>,
128      <code>__getattribute__</code>,
129      <code>__hash__</code>,
130      <code>__new__</code>,
131      <code>__reduce__</code>,
132      <code>__reduce_ex__</code>,
133      <code>__setattr__</code>,
134      <code>__str__</code>
135      </p>
136    </td>
137  </tr>
138</table>
139<!-- ==================== PROPERTIES ==================== -->
140<a name="section-Properties"></a>
141<table class="summary" border="1" cellpadding="3"
142       cellspacing="0" width="100%" bgcolor="white">
143<tr bgcolor="#70b0f0" class="table-header">
144  <td colspan="2" class="table-header">
145    <table border="0" cellpadding="0" cellspacing="0" width="100%">
146      <tr valign="top">
147        <td align="left"><span class="table-header">Properties</span></td>
148        <td align="right" valign="top"
149         ><span class="options">[<a href="#section-Properties"
150         class="privatelink" onclick="toggle_private();"
151         >hide private</a>]</span></td>
152      </tr>
153    </table>
154  </td>
155</tr>
156  <tr>
157    <td colspan="2" class="summary">
158    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
159      <code>__class__</code>
160      </p>
161    </td>
162  </tr>
163</table>
164<!-- ==================== METHOD DETAILS ==================== -->
165<a name="section-MethodDetails"></a>
166<table class="details" border="1" cellpadding="3"
167       cellspacing="0" width="100%" bgcolor="white">
168<tr bgcolor="#70b0f0" class="table-header">
169  <td colspan="2" class="table-header">
170    <table border="0" cellpadding="0" cellspacing="0" width="100%">
171      <tr valign="top">
172        <td align="left"><span class="table-header">Method Details</span></td>
173        <td align="right" valign="top"
174         ><span class="options">[<a href="#section-MethodDetails"
175         class="privatelink" onclick="toggle_private();"
176         >hide private</a>]</span></td>
177      </tr>
178    </table>
179  </td>
180</tr>
181</table>
182<a name="__init__"></a>
183<div>
184<table class="details" border="1" cellpadding="3"
185       cellspacing="0" width="100%" bgcolor="white">
186<tr><td>
187  <table width="100%" cellpadding="0" cellspacing="0" border="0">
188  <tr valign="top"><td>
189  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
190        <span class="sig-arg">**keys</span>)</span>
191    <br /><em class="fname">(Constructor)</em>
192  </h3>
193  </td><td align="right" valign="top"
194    ><span class="codelink"><a href="pyinotify-pysrc.html#Watch.__init__">source&nbsp;code</a></span>&nbsp;
195    </td>
196  </tr></table>
197 
198  <p>Initializations.</p>
199  <dl class="fields">
200    <dt>Parameters:</dt>
201    <dd><ul class="nomargin-top">
202        <li><strong class="pname"><code>wd</code></strong> (int) - Watch descriptor.</li>
203        <li><strong class="pname"><code>path</code></strong> (str) - Path of the file or directory being watched.</li>
204        <li><strong class="pname"><code>mask</code></strong> (int) - Mask.</li>
205        <li><strong class="pname"><code>proc_fun</code></strong> () - Processing callable object.</li>
206        <li><strong class="pname"><code>auto_add</code></strong> (bool) - Automatically add watches on new directories.</li>
207    </ul></dd>
208    <dt>Overrides:
209        object.__init__
210    </dt>
211  </dl>
212</td></tr></table>
213</div>
214<a name="__repr__"></a>
215<div>
216<table class="details" border="1" cellpadding="3"
217       cellspacing="0" width="100%" bgcolor="white">
218<tr><td>
219  <table width="100%" cellpadding="0" cellspacing="0" border="0">
220  <tr valign="top"><td>
221  <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
222    <br /><em class="fname">(Representation operator)</em>
223  </h3>
224  </td><td align="right" valign="top"
225    ><span class="codelink"><a href="pyinotify-pysrc.html#Watch.__repr__">source&nbsp;code</a></span>&nbsp;
226    </td>
227  </tr></table>
228 
229  <p>repr(x)</p>
230  <dl class="fields">
231    <dt>Returns: str</dt>
232        <dd>String representation.</dd>
233    <dt>Overrides:
234        object.__repr__
235    </dt>
236  </dl>
237</td></tr></table>
238</div>
239<br />
240<!-- ==================== NAVIGATION BAR ==================== -->
241<table class="navbar" border="0" width="100%" cellpadding="0"
242       bgcolor="#a0c0ff" cellspacing="0">
243  <tr valign="middle">
244  <!-- Home link -->
245      <th>&nbsp;&nbsp;&nbsp;<a
246        href="pyinotify-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
247
248  <!-- Tree link -->
249      <th>&nbsp;&nbsp;&nbsp;<a
250        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
251
252  <!-- Index link -->
253      <th>&nbsp;&nbsp;&nbsp;<a
254        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
255
256  <!-- Help link -->
257      <th>&nbsp;&nbsp;&nbsp;<a
258        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
259
260      <th class="navbar" width="100%"></th>
261  </tr>
262</table>
263<table border="0" cellpadding="0" cellspacing="0" width="100%%">
264  <tr>
265    <td align="left" class="footer">
266    Generated by Epydoc 3.0.1 on Tue Jan  6 22:57:24 2009
267    </td>
268    <td align="right" class="footer">
269      <a target="mainFrame" href="http://epydoc.sourceforge.net"
270        >http://epydoc.sourceforge.net</a>
271    </td>
272  </tr>
273</table>
274
275<script type="text/javascript">
276  <!--
277  // Private objects are initially displayed (because if
278  // javascript is turned off then we want them to be
279  // visible); but by default, we want to hide them.  So hide
280  // them unless we have a cookie that says to show them.
281  checkCookie();
282  // -->
283</script>
284</body>
285</html>
Note: See TracBrowser for help on using the browser.