root / docstrings / pyinotify.ChainIf-class.html

Revision f7cd60146b00bdffd25b207639d1d2fb326a2174, 13.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.ChainIf</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;ChainIf
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.ChainIf-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 ChainIf</h1><span class="codelink"><a href="pyinotify-pysrc.html#ChainIf">source&nbsp;code</a></span><br /><br />
59<center>
60<center>  <map id="uml_class_diagram_for_pyinotif_3" name="uml_class_diagram_for_pyinotif_3">
61<area shape="rect" href="pyinotify.ProcessEvent&#45;class.html#pevent" title="pyinotify.ProcessEvent.pevent" alt="" coords="17,102,228,121"/>
62<area shape="rect" href="pyinotify.ProcessEvent&#45;class.html#nested_pevent" title="pyinotify.ProcessEvent.nested_pevent" alt="" coords="17,124,228,142"/>
63<area shape="rect" href="pyinotify.ProcessEvent&#45;class.html#__call__" title="To behave like a functor the object must be callable." alt="" coords="17,142,228,161"/>
64<area shape="rect" href="pyinotify.ProcessEvent&#45;class.html#__init__" title="Enable chaining of ProcessEvent instances." alt="" coords="17,161,228,180"/>
65<area shape="rect" href="pyinotify.ProcessEvent&#45;class.html" title="Process events objects, can be specialized via subclassing, thus its behavior can be overriden:" alt="" coords="16,85,229,181"/>
66<area shape="rect" href="pyinotify.ChainIf&#45;class.html#my_init" title="Override this method when subclassing if you want to achieve custom  initialization of your subclass&#39; instance." alt="" coords="41,236,204,254"/>
67<area shape="rect" href="pyinotify.ChainIf&#45;class.html#process_default" title="Default default processing event method." alt="" coords="41,254,204,273"/>
68<area shape="rect" href="pyinotify.ChainIf&#45;class.html" title="Makes conditional chaining depending on the result of the nested processing instance." alt="" coords="40,210,205,274"/>
69<area shape="rect" href="pyinotify._ProcessEvent&#45;class.html#__repr__" title="repr(x)" alt="" coords="79,36,167,54"/>
70<area shape="rect" href="pyinotify._ProcessEvent&#45;class.html" title="Abstract processing event class." alt="" coords="77,10,168,56"/>
71</map>
72  <img src="uml_class_diagram_for_pyinotif_3.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_3" ismap="ismap" class="graph-without-title" />
73</center></center>
74<hr />
75Makes conditional chaining depending on the result of the nested
76  processing instance.<br /><br />
77
78<!-- ==================== INSTANCE METHODS ==================== -->
79<a name="section-InstanceMethods"></a>
80<table class="summary" border="1" cellpadding="3"
81       cellspacing="0" width="100%" bgcolor="white">
82<tr bgcolor="#70b0f0" class="table-header">
83  <td colspan="2" class="table-header">
84    <table border="0" cellpadding="0" cellspacing="0" width="100%">
85      <tr valign="top">
86        <td align="left"><span class="table-header">Instance Methods</span></td>
87        <td align="right" valign="top"
88         ><span class="options">[<a href="#section-InstanceMethods"
89         class="privatelink" onclick="toggle_private();"
90         >hide private</a>]</span></td>
91      </tr>
92    </table>
93  </td>
94</tr>
95<tr>
96    <td width="15%" align="right" valign="top" class="summary">
97      <span class="summary-type">&nbsp;</span>
98    </td><td class="summary">
99      <table width="100%" cellpadding="0" cellspacing="0" border="0">
100        <tr>
101          <td><span class="summary-sig"><a href="pyinotify.ChainIf-class.html#my_init" class="summary-sig-name">my_init</a>(<span class="summary-sig-arg">self</span>,
102        <span class="summary-sig-arg">func</span>)</span><br />
103      Override this method when subclassing if you want to achieve
104      custom initialization of your subclass' instance.</td>
105          <td align="right" valign="top">
106            <span class="codelink"><a href="pyinotify-pysrc.html#ChainIf.my_init">source&nbsp;code</a></span>
107           
108          </td>
109        </tr>
110      </table>
111     
112    </td>
113  </tr>
114<tr>
115    <td width="15%" align="right" valign="top" class="summary">
116      <span class="summary-type">&nbsp;</span>
117    </td><td class="summary">
118      <table width="100%" cellpadding="0" cellspacing="0" border="0">
119        <tr>
120          <td><span class="summary-sig"><a href="pyinotify.ChainIf-class.html#process_default" class="summary-sig-name">process_default</a>(<span class="summary-sig-arg">self</span>,
121        <span class="summary-sig-arg">event</span>)</span><br />
122      Default default processing event method.</td>
123          <td align="right" valign="top">
124            <span class="codelink"><a href="pyinotify-pysrc.html#ChainIf.process_default">source&nbsp;code</a></span>
125           
126          </td>
127        </tr>
128      </table>
129     
130    </td>
131  </tr>
132  <tr>
133    <td colspan="2" class="summary">
134    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyinotify.ProcessEvent-class.html">ProcessEvent</a></code></b>:
135      <code><a href="pyinotify.ProcessEvent-class.html#__call__">__call__</a></code>,
136      <code><a href="pyinotify.ProcessEvent-class.html#__init__">__init__</a></code>,
137      <code><a href="pyinotify.ProcessEvent-class.html#nested_pevent">nested_pevent</a></code>
138      </p>
139    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyinotify._ProcessEvent-class.html">_ProcessEvent</a></code></b>:
140      <code><a href="pyinotify._ProcessEvent-class.html#__repr__">__repr__</a></code>
141      </p>
142    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
143      <code>__delattr__</code>,
144      <code>__getattribute__</code>,
145      <code>__hash__</code>,
146      <code>__new__</code>,
147      <code>__reduce__</code>,
148      <code>__reduce_ex__</code>,
149      <code>__setattr__</code>,
150      <code>__str__</code>
151      </p>
152    </td>
153  </tr>
154</table>
155<!-- ==================== CLASS VARIABLES ==================== -->
156<a name="section-ClassVariables"></a>
157<table class="summary" border="1" cellpadding="3"
158       cellspacing="0" width="100%" bgcolor="white">
159<tr bgcolor="#70b0f0" class="table-header">
160  <td colspan="2" class="table-header">
161    <table border="0" cellpadding="0" cellspacing="0" width="100%">
162      <tr valign="top">
163        <td align="left"><span class="table-header">Class Variables</span></td>
164        <td align="right" valign="top"
165         ><span class="options">[<a href="#section-ClassVariables"
166         class="privatelink" onclick="toggle_private();"
167         >hide private</a>]</span></td>
168      </tr>
169    </table>
170  </td>
171</tr>
172  <tr>
173    <td colspan="2" class="summary">
174    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyinotify.ProcessEvent-class.html">ProcessEvent</a></code></b>:
175      <code><a href="pyinotify.ProcessEvent-class.html#pevent">pevent</a></code>
176      </p>
177    </td>
178  </tr>
179</table>
180<!-- ==================== PROPERTIES ==================== -->
181<a name="section-Properties"></a>
182<table class="summary" border="1" cellpadding="3"
183       cellspacing="0" width="100%" bgcolor="white">
184<tr bgcolor="#70b0f0" class="table-header">
185  <td colspan="2" class="table-header">
186    <table border="0" cellpadding="0" cellspacing="0" width="100%">
187      <tr valign="top">
188        <td align="left"><span class="table-header">Properties</span></td>
189        <td align="right" valign="top"
190         ><span class="options">[<a href="#section-Properties"
191         class="privatelink" onclick="toggle_private();"
192         >hide private</a>]</span></td>
193      </tr>
194    </table>
195  </td>
196</tr>
197  <tr>
198    <td colspan="2" class="summary">
199    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
200      <code>__class__</code>
201      </p>
202    </td>
203  </tr>
204</table>
205<!-- ==================== METHOD DETAILS ==================== -->
206<a name="section-MethodDetails"></a>
207<table class="details" border="1" cellpadding="3"
208       cellspacing="0" width="100%" bgcolor="white">
209<tr bgcolor="#70b0f0" class="table-header">
210  <td colspan="2" class="table-header">
211    <table border="0" cellpadding="0" cellspacing="0" width="100%">
212      <tr valign="top">
213        <td align="left"><span class="table-header">Method Details</span></td>
214        <td align="right" valign="top"
215         ><span class="options">[<a href="#section-MethodDetails"
216         class="privatelink" onclick="toggle_private();"
217         >hide private</a>]</span></td>
218      </tr>
219    </table>
220  </td>
221</tr>
222</table>
223<a name="my_init"></a>
224<div>
225<table class="details" border="1" cellpadding="3"
226       cellspacing="0" width="100%" bgcolor="white">
227<tr><td>
228  <table width="100%" cellpadding="0" cellspacing="0" border="0">
229  <tr valign="top"><td>
230  <h3 class="epydoc"><span class="sig"><span class="sig-name">my_init</span>(<span class="sig-arg">self</span>,
231        <span class="sig-arg">func</span>)</span>
232  </h3>
233  </td><td align="right" valign="top"
234    ><span class="codelink"><a href="pyinotify-pysrc.html#ChainIf.my_init">source&nbsp;code</a></span>&nbsp;
235    </td>
236  </table>
237 
238  Override this method when subclassing if you want to achieve custom
239  initialization of your subclass' instance. You MUST pass keyword
240  arguments. This method does nothing by default.
241  <dl class="fields">
242    <dt>Overrides:
243      <a href="pyinotify.ProcessEvent-class.html#my_init">ProcessEvent.my_init</a>
244        <dd><em class="note">(inherited documentation)</em></dd>
245    </dt>
246  </dl>
247</td></tr></table>
248</div>
249<a name="process_default"></a>
250<div>
251<table class="details" border="1" cellpadding="3"
252       cellspacing="0" width="100%" bgcolor="white">
253<tr><td>
254  <table width="100%" cellpadding="0" cellspacing="0" border="0">
255  <tr valign="top"><td>
256  <h3 class="epydoc"><span class="sig"><span class="sig-name">process_default</span>(<span class="sig-arg">self</span>,
257        <span class="sig-arg">event</span>)</span>
258  </h3>
259  </td><td align="right" valign="top"
260    ><span class="codelink"><a href="pyinotify-pysrc.html#ChainIf.process_default">source&nbsp;code</a></span>&nbsp;
261    </td>
262  </table>
263 
264  Default default processing event method. Print event on standart
265  output.
266  <dl class="fields">
267    <dt>Overrides:
268      <a href="pyinotify.ProcessEvent-class.html#process_default">ProcessEvent.process_default</a>
269        <dd><em class="note">(inherited documentation)</em></dd>
270    </dt>
271  </dl>
272</td></tr></table>
273</div>
274<br />
275<!-- ==================== NAVIGATION BAR ==================== -->
276<table class="navbar" border="0" width="100%" cellpadding="0"
277       bgcolor="#a0c0ff" cellspacing="0">
278  <tr valign="middle">
279  <!-- Home link -->
280      <th>&nbsp;&nbsp;&nbsp;<a
281        href="pyinotify-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
282
283  <!-- Tree link -->
284      <th>&nbsp;&nbsp;&nbsp;<a
285        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
286
287  <!-- Index link -->
288      <th>&nbsp;&nbsp;&nbsp;<a
289        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
290
291  <!-- Help link -->
292      <th>&nbsp;&nbsp;&nbsp;<a
293        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
294
295      <th class="navbar" width="100%"></th>
296  </tr>
297</table>
298<table border="0" cellpadding="0" cellspacing="0" width="100%%">
299  <tr>
300    <td align="left" class="footer">
301    Generated by Epydoc 3.0beta1 on Sun Aug 10 13:37:37 2008
302    </td>
303    <td align="right" class="footer">
304      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
305    </td>
306  </tr>
307</table>
308
309<script type="text/javascript">
310  <!--
311  // Private objects are initially displayed (because if
312  // javascript is turned off then we want them to be
313  // visible); but by default, we want to hide them.  So hide
314  // them unless we have a cookie that says to show them.
315  checkCookie()
316  // -->
317</script>
318 
319</body>
320</html>
Note: See TracBrowser for help on using the browser.