File: classGdk_1_1PixbufAnimationIter.html

package info (click to toggle)
gtkmm2.4 1%3A2.20.3-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 73,860 kB
  • ctags: 20,553
  • sloc: xml: 79,575; sh: 10,120; cpp: 8,347; makefile: 290
file content (345 lines) | stat: -rw-r--r-- 26,336 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>gtkmm: Gdk::PixbufAnimationIter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceGdk.html">Gdk</a>::<a class="el" href="classGdk_1_1PixbufAnimationIter.html">PixbufAnimationIter</a>
  </div>
</div>
<div class="contents">
<h1>Gdk::PixbufAnimationIter Class Reference</h1><!-- doxytag: class="Gdk::PixbufAnimationIter" --><!-- doxytag: inherits="Glib::Object" -->
<p>An iterator which points to a certain position in a <a class="el" href="classGdk_1_1PixbufAnimation.html" title="The gdk-pixbuf library provides a simple mechanism to load and represent animations...">PixbufAnimation</a>. <a href="#_details">More...</a></p>

<p>Inherits <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Object.html">Glib::Object</a>.</p>
<div class="dynheader">
Collaboration diagram for Gdk::PixbufAnimationIter:</div>
<div class="dynsection">
<div class="center"><img src="classGdk_1_1PixbufAnimationIter__coll__graph.png" border="0" usemap="#Gdk_1_1PixbufAnimationIter_coll__map" alt="Collaboration graph"/></div>
<map name="Gdk_1_1PixbufAnimationIter_coll__map" id="Gdk_1_1PixbufAnimationIter_coll__map">
<area shape="rect" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="44,160,135,189"/><area shape="rect" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="29,83,149,112"/><area shape="rect" doxygen="libsigc++-2.0.tag:http://library.gnome.org/devel/libsigc++/unstable/" href="http://library.gnome.org/devel/libsigc++/unstable/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="36,5,143,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classGdk_1_1PixbufAnimationIter-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1PixbufAnimationIter.html#abb04812c40c3cde3adae527f91e992b4">~PixbufAnimationIter</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GdkPixbufAnimationIter*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1PixbufAnimationIter.html#a5aac29041dd100a119b8aa703dbafe3f">gobj</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a5aac29041dd100a119b8aa703dbafe3f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GdkPixbufAnimationIter*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1PixbufAnimationIter.html#a8d6407acb0d49bc5ff6ed415d93b536b">gobj</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a8d6407acb0d49bc5ff6ed415d93b536b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GdkPixbufAnimationIter*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1PixbufAnimationIter.html#ae2e23368fa026c6deeaacd4168074a44">gobj_copy</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#ae2e23368fa026c6deeaacd4168074a44"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1PixbufAnimationIter.html#a59be27954e4c177236c5bebfa6c84602">get_delay_time</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the number of milliseconds the current pixbuf should be displayed, or -1 if the current pixbuf should be displayed forever. <a href="#a59be27954e4c177236c5bebfa6c84602"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1PixbufAnimationIter.html#a66d583297b87ac3f2b1424526afe962c">get_pixbuf</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current pixbuf which should be displayed; the pixbuf will be the same size as the animation itself (<a class="el" href="classGdk_1_1Pixbuf.html#aa465be4bf65b9fedf471848c21bfab98">Gdk::Pixbuf::get_width()</a>, <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>:get_height()). <a href="#a66d583297b87ac3f2b1424526afe962c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; const <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1PixbufAnimationIter.html#a2b0c8610e86dd96f49425d48396797be">get_pixbuf</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current pixbuf which should be displayed; the pixbuf will be the same size as the animation itself (<a class="el" href="classGdk_1_1Pixbuf.html#aa465be4bf65b9fedf471848c21bfab98">Gdk::Pixbuf::get_width()</a>, <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>:get_height()). <a href="#a2b0c8610e86dd96f49425d48396797be"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1PixbufAnimationIter.html#ad50a6088b03fb35fe65dea11debecd84">on_currently_loading_frame</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Used to determine how to respond to the area_updated signal on <a class="el" href="classGdk_1_1PixbufLoader.html">Gdk::PixbufLoader</a> when loading an animation. <a href="#ad50a6088b03fb35fe65dea11debecd84"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1PixbufAnimationIter.html#ac4f9496b9197f968656760fa16218f25">advance</a> (const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/structGlib_1_1TimeVal.html">Glib::TimeVal</a>&amp; current_time)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Possibly advances an animation to a new frame. <a href="#ac4f9496b9197f968656760fa16218f25"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1PixbufAnimationIter.html#a1bd10ac0d757e79e1d0e4fda7778d0a0">advance</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Possibly advances an animation to a new frame. <a href="#a1bd10ac0d757e79e1d0e4fda7778d0a0"></a><br/></td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a><br class="typebreak"/>
&lt; <a class="el" href="classGdk_1_1PixbufAnimationIter.html">Gdk::PixbufAnimationIter</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1PixbufAnimationIter.html#a0c68bd7a2e248042af42c41d2aa11016">wrap</a> (GdkPixbufAnimationIter* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a0c68bd7a2e248042af42c41d2aa11016"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An iterator which points to a certain position in a <a class="el" href="classGdk_1_1PixbufAnimation.html" title="The gdk-pixbuf library provides a simple mechanism to load and represent animations...">PixbufAnimation</a>. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="abb04812c40c3cde3adae527f91e992b4"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::~PixbufAnimationIter" ref="abb04812c40c3cde3adae527f91e992b4" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual Gdk::PixbufAnimationIter::~PixbufAnimationIter </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1bd10ac0d757e79e1d0e4fda7778d0a0"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::advance" ref="a1bd10ac0d757e79e1d0e4fda7778d0a0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Gdk::PixbufAnimationIter::advance </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Possibly advances an animation to a new frame. </p>
<p>Chooses the frame based on the start time passed to <a class="el" href="classGdk_1_1PixbufAnimation.html#a7ad528dcc330239499e0c0f6010905b7">Gdk::PixbufAnimation::get_iter()</a>.</p>
<p>If this function returns false, there's no need to update the animation display, assuming the display had been rendered prior to advancing; if true, you need to call <a class="el" href="classGdk_1_1PixbufAnimationIter.html#a66d583297b87ac3f2b1424526afe962c" title="Gets the current pixbuf which should be displayed; the pixbuf will be the same size...">get_pixbuf()</a> and update the display with the new pixbuf.</p>
<dl class="since_2_14"><dt><b><a class="el" href="since_2_14.html#_since_2_14000007">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the image may need updating. </dd></dl>

