~pecisk-gmail/jokosher/telepathy

« back to all changes in this revision

Viewing changes to doc/api/VUWidget.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:
1
1
 
2
2
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3
3
<html><head><title>Python: module VUWidget</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>VUWidget</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/VUWidget.py">/home/mike/src/jokosher/trunk/Jokosher/VUWidget.py</a></font></td></tr></table>
12
 
    <p></p>
 
11
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/david/Projects/Jokosher/trunk/Jokosher/VUWidget.py">/home/david/Projects/Jokosher/trunk/Jokosher/VUWidget.py</a></font></td></tr></table>
 
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
#&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;THE&nbsp;'COPYING'&nbsp;FILE&nbsp;FOR&nbsp;DETAILS<br>
 
14
#<br>
 
15
#&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#VUWidget">VUWidget</a>.py<br>
 
16
#&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>
 
17
#&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This&nbsp;module&nbsp;draws&nbsp;the&nbsp;gradient&nbsp;volume&nbsp;levels&nbsp;and&nbsp;is&nbsp;used&nbsp;by<br>
 
18
#&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;MixerStrip.py&nbsp;to&nbsp;show&nbsp;the&nbsp;volume&nbsp;levels&nbsp;in&nbsp;Jokosher's&nbsp;mix&nbsp;view.<br>
 
19
#<br>
 
20
#-------------------------------------------------------------------------------</tt></p>
13
21
<p>
14
22
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
15
 
<tr bgcolor="#aa55cc">
 
23
<tr bgcolor="#4e9a06">
16
24
<td colspan=3 valign=bottom>&nbsp;<br>
17
25
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
18
26
    
19
 
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 
27
<tr><td bgcolor="#4e9a06"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
20
28
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="cairo.html">cairo</a><br>
21
29
</td><td width="25%" valign=top><a href="gettext.html">gettext</a><br>
22
30
</td><td width="25%" valign=top><a href="gtk.html">gtk</a><br>
23
31
</td><td width="25%" valign=top><a href="pygtk.html">pygtk</a><br>
24
32
</td></tr></table></td></tr></table><p>
25
33
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
26
 
<tr bgcolor="#ee77aa">
 
34
<tr bgcolor="#3465a4">
27
35
<td colspan=3 valign=bottom>&nbsp;<br>
28
36
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
29
37
    
30
 
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 
38
<tr><td bgcolor="#3465a4"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
31
39
<td width="100%"><dl>
32
40
<dt><font face="helvetica, arial">gobject.DrawingArea(gobject.Widget)
33
41
</font></dt><dd>
38
46
</dl>
39
47
 <p>
40
48
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
41
 
<tr bgcolor="#ffc8d8">
 
49
<tr bgcolor="#729fcf">
42
50
<td colspan=3 valign=bottom>&nbsp;<br>
43
51
<font color="#000000" face="helvetica, arial"><a name="VUWidget">class <strong>VUWidget</strong></a>(gobject.DrawingArea)</font></td></tr>
44
52
    
45
 
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 
53
<tr bgcolor="#729fcf"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 
54
<td colspan=2><tt>Draws&nbsp;the&nbsp;gradient&nbsp;volume&nbsp;levels&nbsp;and&nbsp;is&nbsp;used&nbsp;by&nbsp;MixerStrip.py<br>
 
55
to&nbsp;show&nbsp;the&nbsp;volume&nbsp;levels&nbsp;in&nbsp;Jokosher's&nbsp;mix&nbsp;view.<br>&nbsp;</tt></td></tr>
 
56
<tr><td>&nbsp;</td>
46
57
<td width="100%"><dl><dt>Method resolution order:</dt>
47
58
<dd><a href="VUWidget.html#VUWidget">VUWidget</a></dd>
48
59
<dd>gobject.DrawingArea</dd>
55
66
</dl>
56
67
<hr>
57
68
Methods defined here:<br>
58
 
<dl><dt><a name="VUWidget-GenerateBackground"><strong>GenerateBackground</strong></a>(self)</dt><dd><tt>Renders&nbsp;the&nbsp;gradient&nbsp;strip&nbsp;for&nbsp;the&nbsp;VU&nbsp;meter&nbsp;background&nbsp;to&nbsp;speed&nbsp;up<br>
59
 
drawing.</tt></dd></dl>
60
 
 
61
 
<dl><dt><a name="VUWidget-OnDraw"><strong>OnDraw</strong></a>(self, widget, event)</dt><dd><tt>Handles&nbsp;the&nbsp;GTK&nbsp;paint&nbsp;event.</tt></dd></dl>
62
 
 
63
 
<dl><dt><a name="VUWidget-OnMouseDown"><strong>OnMouseDown</strong></a>(self, widget, mouse)</dt></dl>
64
 
 
65
 
<dl><dt><a name="VUWidget-OnMouseLeave"><strong>OnMouseLeave</strong></a>(self, widget, mouse)</dt></dl>
66
 
 
67
 
