← Back to branch summary

~pecisk-gmail/jokosher/telepathy

« back to all changes in this revision

Viewing changes to doc/api/Monitored.html

  • Committer: davidc
  • Date: 2007-01-02 08:11:10 UTC
  • Revision ID: svn-v3-trunk1:8cf4620e-9a09-0410-af63-e2e309b9c8e0:JonoEdit%2Ftrunk:1115
Updated documentation and theme.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/Monitored.html
1
1
 
2
2
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3
3
<html><head><title>Python: module Monitored</title>
4
 
</head><body bgcolor="#f0f0f8">
 
4
</head><body bgcolor="#ffffff">
5
5
 
6
6
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7
 
<tr bgcolor="#7799ee">
 
7
<tr bgcolor="#fcbb58">
8
8
<td valign=bottom>&nbsp;<br>
9
9
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>Monitored</strong></big></big></font></td
10
10
><td align=right valign=bottom
11
 
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/mike/src/jokosher/trunk/Jokosher/Monitored.py">/home/mike/src/jokosher/trunk/Jokosher/Monitored.py</a></font></td></tr></table>
 
11
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/david/Projects/Jokosher/trunk/Jokosher/Monitored.py">/home/david/Projects/Jokosher/trunk/Jokosher/Monitored.py</a></font></td></tr></table>
12
12
    <p><tt>#&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;THIS&nbsp;FILE&nbsp;IS&nbsp;PART&nbsp;OF&nbsp;THE&nbsp;JOKOSHER&nbsp;PROJECT&nbsp;AND&nbsp;LICENSED&nbsp;UNDER&nbsp;THE&nbsp;GPL.&nbsp;SEE<br>
13
13
#&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;THE&nbsp;'COPYING'&nbsp;FILE&nbsp;FOR&nbsp;DETAILS<br>
14
14
#<br>
19
19
#-------------------------------------------------------------------------------</tt></p>
20
20
<p>
21
21
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
22
 
<tr bgcolor="#ee77aa">
 
22
<tr bgcolor="#3465a4">
23
23
<td colspan=3 valign=bottom>&nbsp;<br>
24
24
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
25
25
    
26
 
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 
26
<tr><td bgcolor="#3465a4"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
27
27
<td width="100%"><dl>
28
28
<dt><font face="helvetica, arial"><a href="Monitored.html#Monitored">Monitored</a>
29
29
</font></dt></dl>
30
30
 <p>
31
31
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
32
 
<tr bgcolor="#ffc8d8">
 
32
<tr bgcolor="#729fcf">
33
33
<td colspan=3 valign=bottom>&nbsp;<br>
34
34
<font color="#000000" face="helvetica, arial"><a name="Monitored">class <strong>Monitored</strong></a></font></td></tr>
35
35
    
36
 
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 
36
<tr bgcolor="#729fcf"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
37
37
<td colspan=2><tt>This&nbsp;class&nbsp;defines&nbsp;a&nbsp;set&nbsp;of&nbsp;functions&nbsp;to&nbsp;allow&nbsp;derived&nbsp;classes&nbsp;to<br>
38
38
have&nbsp;attached&nbsp;monitor&nbsp;objects,&nbsp;which&nbsp;should&nbsp;be&nbsp;signaled&nbsp;if&nbsp;the&nbsp;<br>
39
39
monitored&nbsp;objects&nbsp;state&nbsp;changes.<br>&nbsp;</tt></td></tr>
40
40
<tr><td>&nbsp;</td>
41
41
<td width="100%">Methods defined here:<br>
42
 
<dl><dt><a name="Monitored-AddListener"><strong>AddListener</strong></a>(self, obj)</dt><dd><tt>Adds&nbsp;an&nbsp;object&nbsp;to&nbsp;report&nbsp;changes&nbsp;too.<br>
 
42
<dl><dt><a name="Monitored-AddListener"><strong>AddListener</strong></a>(self, obj)</dt><dd><tt>Adds&nbsp;an&nbsp;object&nbsp;to&nbsp;report&nbsp;changes&nbsp;to.<br>
43
43
&nbsp;<br>
44
 