</div>
</div>
<a class="anchor" id="ac4f9496b9197f968656760fa16218f25"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::advance" ref="ac4f9496b9197f968656760fa16218f25" args="(const Glib::TimeVal &amp;current_time)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Gdk::PixbufAnimationIter::advance </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/structGlib_1_1TimeVal.html">Glib::TimeVal</a> &amp;&#160;</td>
          <td class="paramname"> <em>current_time</em></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Possibly advances an animation to a new frame. </p>
<p>Chooses the frame based on the start time passed to <a class="el" href="classGdk_1_1PixbufAnimation.html#a7ad528dcc330239499e0c0f6010905b7">Gdk::PixbufAnimation::get_iter()</a>.</p>
<p><em>current_time</em> would normally come from Glib::get_current_time(), and must be greater than or equal to the time passed to <a class="el" href="classGdk_1_1PixbufAnimation.html#a7ad528dcc330239499e0c0f6010905b7">Gdk::PixbufAnimation::get_iter()</a>, and must increase or remain unchanged each time <a class="el" href="classGdk_1_1PixbufAnimationIter.html#a66d583297b87ac3f2b1424526afe962c" title="Gets the current pixbuf which should be displayed; the pixbuf will be the same size...">get_pixbuf()</a> is called. That is, you can't go backward in time; animations only play forward.</p>
<p>If using the method overload that takes no current_time parameter then the current time will be used. So you only need to explicitly pass <em>current_time</em> if you're doing something odd like playing the animation at double speed.</p>
<p>If this function returns <code>false</code>, there's no need to update the animation display, assuming the display had been rendered prior to advancing; if <code>true</code>, you need to call <a class="el" href="classGdk_1_1PixbufAnimationIter.html#a66d583297b87ac3f2b1424526afe962c" title="Gets the current pixbuf which should be displayed; the pixbuf will be the same size...">get_pixbuf()</a> and update the display with the new pixbuf.</p>
<dl class="since_2_14"><dt><b><a class="el" href="since_2_14.html#_since_2_14000006">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>current_time</em>&#160;</td><td>Current time. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the image may need updating. </dd></dl>

</div>
</div>
<a class="anchor" id="a59be27954e4c177236c5bebfa6c84602"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::get_delay_time" ref="a59be27954e4c177236c5bebfa6c84602" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Gdk::PixbufAnimationIter::get_delay_time </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gets the number of milliseconds the current pixbuf should be displayed, or -1 if the current pixbuf should be displayed forever. </p>
<p>Glib::signal_timeout.connect() conveniently takes a timeout in milliseconds, so you can use a timeout to schedule the next update.</p>
<dl class="since_2_14"><dt><b><a class="el" href="since_2_14.html#_since_2_14000002">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Delay time in milliseconds (thousandths of a second). </dd></dl>

