~michael-sheldon/jokosher/crash_protection

><a href=".">index</a> <a href="file:/home/mike/src/jokosher/trunk/Jokosher/TimeLine.py">/home/mike/src/jokosher/trunk/Jokosher/TimeLine.py</a></td></tr></table>

><a href=".">index</a> <a href="file:/home/david/Projects/Jokosher/trunk/Jokosher/TimeLine.py">/home/david/Projects/Jokosher/trunk/Jokosher/TimeLine.py</a></td></tr></table>

<tt>#       THIS FILE IS PART OF THE JOKOSHER PROJECT AND LICENSED UNDER THE GPL. SEE

#       THE 'COPYING' FILE FOR DETAILS

#

#       <a href="#TimeLine">TimeLine</a>.py

#

#       This class handles the drawing of the timeline display.

#

#-------------------------------------------------------------------------------</tt>

<big>Modules</big></td></tr>

<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="gobject.html">gobject</a>

</td><td width="25%" valign=top><a href="gst.html">gst</a>

</td><td width="25%" valign=top><a href="gtk.html">gtk</a>

</td><td width="25%" valign=top><a href="pango.html">pango</a>

</td></tr></table></td></tr></table>

</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table>

<big>Classes</big></td></tr>

<dt>gobject.DrawingArea(gobject.Widget)

</dt><dd>

</dl>

<a name="TimeLine">class TimeLine</a>(gobject.DrawingArea)</td></tr>

<td colspan=2><tt>This class handles drawing the time line display. The time line is part of the

TimeLineBar. <a href="#TimeLine">TimeLine</a> displays the time in minutes/seconds (MODE_HOURS_MINS_SECS)

or bars and beats (MODE_BARS_BEATS). These modes are set in project.transport.

To improve performance, the line isn't being constructed on each call of OnDraw. It

is saved into self.savedLine as a gtk.gdk.Image. A new savedLine is constructed when

- there is no savedLine

- or project.transport.RedrawTimeLine is True

- or project.RedrawTimeLine is True

- there is no savedLine

- or project.transport.RedrawTimeLine is True

- or project.RedrawTimeLine is True

When the time line is constructed in MODE_HOURS_MINS_SECS, it dynamically adjusts

its scale to the project.viewScale. MODE_BARS_BEATS does not support this (yet).  </tt></td></tr>

</dl>

<hr>

Methods defined here:

<dl><dt><a name="TimeLine-DrawLine">DrawLine</a>(self, widget)</dt><dd><tt>    Draws the timeline and saves it to memory

- Must be called initially and to redraw the timeline

after moving the project start</tt></dd></dl>

<dl><dt><a name="TimeLine-DrawLine">DrawLine</a>(self, widget)</dt><dd><tt>Draws the timeline and saves it to memory

Must be called initially and to redraw the timeline

after moving the project start.

Parameters:

widget -- reserved for GTK callbacks, don't use it explicitly.</tt></dd></dl>

<dl><dt><a name="TimeLine-GetZoomFactor">GetZoomFactor</a>(self, viewScale)</dt><dd><tt>To be used for drawing the MODE_HOURS_MINS_SECS timeline

<dl><dt><a name="TimeLine-GetZoomFactor">GetZoomFactor</a>(self, viewScale)</dt><dd><tt>To be used for drawing the MODE_HOURS_MINS_SECS timeline.

Parameters:

viewScale -- the view scale in pixels per second.

Returns:

- an integer factor to be multiplied with the viewScale to zoom the timeline in/out

- a boolean indicating if milliseconds should be displayed

The default factor is 1000, meaning that the distance between the short lines of the timeline

symbolizes 1000 milliseconds. The code will increase of decrease this factor to keep the

timeline readable. The factors can be set with the zoomLevels array. This array

contains zoom levels that support precision from 20 ms to 1 minute. More extreme zoom

levels could be added, but will never be reached because the viewScale is limited.</tt></dd></dl>

The default factor is 1000, meaning that the distance between the short lines of the timeline

symbolizes 1000 milliseconds. The code will increase of decrease this factor to keep the

timeline readable. The factors can be set with the zoomLevels array. This array

contains zoom levels that support precision from 20 ms to 1 minute. More extreme zoom

levels could be added, but will never be reached because the viewScale is limited.</tt></dd></dl>

<dl><dt><a name="TimeLine-OnAllocate">OnAllocate</a>(self, widget, allocation)</dt><dd><tt>From:

<a href="http://www.moeraki.com/pygtkreference/pygtk2reference/class-gtkwidget.html#signal-gtkwidget--size-allocate">http://www.moeraki.com/pygtkreference/pygtk2reference/class-gtkwidget.html#signal-gtkwidget--size-allocate</a>

The "size-allocate" signal is emitted when widget is given a new space allocation.</tt></dd></dl>

<dl><dt><a name="TimeLine-OnDraw">OnDraw</a>(self, widget, event)</dt><dd><tt>Fires off the drawing operation.</tt></dd></dl>

<dl><dt><a name="TimeLine-OnStateChanged">OnStateChanged</a>(self, obj, change=None)</dt><dd><tt>Called when there is a change of state in transport

manager or project. Could be one of

*  Mode changed from bars/beats to minutes or vice versa

(requires a complete redraw of timeline - flag set)

*  Change in playing position -only needs partial redraw

*  Project change e.g. a scroll or zoom change

(requires a complete redraw of timeline - flag set)</tt></dd></dl>

100

<dl><dt><a name="TimeLine-__init__">__init__</a>(self, project, timelinebar, mainview)</dt><dd><tt>project - reference to the active project

101

