1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.gdk.PixbufAnimation</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-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><link rel="next" href="class-gdkpixbufanimationiter.html" title="gtk.gdk.PixbufAnimationIter"></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.PixbufAnimation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gdkpixbuf.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-gdkpixbufanimationiter.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gdkpixbufanimation"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.gdk.PixbufAnimation</h2><p>gtk.gdk.PixbufAnimation — an object holding an animation</p></div><div class="refsect1" lang="en"><a name="id2993080"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.PixbufAnimation</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
2
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gdkpixbufanimation.html#constructor-gdkpixbufanimation" title="Constructor">gtk.gdk.PixbufAnimation</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimation.html#method-gdkpixbufanimation--get-width" title="gtk.gdk.PixbufAnimation.get_width">get_width</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimation.html#method-gdkpixbufanimation--get-height" title="gtk.gdk.PixbufAnimation.get_height">get_height</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimation.html#method-gdkpixbufanimation--is-static-image" title="gtk.gdk.PixbufAnimation.is_static_image">is_static_image</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimation.html#method-gdkpixbufanimation--get-static-image" title="gtk.gdk.PixbufAnimation.get_static_image">get_static_image</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimation.html#method-gdkpixbufanimation--get-iter" title="gtk.gdk.PixbufAnimation.get_iter">get_iter</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_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="id2993245"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.gdk.PixbufAnimation</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-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><link rel="next" href="class-gdkpixbufanimationiter.html" title="gtk.gdk.PixbufAnimationIter"></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.PixbufAnimation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gdkpixbuf.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-gdkpixbufanimationiter.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.gdk.PixbufAnimation"><a name="class-gdkpixbufanimation"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.gdk.PixbufAnimation</h2><p>gtk.gdk.PixbufAnimation — an object holding an animation</p></div><div class="refsect1" title="Synopsis"><a name="id3582879"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.PixbufAnimation</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
2
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gdkpixbufanimation.html#constructor-gdkpixbufanimation" title="Constructor">gtk.gdk.PixbufAnimation</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimation.html#method-gdkpixbufanimation--get-width" title="gtk.gdk.PixbufAnimation.get_width">get_width</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimation.html#method-gdkpixbufanimation--get-height" title="gtk.gdk.PixbufAnimation.get_height">get_height</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimation.html#method-gdkpixbufanimation--is-static-image" title="gtk.gdk.PixbufAnimation.is_static_image">is_static_image</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimation.html#method-gdkpixbufanimation--get-static-image" title="gtk.gdk.PixbufAnimation.get_static_image">get_static_image</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkpixbufanimation.html#method-gdkpixbufanimation--get-iter" title="gtk.gdk.PixbufAnimation.get_iter">get_iter</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_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="id3583044"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
3
3
+-- <a class="link" href="class-gdkpixbufanimation.html" title="gtk.gdk.PixbufAnimation">gtk.gdk.PixbufAnimation</a>
4
</pre></div><div class="refsect1" lang="en"><a name="id2993270"></a><h2>Description</h2><p>A <a class="link" href="class-gdkpixbufanimation.html" title="gtk.gdk.PixbufAnimation"><code class="classname">gtk.gdk.PixbufAnimation</code></a>
4
</pre></div><div class="refsect1" title="Description"><a name="id3583069"></a><h2>Description</h2><p>A <a class="link" href="class-gdkpixbufanimation.html" title="gtk.gdk.PixbufAnimation"><code class="classname">gtk.gdk.PixbufAnimation</code></a>
5
5
is an object that holds an animation. An animation is conceptually a series
6
6
of frames to be displayed over time. Each frame is the same size. The
7
7
animation may not be represented as a series of frames internally; for
8
8
example, it may be stored as a sprite and instructions for moving the sprite
9
9
around a background. To display an animation you don't need to understand
10
10
its representation, you just ask a <a class="link" href="class-gdkpixbufanimationiter.html" title="gtk.gdk.PixbufAnimationIter"><code class="classname">gtk.gdk.PixbufAnimationIter</code></a>
11
for the next frame that should be displayed at a given point in time.</p></div><div class="refsect1" lang="en"><a name="constructor-gdkpixbufanimation"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.gdk.PixbufAnimation</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</code></strong></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>filename</code></strong> :</span></p></td><td>the name of the file to
11
for the next frame that should be displayed at a given point in time.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gdkpixbufanimation"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.gdk.PixbufAnimation</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</code></strong></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>filename</code></strong> :</span></p></td><td>the name of the file to
12
12
load.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gdkpixbufanimation.html" title="gtk.gdk.PixbufAnimation"><code class="classname">gtk.gdk.PixbufAnimation</code></a>
13
13
object.</td></tr></tbody></table><p>Creates a new <a class="link" href="class-gdkpixbufanimation.html" title="gtk.gdk.PixbufAnimation"><code class="classname">gtk.gdk.PixbufAnimation</code></a>
14
14
by loading it from a file. The file format is detected automatically. If the
16
16
single frame will be created.</p><p>This constructor raises the GError exception if any of several
17
17
error conditions occurred: the file could not be opened, there was no loader
18
18
for the file's format, there was not enough memory to allocate the image
19
buffer, or the image file contained invalid data.</p></div><div class="refsect1" lang="en"><a name="id2993404"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gdkpixbufanimation--get-width"></a><h3>gtk.gdk.PixbufAnimation.get_width</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_width</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 width of the bounding box of the
19
buffer, or the image file contained invalid data.</p></div><div class="refsect1" title="Methods"><a name="id3583203"></a><h2>Methods</h2><div class="refsect2" title="gtk.gdk.PixbufAnimation.get_width"><a name="method-gdkpixbufanimation--get-width"></a><h3>gtk.gdk.PixbufAnimation.get_width</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_width</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 width of the bounding box of the
20
20
animation.</td></tr></tbody></table><p>The <code class="methodname">get_width</code>() method returns the
21
width of the bounding box of a pixbuf animation.</p></div><div class="refsect2" lang="en"><a name="method-gdkpixbufanimation--get-height"></a><h3>gtk.gdk.PixbufAnimation.get_height</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_height</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 height of the bounding box of the
21
width of the bounding box of a pixbuf animation.</p></div><div class="refsect2" title="gtk.gdk.PixbufAnimation.get_height"><a name="method-gdkpixbufanimation--get-height"></a><h3>gtk.gdk.PixbufAnimation.get_height</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_height</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 height of the bounding box of the
22
22
animation.</td></tr></tbody></table><p>The <code class="methodname">get_height</code>() method returns the
23
height of the bounding box of a pixbuf animation.</p></div><div class="refsect2" lang="en"><a name="method-gdkpixbufanimation--is-static-image"></a><h3>gtk.gdk.PixbufAnimation.is_static_image</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">is_static_image</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 "animation" was
23
height of the bounding box of a pixbuf animation.</p></div><div class="refsect2" title="gtk.gdk.PixbufAnimation.is_static_image"><a name="method-gdkpixbufanimation--is-static-image"></a><h3>gtk.gdk.PixbufAnimation.is_static_image</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">is_static_image</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 "animation" was
24
24
really just an image</td></tr></tbody></table><p>The <code class="methodname">is_static_image</code>() method returns
25
25
True if you load a file containing a plain, unanimated image. Use the <a class="link" href="class-gdkpixbufanimation.html#method-gdkpixbufanimation--get-static-image" title="gtk.gdk.PixbufAnimation.get_static_image"><code class="methodname">get_static_image</code>()</a>
26
method to retrieve the image.</p></div><div class="refsect2" lang="en"><a name="method-gdkpixbufanimation--get-static-image"></a><h3>gtk.gdk.PixbufAnimation.get_static_image</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_static_image</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 unanimated image representing the
26
method to retrieve the image.</p></div><div class="refsect2" title="gtk.gdk.PixbufAnimation.get_static_image"><a name="method-gdkpixbufanimation--get-static-image"></a><h3>gtk.gdk.PixbufAnimation.get_static_image</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_static_image</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 unanimated image representing the
27
27
animation</td></tr></tbody></table><p>The <code class="methodname">get_static_image</code>() method returns a
28
28
<a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>
29
29
that represents a static image of the animation. If the animation is really
31
31
the animation is an animation, this method returns a reasonable thing to
32
32
display as a static unanimated image, which might be the first frame, or
33
33
something more sophisticated. If an animation hasn't loaded any frames yet,
34
this method will return <code class="literal">None</code>.</p></div><div class="refsect2" lang="en"><a name="method-gdkpixbufanimation--get-iter"></a><h3>gtk.gdk.PixbufAnimation.get_iter</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_iter</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_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>start_time</code></strong> :</span></p></td><td>the time when the animation starts
34
this method will return <code class="literal">None</code>.</p></div><div class="refsect2" title="gtk.gdk.PixbufAnimation.get_iter"><a name="method-gdkpixbufanimation--get-iter"></a><h3>gtk.gdk.PixbufAnimation.get_iter</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_iter</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_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>start_time</code></strong> :</span></p></td><td>the time when the animation starts
35
35
playing</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gdkpixbufanimationiter.html" title="gtk.gdk.PixbufAnimationIter"><code class="classname">gtk.gdk.PixbufAnimationIter</code></a>
36
36
object</td></tr></tbody></table><p>The <code class="methodname">get_iter</code>() method returns a <a class="link" href="class-gdkpixbufanimationiter.html" title="gtk.gdk.PixbufAnimationIter"><code class="classname">gtk.gdk.PixbufAnimationIter</code></a>
37
37
that is used to access the frames of the animation. The iterator provides
added
removed
docs/html/class-gdkpixbufanimation.html
