root / docstrings / pyinotify._Event-class.html

Revision f7cd60146b00bdffd25b207639d1d2fb326a2174, 10.2 kB (checked in by Sebastien Martini <ookoi@…>, 5 months ago)

- Documentation updated.
- Version 0.8.0t released.

  • 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._Event</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;_Event
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._Event-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 _Event</h1><span class="codelink"><a href="pyinotify-pysrc.html#_Event">source&nbsp;code</a></span><br /><br />
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.Event&#45;class.html" title="This class contains all the useful informations about the observed event." alt="" coords="16,104,61,130"/>
62<area shape="rect" href="pyinotify._Event&#45;class.html#__repr__" title="Returns:  String representation." alt="" coords="37,36,152,54"/>
63<area shape="rect" href="pyinotify._Event&#45;class.html#__init__" title="Attach attributes (contained in dict_) to self." alt="" coords="37,54,152,73"/>
64<area shape="rect" href="pyinotify._Event&#45;class.html" title="Event structure, represent events raised by the system." alt="" coords="36,10,153,74"/>
65<area shape="rect" href="pyinotify._RawEvent&#45;class.html" title="Raw event, it contains only the informations provided by the system." alt="" coords="112,104,189,130"/>
66</map>
67  <img src="uml_class_diagram_for_pyinotif_21.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_21" ismap="ismap" class="graph-without-title" />
68</center></center>
69<hr />
70Event structure, represent events raised by the system. This is the
71  base class and should be subclassed.<br /><br />
72
73<!-- ==================== INSTANCE METHODS ==================== -->
74<a name="section-InstanceMethods"></a>
75<table class="summary" border="1" cellpadding="3"
76       cellspacing="0" width="100%" bgcolor="white">
77<tr bgcolor="#70b0f0" class="table-header">
78  <td colspan="2" class="table-header">
79    <table border="0" cellpadding="0" cellspacing="0" width="100%">
80      <tr valign="top">
81        <td align="left"><span class="table-header">Instance Methods</span></td>
82        <td align="right" valign="top"
83         ><span class="options">[<a href="#section-InstanceMethods"
84         class="privatelink" onclick="toggle_private();"
85         >hide private</a>]</span></td>
86      </tr>
87    </table>
88  </td>
89</tr>
90<tr>
91    <td width="15%" align="right" valign="top" class="summary">
92      <span class="summary-type">&nbsp;</span>
93    </td><td class="summary">
94      <table width="100%" cellpadding="0" cellspacing="0" border="0">
95        <tr>
96          <td><span class="summary-sig"><a href="pyinotify._Event-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
97        <span class="summary-sig-arg">dict_</span>)</span><br />
98      Attach attributes (contained in dict_) to self.</td>
99          <td align="right" valign="top">
100            <span class="codelink"><a href="pyinotify-pysrc.html#_Event.__init__">source&nbsp;code</a></span>
101           
102          </td>
103        </tr>
104      </table>
105     
106    </td>
107  </tr>
108<tr>
109    <td width="15%" align="right" valign="top" class="summary">
110      <span class="summary-type">str</span>
111    </td><td class="summary">
112      <table width="100%" cellpadding="0" cellspacing="0" border="0">
113        <tr>
114          <td><span class="summary-sig"><a href="pyinotify._Event-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
115      Returns:
116      String representation.</td>
117          <td align="right" valign="top">
118            <span class="codelink"><a href="pyinotify-pysrc.html#_Event.__repr__">source&nbsp;code</a></span>
119           
120          </td>
121        </tr>
122      </table>
123     
124    </td>
125  </tr>
126  <tr>
127    <td colspan="2" class="summary">
128    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
129      <code>__delattr__</code>,
130      <code>__getattribute__</code>,
131      <code>__hash__</code>,
132      <code>__new__</code>,
133      <code>__reduce__</code>,
134      <code>__reduce_ex__</code>,
135      <code>__setattr__</code>,
136      <code>__str__</code>
137      </p>
138    </td>
139  </tr>
140</table>
141<!-- ==================== PROPERTIES ==================== -->
142<a name="section-Properties"></a>
143<table class="summary" border="1" cellpadding="3"
144       cellspacing="0" width="100%" bgcolor="white">
145<tr bgcolor="#70b0f0" class="table-header">
146  <td colspan="2" class="table-header">
147    <table border="0" cellpadding="0" cellspacing="0" width="100%">
148      <tr valign="top">
149        <td align="left"><span class="table-header">Properties</span></td>
150        <td align="right" valign="top"
151         ><span class="options">[<a href="#section-Properties"
152         class="privatelink" onclick="toggle_private();"
153         >hide private</a>]</span></td>
154      </tr>
155    </table>
156  </td>
157</tr>
158  <tr>
159    <td colspan="2" class="summary">
160    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
161      <code>__class__</code>
162      </p>
163    </td>
164  </tr>
165</table>
166<!-- ==================== METHOD DETAILS ==================== -->
167<a name="section-MethodDetails"></a>
168<table class="details" border="1" cellpadding="3"
169       cellspacing="0" width="100%" bgcolor="white">
170<tr bgcolor="#70b0f0" class="table-header">
171  <td colspan="2" class="table-header">
172    <table border="0" cellpadding="0" cellspacing="0" width="100%">
173      <tr valign="top">
174        <td align="left"><span class="table-header">Method Details</span></td>
175        <td align="right" valign="top"
176         ><span class="options">[<a href="#section-MethodDetails"
177         class="privatelink" onclick="toggle_private();"
178         >hide private</a>]</span></td>
179      </tr>
180    </table>
181  </td>
182</tr>
183</table>
184<a name="__init__"></a>
185<div>
186<table class="details" border="1" cellpadding="3"
187       cellspacing="0" width="100%" bgcolor="white">
188<tr><td>
189  <table width="100%" cellpadding="0" cellspacing="0" border="0">
190  <tr valign="top"><td>
191  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
192        <span class="sig-arg">dict_</span>)</span>
193    <br /><em class="fname">(Constructor)</em>
194  </h3>
195  </td><td align="right" valign="top"
196    ><span class="codelink"><a href="pyinotify-pysrc.html#_Event.__init__">source&nbsp;code</a></span>&nbsp;
197    </td>
198  </table>
199 
200  Attach attributes (contained in dict_) to self.
201  <dl class="fields">
202    <dt>Overrides:
203      object.__init__
204    </dt>
205  </dl>
206</td></tr></table>
207</div>
208<a name="__repr__"></a>
209<div>
210<table class="details" border="1" cellpadding="3"
211       cellspacing="0" width="100%" bgcolor="white">
212<tr><td>
213  <table width="100%" cellpadding="0" cellspacing="0" border="0">
214  <tr valign="top"><td>
215  <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
216    <br /><em class="fname">(Representation operator)</em>
217  </h3>
218  </td><td align="right" valign="top"
219    ><span class="codelink"><a href="pyinotify-pysrc.html#_Event.__repr__">source&nbsp;code</a></span>&nbsp;
220    </td>
221  </table>
222 
223  repr(x)
224  <dl class="fields">
225    <dt>Returns: str</dt>
226        <dd>String representation.</dd>
227    <dt>Overrides:
228      object.__repr__
229    </dt>
230  </dl>
231</td></tr></table>
232</div>
233<br />
234<!-- ==================== NAVIGATION BAR ==================== -->
235<table class="navbar" border="0" width="100%" cellpadding="0"
236       bgcolor="#a0c0ff" cellspacing="0">
237  <tr valign="middle">
238  <!-- Home link -->
239      <th>&nbsp;&nbsp;&nbsp;<a
240        href="pyinotify-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
241
242  <!-- Tree link -->
243      <th>&nbsp;&nbsp;&nbsp;<a
244        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
245
246  <!-- Index link -->
247      <th>&nbsp;&nbsp;&nbsp;<a
248        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
249
250  <!-- Help link -->
251      <th>&nbsp;&nbsp;&nbsp;<a
252        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
253
254      <th class="navbar" width="100%"></th>
255  </tr>
256</table>
257<table border="0" cellpadding="0" cellspacing="0" width="100%%">
258  <tr>
259    <td align="left" class="footer">
260    Generated by Epydoc 3.0beta1 on Sun Aug 10 13:37:38 2008
261    </td>
262    <td align="right" class="footer">
263      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
264    </td>
265  </tr>
266</table>
267
268<script type="text/javascript">
269  <!--
270  // Private objects are initially displayed (because if
271  // javascript is turned off then we want them to be
272  // visible); but by default, we want to hide them.  So hide
273  // them unless we have a cookie that says to show them.
274  checkCookie()
275  // -->
276</script>
277 
278</body>
279</html>
Note: See TracBrowser for help on using the browser.