timelinebar - reference of TimeLineBar (TimeLineBar.py)

102

mainview - reference to JokosherApp (JokosherApp.py) - Not used atm.</tt></dd></dl>

103

104

<dl><dt><a name="TimeLine-do_size_request">do_size_request</a>(self, requisition)</dt></dl>

105

106

<dl><dt><a name="TimeLine-moveHead">moveHead</a>(self, xpos)</dt><dd><tt>Changes the project position to the time matching xpos.</tt></dd></dl>

107

108

<dl><dt><a name="TimeLine-onMouseDown">onMouseDown</a>(self, widget, event)</dt></dl>

109

110

<dl><dt><a name="TimeLine-onMouseMove">onMouseMove</a>(self, widget, event)</dt></dl>

111

112

<dl><dt><a name="TimeLine-onMouseUp">onMouseUp</a>(self, widget, event)</dt></dl>

The "size-allocate" signal is emitted when widget is given a new space allocation.

100

101

Parameters:

102

widget -- reserved for GTK callbacks, don't use it explicitly.

103

allocation -- the position and size to be allocated to the widget.</tt></dd></dl>

104

105

<dl><dt><a name="TimeLine-OnDraw">OnDraw</a>(self, widget, event)</dt><dd><tt>Fires off the drawing operation.

106

107

Parameters:

108

widget -- reserved for GTK callbacks, don't use it explicitly.

109

event -- reserved for GTK callbacks, don't use it explicitly.</tt></dd></dl>

110

111

<dl><dt><a name="TimeLine-OnStateChanged">OnStateChanged</a>(self, obj, change=None, *extra)</dt><dd><tt>Called when there is a change of state in transport     manager or project.

112

Could be one of

113

*  Mode changed from bars/beats to minutes or vice versa

114

(requires a complete redraw of timeline - flag set)

115

*  Change in playing position -only needs partial redraw

116

*  Project change e.g. a scroll or zoom change

117

(requires a complete redraw of timeline - flag set)

118

119

Parameters:

120

obj -- an object to inform when this method is called.

121

change -- the change which has occured.

122

extra -- the extra parameters to be passed.</tt></dd></dl>

123

124

<dl><dt><a name="TimeLine-__init__">__init__</a>(self, project, timelinebar, mainview)</dt><dd><tt>Creates a new instance of <a href="#TimeLine">TimeLine</a>

125

126

Parameters:

127

project - reference to Project (Project.py)

128

timelinebar - reference of TimeLineBar (TimeLineBar.py)

129

mainview - reference to JokosherApp (JokosherApp.py) - Not used atm.</tt></dd></dl>

130

131

<dl><dt><a name="TimeLine-do_size_request">do_size_request</a>(self, requisition)</dt><dd><tt>From:

132

<a href="http://www.moeraki.com/pygtkreference/pygtk2reference/class-gtkwidget.html#signal-gtkwidget--size-request">http://www.moeraki.com/pygtkreference/pygtk2reference/class-gtkwidget.html#signal-gtkwidget--size-request</a>

133

The "size-request" signal is emitted when a new size is

134

requested for widget using the <a href="#TimeLine-set_size_request">set_size_request</a>() method.

135

136

Parameters:

137

requisition -- the widget's requested size as a gtk.Requisition.</tt></dd></dl>

138

139

<dl><dt><a name="TimeLine-moveHead">moveHead</a>(self, xpos)</dt><dd><tt>Changes the project position to the time matching xpos.

140

141

Parameters:

142

xpos -- the time of the new project position.</tt></dd></dl>

143

144

<dl><dt><a name="TimeLine-onMouseDown">onMouseDown</a>(self, widget, event)</dt><dd><tt>Called when a mouse button is clicked.

145

146

Parameters:

147

widget -- reserved for GTK callbacks, don't use it explicitly.

148

event -- reserved for GTK callbacks, don't use it explicitly.</tt></dd></dl>

149

150

<dl><dt><a name="TimeLine-onMouseMove">onMouseMove</a>(self, widget, event)</dt><dd><tt>Called when the mouse pointer has moved.

151

152

Parameters:

153

widget -- reserved for GTK callbacks, don't use it explicitly.

154

event -- reserved for GTK callbacks, don't use it explicitly.</tt></dd></dl>

155

156

<dl><dt><a name="TimeLine-onMouseUp">onMouseUp</a>(self, widget, event)</dt><dd><tt>Called when a mouse button is released.

157

158

Parameters:

159

widget -- reserved for GTK callbacks, don't use it explicitly.

160

event -- reserved for GTK callbacks, don't use it explicitly.</tt></dd></dl>

113

161

114

162

<hr>

115

163

Data and other attributes defined here:

116

<dl><dt>__gtype__ = <GType TimeLine (136951352)></dl>

164

<dl><dt>__gtype__ = <GType TimeLine (138065688)></dl>

117

165

118

166

<dl><dt>__gtype_name__ = 'TimeLine'</dl>

119

167

641

689

Data and other attributes inherited from <a href="gobject.html#GObject">gobject.GObject</a>:

642

690

643

691

644

<dl><dt>__gdoc__ = 'Object TimeLine\n\n\n\t\tThis class handles drawing t...ointer\n\nSignals from GObject:\n notify (GParam)\n\n'</dl>

692

<dl><dt>__gdoc__ = 'Object TimeLine\n\n\n\tThis class handles drawing th...ointer\n\nSignals from GObject:\n notify (GParam)\n\n'</dl>

645

693

646

694

<dl><dt>__grefcount__ = <attribute '__grefcount__' of 'gobject.GObject' objects></dl>

647

695

Older »