Keyword&nbsp;arguments:<br>
45
 
obj&nbsp;--&nbsp;An&nbsp;object&nbsp;to&nbsp;inform&nbsp;when&nbsp;StateChanged&nbsp;is&nbsp;called.</tt></dd></dl>
 
44
Parameters:<br>
 
45
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;obj&nbsp;--&nbsp;an&nbsp;object&nbsp;to&nbsp;inform&nbsp;when&nbsp;StateChanged&nbsp;is&nbsp;called.</tt></dd></dl>
 
46
 
 
47
<dl><dt><a name="Monitored-ClearListeners"><strong>ClearListeners</strong></a>(self)</dt><dd><tt>Remove&nbsp;all&nbsp;listeners&nbsp;to&nbsp;allow&nbsp;them&nbsp;to&nbsp;be&nbsp;destroyed.</tt></dd></dl>
46
48
 
47
49
<dl><dt><a name="Monitored-RemoveListener"><strong>RemoveListener</strong></a>(self, obj)</dt><dd><tt>Stop&nbsp;reporting&nbsp;changes&nbsp;to&nbsp;the&nbsp;specified&nbsp;object.<br>
48
50
&nbsp;<br>
49
 
Keyword&nbsp;arguments:<br>
50
 
obj&nbsp;--&nbsp;The&nbsp;object&nbsp;which&nbsp;should&nbsp;no&nbsp;longer&nbsp;receive&nbsp;change&nbsp;updates.</tt></dd></dl>
 
51
Parameters:<br>
 
52
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;obj&nbsp;--&nbsp;the&nbsp;object&nbsp;which&nbsp;should&nbsp;no&nbsp;longer&nbsp;receive&nbsp;change&nbsp;updates.</tt></dd></dl>
51
53
 
52
 
<dl><dt><a name="Monitored-StateChanged"><strong>StateChanged</strong></a>(self, change<font color="#909090">=None</font>)</dt><dd><tt>This&nbsp;function&nbsp;should&nbsp;be&nbsp;called&nbsp;when&nbsp;we&nbsp;want&nbsp;a&nbsp;change&nbsp;to&nbsp;be&nbsp;reported&nbsp;to&nbsp;all&nbsp;objects&nbsp;previously&nbsp;added&nbsp;by&nbsp;AddListener.&nbsp;<br>
 
54
<dl><dt><a name="Monitored-StateChanged"><strong>StateChanged</strong></a>(self, change<font color="#909090">=None</font>, *extra)</dt><dd><tt>This&nbsp;method&nbsp;should&nbsp;be&nbsp;called&nbsp;when&nbsp;we&nbsp;want&nbsp;a&nbsp;change&nbsp;to&nbsp;be&nbsp;reported<br>
 
55
to&nbsp;all&nbsp;objects&nbsp;previously&nbsp;added&nbsp;by&nbsp;AddListener.&nbsp;<br>
53
56
&nbsp;<br>
54
 
Keyword&nbsp;arguments:<br>
55
 
change&nbsp;--&nbsp;The&nbsp;change&nbsp;which&nbsp;has&nbsp;occured&nbsp;(optional).</tt></dd></dl>
 
57
Parameters:<br>
 
58
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;change&nbsp;--&nbsp;the&nbsp;change&nbsp;which&nbsp;has&nbsp;occured.<br>
 
59
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;extra&nbsp;--&nbsp;any&nbsp;extra&nbsp;parameters&nbsp;that&nbsp;should&nbsp;be&nbsp;passed.</tt></dd></dl>
56
60
 
57
 
<dl><dt><a name="Monitored-__init__"><strong>__init__</strong></a>(self)</dt></dl>
 
61
<dl><dt><a name="Monitored-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>Creates&nbsp;a&nbsp;new&nbsp;instance&nbsp;of&nbsp;<a href="#Monitored">Monitored</a>.</tt></dd></dl>
58
62
 
59
63
</td></tr></table></td></tr></table>
60
64
</body></html>
 
 
b'\\ No newline at end of file'