<dl><dt><a name="VUWidget-OnMouseMove"><strong>OnMouseMove</strong></a>(self, widget, mouse)</dt></dl>
68
 
 
69
 
<dl><dt><a name="VUWidget-OnMouseUp"><strong>OnMouseUp</strong></a>(self, widget, mouse)</dt></dl>
70
 
 
71
 
<dl><dt><a name="VUWidget-OnSizeChanged"><strong>OnSizeChanged</strong></a>(self, obj, evt)</dt><dd><tt>Called&nbsp;when&nbsp;the&nbsp;widget's&nbsp;size&nbsp;changes</tt></dd></dl>
72
 
 
73
 
<dl><dt><a name="VUWidget-__init__"><strong>__init__</strong></a>(self, mixerstrip, mainview)</dt></dl>
74
 
 
75
 
<dl><dt><a name="VUWidget-do_size_request"><strong>do_size_request</strong></a>(self, requisition)</dt></dl>
 
69
<dl><dt><a name="VUWidget-Destroy"><strong>Destroy</strong></a>(self)</dt><dd><tt>Deletes&nbsp;the&nbsp;cairo.ImageSurface&nbsp;and&nbsp;then&nbsp;calls&nbsp;the&nbsp;class&nbsp;destructor.</tt></dd></dl>
 
70
 
 
71
<dl><dt><a name="VUWidget-GenerateBackground"><strong>GenerateBackground</strong></a>(self)</dt><dd><tt>Renders&nbsp;the&nbsp;gradient&nbsp;strip&nbsp;for&nbsp;the&nbsp;VU&nbsp;meter&nbsp;background&nbsp;to&nbsp;speed&nbsp;up&nbsp;drawing.</tt></dd></dl>
 
72
 
 
73
<dl><dt><a name="VUWidget-OnDraw"><strong>OnDraw</strong></a>(self, widget, event)</dt><dd><tt>Handles&nbsp;the&nbsp;GTK&nbsp;paint&nbsp;event.<br>
 
74
&nbsp;<br>
 
75
Parameters:<br>
 
76
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;widget&nbsp;--&nbsp;reserved&nbsp;for&nbsp;GTK&nbsp;callbacks,&nbsp;don't&nbsp;use&nbsp;it&nbsp;explicitly.<br>
 
77
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;event&nbsp;--&nbsp;reserved&nbsp;for&nbsp;GTK&nbsp;callbacks,&nbsp;don't&nbsp;use&nbsp;it&nbsp;explicitly.<br>
 
78
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>
 
79
Returns:<br>
 
80
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;False&nbsp;--&nbsp;TODO</tt></dd></dl>
 
81
 
 
82
<dl><dt><a name="VUWidget-OnMouseDown"><strong>OnMouseDown</strong></a>(self, widget, mouse)</dt><dd><tt>If&nbsp;the&nbsp;fader&nbsp;widget&nbsp;is&nbsp;clicked,&nbsp;activates&nbsp;it.<br>
 
83
&nbsp;<br>
 
84
Parameters:<br>
 
85
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;widget&nbsp;--&nbsp;reserved&nbsp;for&nbsp;GTK&nbsp;callbacks,&nbsp;don't&nbsp;use&nbsp;it&nbsp;explicitly.<br>
 
86
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;mouse&nbsp;--&nbsp;reserved&nbsp;for&nbsp;GTK&nbsp;callbacks,&nbsp;don't&nbsp;use&nbsp;it&nbsp;explicitly.</tt></dd></dl>
 
87
 
 
88
<dl><dt><a name="VUWidget-OnMouseLeave"><strong>OnMouseLeave</strong></a>(self, widget, mouse)</dt><dd><tt>Clears&nbsp;the&nbsp;StatusBar&nbsp;helper&nbsp;message.<br>
 
89
&nbsp;<br>
 
90
Parameters:<br>
 
91
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;widget&nbsp;--&nbsp;reserved&nbsp;for&nbsp;GTK&nbsp;callbacks,&nbsp;don't&nbsp;use&nbsp;it&nbsp;explicitly.<br>
 
92
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;mouse&nbsp;--&nbsp;reserved&nbsp;for&nbsp;GTK&nbsp;callbacks,&nbsp;don't&nbsp;use&nbsp;it&nbsp;explicitly.</tt></dd></dl>
 
93
 
 
94
<dl><dt><a name="VUWidget-OnMouseMove"><strong>OnMouseMove</strong></a>(self, widget, mouse)</dt><dd><tt>Displays&nbsp;a&nbsp;helper&nbsp;message&nbsp;in&nbsp;the&nbsp;StatusBar&nbsp;and&nbsp;sets&nbsp;the&nbsp;volume<br>
 
95
according&nbsp;to&nbsp;the&nbsp;position&nbsp;of&nbsp;the&nbsp;fader&nbsp;widget.<br>
 
96
&nbsp;<br>
 
97
Parameters:<br>
 