</div>
</div>
<a class="anchor" id="a2b0c8610e86dd96f49425d48396797be"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::get_pixbuf" ref="a2b0c8610e86dd96f49425d48396797be" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;const <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>&gt; Gdk::PixbufAnimationIter::get_pixbuf </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gets the current pixbuf which should be displayed; the pixbuf will be the same size as the animation itself (<a class="el" href="classGdk_1_1Pixbuf.html#aa465be4bf65b9fedf471848c21bfab98">Gdk::Pixbuf::get_width()</a>, <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>:get_height()). </p>
<p>This pixbuf should be displayed for <a class="el" href="classGdk_1_1PixbufAnimationIter.html#a59be27954e4c177236c5bebfa6c84602" title="Gets the number of milliseconds the current pixbuf should be displayed, or -1 if...">get_delay_time()</a> milliseconds. The returned pixbuf will become invalid when the iterator advances to the next frame, which may happen anytime you call <a class="el" href="classGdk_1_1PixbufAnimationIter.html#a1bd10ac0d757e79e1d0e4fda7778d0a0" title="Possibly advances an animation to a new frame.">advance()</a>. Copy the pixbuf to keep it, with <a class="el" href="classGdk_1_1Pixbuf.html#aa29db4f8d4410dc74916b53d231a1fbd">Gdk::Pixbuf::copy()</a> as it may get recycled as you advance the iterator.</p>
<dl class="since_2_14"><dt><b><a class="el" href="since_2_14.html#_since_2_14000004">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The pixbuf to be displayed. </dd></dl>

</div>
</div>
<a class="anchor" id="a66d583297b87ac3f2b1424526afe962c"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::get_pixbuf" ref="a66d583297b87ac3f2b1424526afe962c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>&gt; Gdk::PixbufAnimationIter::get_pixbuf </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gets the current pixbuf which should be displayed; the pixbuf will be the same size as the animation itself (<a class="el" href="classGdk_1_1Pixbuf.html#aa465be4bf65b9fedf471848c21bfab98">Gdk::Pixbuf::get_width()</a>, <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>:get_height()). </p>
<p>This pixbuf should be displayed for <a class="el" href="classGdk_1_1PixbufAnimationIter.html#a59be27954e4c177236c5bebfa6c84602" title="Gets the number of milliseconds the current pixbuf should be displayed, or -1 if...">get_delay_time()</a> milliseconds. The returned pixbuf will become invalid when the iterator advances to the next frame, which may happen anytime you call <a class="el" href="classGdk_1_1PixbufAnimationIter.html#a1bd10ac0d757e79e1d0e4fda7778d0a0" title="Possibly advances an animation to a new frame.">advance()</a>. Copy the pixbuf to keep it, with <a class="el" href="classGdk_1_1Pixbuf.html#aa29db4f8d4410dc74916b53d231a1fbd">Gdk::Pixbuf::copy()</a> as it may get recycled as you advance the iterator.</p>
<dl class="since_2_14"><dt><b><a class="el" href="since_2_14.html#_since_2_14000003">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The pixbuf to be displayed. </dd></dl>

</div>
</div>
<a class="anchor" id="a8d6407acb0d49bc5ff6ed415d93b536b"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::gobj" ref="a8d6407acb0d49bc5ff6ed415d93b536b" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const GdkPixbufAnimationIter* Gdk::PixbufAnimationIter::gobj </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provides access to the underlying C GObject. </p>

<p>Reimplemented from <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html#a778a94181132976bbfb0519793f3b32e">Glib::ObjectBase</a>.</p>

</div>
</div>
<a class="anchor" id="a5aac29041dd100a119b8aa703dbafe3f"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::gobj" ref="a5aac29041dd100a119b8aa703dbafe3f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GdkPixbufAnimationIter* Gdk::PixbufAnimationIter::gobj </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provides access to the underlying C GObject. </p>

<p>Reimplemented from <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html#a4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.</p>

</div>
</div>
<a class="anchor" id="ae2e23368fa026c6deeaacd4168074a44"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::gobj_copy" ref="ae2e23368fa026c6deeaacd4168074a44" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GdkPixbufAnimationIter* Gdk::PixbufAnimationIter::gobj_copy </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p>

</div>
</div>
<a class="anchor" id="ad50a6088b03fb35fe65dea11debecd84"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::on_currently_loading_frame" ref="ad50a6088b03fb35fe65dea11debecd84" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Gdk::PixbufAnimationIter::on_currently_loading_frame </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Used to determine how to respond to the area_updated signal on <a class="el" href="classGdk_1_1PixbufLoader.html">Gdk::PixbufLoader</a> when loading an animation. </p>
<p>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>
<dl class="since_2_14"><dt><b><a class="el" href="since_2_14.html#_since_2_14000005">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the frame we're on is partially loaded, or the last frame. </dd></dl>

</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a0c68bd7a2e248042af42c41d2aa11016"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::wrap" ref="a0c68bd7a2e248042af42c41d2aa11016" args="(GdkPixbufAnimationIter *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGdk_1_1PixbufAnimationIter.html">Gdk::PixbufAnimationIter</a> &gt; wrap </td>
          <td>(</td>
          <td class="paramtype">GdkPixbufAnimationIter *&#160;</td>
          <td class="paramname"> <em>object</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"> <em>take_copy</em> = <code>false</code></td><td>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>object</em>&#160;</td><td>The C instance. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>take_copy</em>&#160;</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>gdkmm/pixbufanimationiter.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:21:44 2010 for gtkmm by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>