~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed

<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.gdk.PixbufAnimationIter</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gdk-class-reference.html" title="The gtk.gdk Class Reference"><link rel="prev" href="class-gdkpixbufanimation.html" title="gtk.gdk.PixbufAnimation"><link rel="next" href="class-gdkpixbufloader.html" title="gtk.gdk.PixbufLoader"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.gdk.PixbufAnimationIter</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gdkpixbufanimation.html">Prev</a> </td><th width="60%" align="center">The gtk.gdk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gdkpixbufloader.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gdkpixbufanimationiter"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.gdk.PixbufAnimationIter</h2><p>gtk.gdk.PixbufAnimationIter — an object providing access to the frames of a <a class="link" href="class-gdkpixbufanimation.html" title="gtk.gdk.PixbufAnimation"><code class="classname">gtk.gdk.PixbufAnimation</code></a></p></div><div class="refsect1" lang="en"><a name="id2993904"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.PixbufAnimationIter</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):

<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimationiter.html#method-gdkpixbufanimationiter--get-delay-time" title="gtk.gdk.PixbufAnimationIter.get_delay_time">get_delay_time</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimationiter.html#method-gdkpixbufanimationiter--get-pixbuf" title="gtk.gdk.PixbufAnimationIter.get_pixbuf">get_pixbuf</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimationiter.html#method-gdkpixbufanimationiter--on-currently-loading-frame" title="gtk.gdk.PixbufAnimationIter.on_currently_loading_frame">on_currently_loading_frame</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimationiter.html#method-gdkpixbufanimationiter--advance" title="gtk.gdk.PixbufAnimationIter.advance">advance</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>current_time</code></strong></span><span class="initializer">=0.0</span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id2994024"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>

<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.gdk.PixbufAnimationIter</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gdk-class-reference.html" title="The gtk.gdk Class Reference"><link rel="prev" href="class-gdkpixbufanimation.html" title="gtk.gdk.PixbufAnimation"><link rel="next" href="class-gdkpixbufloader.html" title="gtk.gdk.PixbufLoader"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.gdk.PixbufAnimationIter</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gdkpixbufanimation.html">Prev</a> </td><th width="60%" align="center">The gtk.gdk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gdkpixbufloader.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.gdk.PixbufAnimationIter"><a name="class-gdkpixbufanimationiter"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.gdk.PixbufAnimationIter</h2><p>gtk.gdk.PixbufAnimationIter — an object providing access to the frames of a <a class="link" href="class-gdkpixbufanimation.html" title="gtk.gdk.PixbufAnimation"><code class="classname">gtk.gdk.PixbufAnimation</code></a></p></div><div class="refsect1" title="Synopsis"><a name="id3583705"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.PixbufAnimationIter</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):

<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimationiter.html#method-gdkpixbufanimationiter--get-delay-time" title="gtk.gdk.PixbufAnimationIter.get_delay_time">get_delay_time</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimationiter.html#method-gdkpixbufanimationiter--get-pixbuf" title="gtk.gdk.PixbufAnimationIter.get_pixbuf">get_pixbuf</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimationiter.html#method-gdkpixbufanimationiter--on-currently-loading-frame" title="gtk.gdk.PixbufAnimationIter.on_currently_loading_frame">on_currently_loading_frame</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimationiter.html#method-gdkpixbufanimationiter--advance" title="gtk.gdk.PixbufAnimationIter.advance">advance</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>current_time</code></strong></span><span class="initializer">=0.0</span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3583825"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>

+-- <a class="link" href="class-gdkpixbufanimationiter.html" title="gtk.gdk.PixbufAnimationIter">gtk.gdk.PixbufAnimationIter</a>

</pre></div><div class="refsect1" lang="en"><a name="id2994049"></a><h2>Description</h2><p>A <a class="link" href="class-gdkpixbufanimationiter.html" title="gtk.gdk.PixbufAnimationIter"><code class="classname">gtk.gdk.PixbufAnimationIter</code></a>

</pre></div><div class="refsect1" title="Description"><a name="id3583851"></a><h2>Description</h2><p>A <a class="link" href="class-gdkpixbufanimationiter.html" title="gtk.gdk.PixbufAnimationIter"><code class="classname">gtk.gdk.PixbufAnimationIter</code></a>

is used to access the frames of a <a class="link" href="class-gdkpixbufanimation.html" title="gtk.gdk.PixbufAnimation"><code class="classname">gtk.gdk.PixbufAnimation</code></a>

at specified times. A <a class="link" href="class-gdkpixbufanimationiter.html" title="gtk.gdk.PixbufAnimationIter"><code class="classname">gtk.gdk.PixbufAnimationIter</code></a>