98
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;widget&nbsp;--&nbsp;reserved&nbsp;for&nbsp;GTK&nbsp;callbacks,&nbsp;don't&nbsp;use&nbsp;it&nbsp;explicitly.<br>
 
99
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;mouse&nbsp;--&nbsp;reserved&nbsp;for&nbsp;GTK&nbsp;callbacks,&nbsp;don't&nbsp;use&nbsp;it&nbsp;explicitly.</tt></dd></dl>
 
100
 
 
101
<dl><dt><a name="VUWidget-OnMouseUp"><strong>OnMouseUp</strong></a>(self, widget, mouse)</dt><dd><tt>Deactivates&nbsp;the&nbsp;fader&nbsp;widget.<br>
 
102
&nbsp;<br>
 
103
Parameters:<br>
 
104
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;widget&nbsp;--&nbsp;reserved&nbsp;for&nbsp;GTK&nbsp;callbacks,&nbsp;don't&nbsp;use&nbsp;it&nbsp;explicitly.<br>
 
105
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;mouse&nbsp;--&nbsp;reserved&nbsp;for&nbsp;GTK&nbsp;callbacks,&nbsp;don't&nbsp;use&nbsp;it&nbsp;explicitly.</tt></dd></dl>
 
106
 
 
107
<dl><dt><a name="VUWidget-OnSizeChanged"><strong>OnSizeChanged</strong></a>(self, obj, evt)</dt><dd><tt>Toggles&nbsp;a&nbsp;redraw&nbsp;of&nbsp;the&nbsp;<a href="#VUWidget">VUWidget</a>&nbsp;if&nbsp;needed.<br>
 
108
&nbsp;<br>
 
109
Parameters:<br>
 
110
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;obj&nbsp;--&nbsp;reserved&nbsp;for&nbsp;Cairo&nbsp;callbacks,&nbsp;don't&nbsp;use&nbsp;it&nbsp;explicitly.&nbsp;*CHECK*<br>
 
111
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;evt&nbsp;--reserved&nbsp;for&nbsp;Cairo&nbsp;callbacks,&nbsp;don't&nbsp;use&nbsp;it&nbsp;explicitly.&nbsp;*CHECK*</tt></dd></dl>
 
112
 
 
113
<dl><dt><a name="VUWidget-__init__"><strong>__init__</strong></a>(self, mixerstrip, mainview)</dt><dd><tt>Creates&nbsp;a&nbsp;new&nbsp;instance&nbsp;of&nbsp;<a href="#VUWidget">VUWidget</a>.<br>
 
114
&nbsp;<br>
 
115
Parameters:<br>
 
116
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;mixerstrip&nbsp;--&nbsp;TODO<br>
 
117
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;mainview&nbsp;--&nbsp;the&nbsp;main&nbsp;Jokosher&nbsp;window&nbsp;(JokosherApp).</tt></dd></dl>
 
118
 
 
119
<dl><dt><a name="VUWidget-do_size_request"><strong>do_size_request</strong></a>(self, requisition)</dt><dd><tt>TODO<br>
 
120
&nbsp;<br>
 
121
Parameters:<br>
 
122
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;requisition&nbsp;--&nbsp;TODO</tt></dd></dl>
76
123
 
77
124
<hr>
78
125
Data and other attributes defined here:<br>
79
126
<dl><dt><strong>BAR_WIDTH</strong> = 20</dl>
80
127
 
81
 
<dl><dt><strong>__gtype__</strong> = &lt;GType VUWidget (137011496)&gt;</dl>
 
128
<dl><dt><strong>__gtype__</strong> = &lt;GType VUWidget (138585352)&gt;</dl>
82
129
 
83
130
<dl><dt><strong>__gtype_name__</strong> = 'VUWidget'</dl>
84
131
 
606
653
Data and other attributes inherited from <a href="gobject.html#GObject">gobject.GObject</a>:<br>
607
654
<dl><dt><strong>__dict__</strong> = &lt;dictproxy object&gt;</dl>
608
655
 
609
 
<dl><dt><strong>__gdoc__</strong> = 'Object VUWidget<font color="#c040c0">\n\n</font>Signals from GtkWidget:<font color="#c040c0">\n</font>  compo...ointer<font color="#c040c0">\n\n</font>Signals from GObject:<font color="#c040c0">\n</font>  notify (GParam)<font color="#c040c0">\n\n</font>'</dl>
 
656
<dl><dt><strong>__gdoc__</strong> = 'Object VUWidget<font color="#c040c0">\n\n\n\t</font>Draws the gradient volume lev...ointer<font color="#c040c0">\n\n</font>Signals from GObject:<font color="#c040c0">\n</font>  notify (GParam)<font color="#c040c0">\n\n</font>'</dl>
610
657
 
611
658
<dl><dt><strong>__grefcount__</strong> = &lt;attribute '__grefcount__' of 'gobject.GObject' objects&gt;</dl>
612
659