diff options
author | Sebastien Martini <seb@dbzteam.org> | 2010-09-15 21:51:24 +0200 |
---|---|---|
committer | Sebastien Martini <seb@dbzteam.org> | 2010-09-15 21:51:24 +0200 |
commit | 300fb3f5333d7ffbc5bcef8ff89cb24bf2ace20c (patch) | |
tree | e3fb85b6c31aa922fd0f4b52cac379332f524342 /python2/docstrings/pyinotify._ProcessEvent-class.html | |
parent | 909f985842fcae8a45d9591017112186e68a723d (diff) | |
download | pyinotify-300fb3f5333d7ffbc5bcef8ff89cb24bf2ace20c.tar.gz |
Generated documentation 0.9.0+.
Diffstat (limited to 'python2/docstrings/pyinotify._ProcessEvent-class.html')
-rw-r--r-- | python2/docstrings/pyinotify._ProcessEvent-class.html | 324 |
1 files changed, 324 insertions, 0 deletions
diff --git a/python2/docstrings/pyinotify._ProcessEvent-class.html b/python2/docstrings/pyinotify._ProcessEvent-class.html new file mode 100644 index 0000000..9b1e696 --- /dev/null +++ b/python2/docstrings/pyinotify._ProcessEvent-class.html @@ -0,0 +1,324 @@ +<?xml version="1.0" encoding="ascii"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>pyinotify._ProcessEvent</title> + <link rel="stylesheet" href="epydoc.css" type="text/css" /> + <script type="text/javascript" src="epydoc.js"></script> +</head> + +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="pyinotify-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </th> + + <th class="navbar" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <span class="breadcrumbs"> + <a href="pyinotify-module.html">Module pyinotify</a> :: + Class _ProcessEvent + </span> + </td> + <td> + <table cellpadding="0" cellspacing="0"> + <!-- hide/show private --> + <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" + onclick="toggle_private();">hide private</a>]</span></td></tr> + <tr><td align="right"><span class="options" + >[<a href="frames.html" target="_top">frames</a + >] | <a href="pyinotify._ProcessEvent-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== CLASS DESCRIPTION ==================== --> +<h1 class="epydoc">Class _ProcessEvent</h1><p class="nomargin-top"><span class="codelink"><a href="pyinotify-pysrc.html#_ProcessEvent">source code</a></span></p> +<center> + <div class="private"><center> <map id="uml_class_diagram_for_pyinotif_26" name="uml_class_diagram_for_pyinotif_26"> +<area shape="rect" href="pyinotify.ProcessEvent-class.html" title="Process events objects, can be specialized via subclassing, thus its behavior can be overriden:" alt="" coords="155,104,248,131"/> +<area shape="rect" href="pyinotify.PrintAllEvents-class.html" title="Dummy class used to print events strings representations." alt="" coords="16,160,112,187"/> +<area shape="rect" href="pyinotify.ChainIfTrue-class.html" title="Makes conditional chaining depending on the result of the nested processing instance." alt="" coords="163,160,240,187"/> +<area shape="rect" href="pyinotify.Stats-class.html" title="Compute and display trivial statistics about processed events." alt="" coords="291,160,336,187"/> +<area shape="rect" href="pyinotify._ProcessEvent-class.html#__call__" title="To behave like a functor the object must be callable." alt="" coords="221,36,341,55"/> +<area shape="rect" href="pyinotify._ProcessEvent-class.html#__repr__" title="repr(x)" alt="" coords="221,55,341,73"/> +<area shape="rect" href="pyinotify._ProcessEvent-class.html" title="Abstract processing event class." alt="" coords="220,11,343,75"/> +<area shape="rect" href="pyinotify._SysProcessEvent-class.html" title="There is three kind of processing according to each event:" alt="" coords="299,104,424,131"/> +</map> + <img src="uml_class_diagram_for_pyinotif_26.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_26" ismap="ismap" class="graph-without-title" /> +</center></div> + <div class="public" style="display:none"><center> <map id="uml_class_diagram_for_pyinotif_27" name="uml_class_diagram_for_pyinotif_27"> +<area shape="rect" href="pyinotify._ProcessEvent-class.html#__call__" title="To behave like a functor the object must be callable." alt="" coords="107,36,227,55"/> +<area shape="rect" href="pyinotify._ProcessEvent-class.html#__repr__" title="repr(x)" alt="" coords="107,55,227,73"/> +<area shape="rect" href="pyinotify._ProcessEvent-class.html" title="Abstract processing event class." alt="" coords="105,11,228,75"/> +<area shape="rect" href="pyinotify.ProcessEvent-class.html" title="Process events objects, can be specialized via subclassing, thus its behavior can be overriden:" alt="" coords="120,104,213,131"/> +<area shape="rect" href="pyinotify.ChainIfTrue-class.html" title="Makes conditional chaining depending on the result of the nested processing instance." alt="" coords="16,160,93,187"/> +<area shape="rect" href="pyinotify.Stats-class.html" title="Compute and display trivial statistics about processed events." alt="" coords="144,160,189,187"/> +<area shape="rect" href="pyinotify.PrintAllEvents-class.html" title="Dummy class used to print events strings representations." alt="" coords="240,160,336,187"/> +</map> + <img src="uml_class_diagram_for_pyinotif_27.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_27" ismap="ismap" class="graph-without-title" /> +</center></div> +</center> +<hr /> +<p>Abstract processing event class.</p> + +<!-- ==================== INSTANCE METHODS ==================== --> +<a name="section-InstanceMethods"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Instance Methods</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-InstanceMethods" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">bool</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="pyinotify._ProcessEvent-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">event</span>)</span><br /> + To behave like a functor the object must be callable.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="pyinotify-pysrc.html#_ProcessEvent.__call__">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="pyinotify._ProcessEvent-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br /> + repr(x)</td> + <td align="right" valign="top"> + <span class="codelink"><a href="pyinotify-pysrc.html#_ProcessEvent.__repr__">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: + <code>__delattr__</code>, + <code>__format__</code>, + <code>__getattribute__</code>, + <code>__hash__</code>, + <code>__init__</code>, + <code>__new__</code>, + <code>__reduce__</code>, + <code>__reduce_ex__</code>, + <code>__setattr__</code>, + <code>__sizeof__</code>, + <code>__str__</code>, + <code>__subclasshook__</code> + </p> + </td> + </tr> +</table> +<!-- ==================== PROPERTIES ==================== --> +<a name="section-Properties"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Properties</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-Properties" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: + <code>__class__</code> + </p> + </td> + </tr> +</table> +<!-- ==================== METHOD DETAILS ==================== --> +<a name="section-MethodDetails"></a> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Method Details</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-MethodDetails" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +</table> +<a name="__call__"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">__call__</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">event</span>)</span> + <br /><em class="fname">(Call operator)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="pyinotify-pysrc.html#_ProcessEvent.__call__">source code</a></span> + </td> + </tr></table> + + <p>To behave like a functor the object must be callable. This method is a + dispatch method. Its lookup order is:</p> + <ol start="1"> + <li> + process_MASKNAME method + </li> + <li> + process_FAMILY_NAME method + </li> + <li> + otherwise calls process_default + </li> + </ol> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>event</code></strong> (Event object) - Event to be processed.</li> + </ul></dd> + <dt>Returns: bool</dt> + <dd>By convention when used from the ProcessEvent class: + <ul> + <li> + Returning False or None (default value) means keep on + executing next chained functors (see chain.py example). + </li> + <li> + Returning True instead means do not execute next processing + functions. + </li> + </ul></dd> + <dt>Raises:</dt> + <dd><ul class="nomargin-top"> + <li><code><strong class='fraise'><a href="pyinotify.ProcessEventError-class.html">ProcessEventError</a></strong></code> - Event object undispatchable, unknown event.</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="__repr__"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span> + <br /><em class="fname">(Representation operator)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="pyinotify-pysrc.html#_ProcessEvent.__repr__">source code</a></span> + </td> + </tr></table> + + <p>repr(x)</p> + <dl class="fields"> + <dt>Overrides: + object.__repr__ + <dd><em class="note">(inherited documentation)</em></dd> + </dt> + </dl> +</td></tr></table> +</div> +<br /> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="pyinotify-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </th> + + <th class="navbar" width="100%"></th> + </tr> +</table> +<table border="0" cellpadding="0" cellspacing="0" width="100%%"> + <tr> + <td align="left" class="footer"> + Generated by Epydoc 3.0.1 on Wed Sep 15 21:46:51 2010 + </td> + <td align="right" class="footer"> + <a target="mainFrame" href="http://epydoc.sourceforge.net" + >http://epydoc.sourceforge.net</a> + </td> + </tr> +</table> + +<script type="text/javascript"> + <!-- + // Private objects are initially displayed (because if + // javascript is turned off then we want them to be + // visible); but by default, we want to hide them. So hide + // them unless we have a cookie that says to show them. + checkCookie(); + // --> +</script> +</body> +</html> |