object is created using the <a class="link" href="class-gdkpixbufanimation.html#method-gdkpixbufanimation--get-iter" title="gtk.gdk.PixbufAnimation.get_iter"><code class="methodname">gtk.gdk.PixbufAnimation.get_iter</code>()</a>

signal, for example if the delay time for a frame is encoded in the data

after the frame itself. So your timeout should be reinstalled after any

area_updated signal. A delay time of -1 is possible, indicating

"infinite."</p></div><div class="refsect1" lang="en"><a name="id2994175"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gdkpixbufanimationiter--get-delay-time"></a><h3>gtk.gdk.PixbufAnimationIter.get_delay_time</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_delay_time</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the delay time in milliseconds (thousandths of

"infinite."</p></div><div class="refsect1" title="Methods"><a name="id3583976"></a><h2>Methods</h2><div class="refsect2" title="gtk.gdk.PixbufAnimationIter.get_delay_time"><a name="method-gdkpixbufanimationiter--get-delay-time"></a><h3>gtk.gdk.PixbufAnimationIter.get_delay_time</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_delay_time</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the delay time in milliseconds (thousandths of

a second)</td></tr></tbody></table><p>The <code class="methodname">get_delay_time</code>() method returns the

number of milliseconds the current pixbuf should be displayed, or -1 if the

current pixbuf should be displayed forever. The <PYGTKDOCLINK HREF="function-gobject--timeout-add"><code class="methodname">gobject.timeout_add</code>()</PYGTKDOCLINK>()

function conveniently takes a timeout in milliseconds, so you can use a

timeout to schedule the next update.</p></div><div class="refsect2" lang="en"><a name="method-gdkpixbufanimationiter--get-pixbuf"></a><h3>gtk.gdk.PixbufAnimationIter.get_pixbuf</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_pixbuf</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the current <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a> to be

timeout to schedule the next update.</p></div><div class="refsect2" title="gtk.gdk.PixbufAnimationIter.get_pixbuf"><a name="method-gdkpixbufanimationiter--get-pixbuf"></a><h3>gtk.gdk.PixbufAnimationIter.get_pixbuf</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_pixbuf</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the current <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a> to be

displayed</td></tr></tbody></table><p>The <code class="methodname">get_pixbuf</code>() method returns the

current <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a> that

should be displayed. The pixbuf will be the same size as the animation

and <a class="link" href="class-gdkpixbufanimation.html#method-gdkpixbufanimation--get-height" title="gtk.gdk.PixbufAnimation.get_height"><code class="methodname">gtk.gdk.PixbufAnimation.get_height</code>()</a>

methods). The <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>

should be displayed for the number of milliseconds specified by the <a class="link" href="class-gdkpixbufanimationiter.html#method-gdkpixbufanimationiter--get-delay-time" title="gtk.gdk.PixbufAnimationIter.get_delay_time"><code class="methodname">get_delay_time</code>()</a>

method.</p></div><div class="refsect2" lang="en"><a name="method-gdkpixbufanimationiter--on-currently-loading-frame"></a><h3>gtk.gdk.PixbufAnimationIter.on_currently_loading_frame</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">on_currently_loading_frame</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the frame we're on

method.</p></div><div class="refsect2" title="gtk.gdk.PixbufAnimationIter.on_currently_loading_frame"><a name="method-gdkpixbufanimationiter--on-currently-loading-frame"></a><h3>gtk.gdk.PixbufAnimationIter.on_currently_loading_frame</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">on_currently_loading_frame</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the frame we're on

is partially loaded, or the last frame</td></tr></tbody></table><p>The <code class="methodname">on_currently_loading_frame</code>() method

returns <code class="literal">True</code> if the frame currently pointed to by the

iterator is partially loaded or the last frame. This method is used to

when loading an animation. The "area_updated" signal is emitted for an area

of the frame currently streaming in to the loader. So if you're on the

currently loading frame, you need to redraw the screen for the updated

area.</p></div><div class="refsect2" lang="en"><a name="method-gdkpixbufanimationiter--advance"></a><h3>gtk.gdk.PixbufAnimationIter.advance</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">advance</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>current_time</code></strong></span><span class="initializer">=0.0</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>current_time</code></strong> :</span></p></td><td>the current time as a float or 0.0 to

area.</p></div><div class="refsect2" title="gtk.gdk.PixbufAnimationIter.advance"><a name="method-gdkpixbufanimationiter--advance"></a><h3>gtk.gdk.PixbufAnimationIter.advance</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">advance</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>current_time</code></strong></span><span class="initializer">=0.0</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>current_time</code></strong> :</span></p></td><td>the current time as a float or 0.0 to

automatically determine the current time</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the image may need

updating</td></tr></tbody></table><p>The <code class="methodname">advance</code>() method attempts to

advance an animation to a new frame. The frame is chosen based on the start

Older »