~inkscape.dev/inkscape-devlibs/devlibs-gtk3

« back to all changes in this revision

Viewing changes to share/doc/gtkmm-2.4/reference/html/classGdk_1_1PixbufAnimationIter.html

  • Committer: JazzyNico
  • Date: 2013-01-21 10:11:05 UTC
  • Revision ID: nicoduf@yahoo.fr-20130121101105-i8d8slkq9ng4olx8
Adding gtk2 libraries.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<title>gtkmm: Gdk::PixbufAnimationIter Class Reference</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.7.3 -->
 
11
<div id="top">
 
12
<div id="titlearea">
 
13
<table cellspacing="0" cellpadding="0">
 
14
 <tbody>
 
15
 <tr style="height: 56px;">
 
16
  <td style="padding-left: 0.5em;">
 
17
   <div id="projectname">gtkmm&#160;<span id="projectnumber">2.24.2</span></div>
 
18
  </td>
 
19
 </tr>
 
20
 </tbody>
 
21
</table>
 
22
</div>
 
23
  <div id="navrow1" class="tabs">
 
24
    <ul class="tablist">
 
25
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
 
26
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
 
27
      <li><a href="modules.html"><span>Modules</span></a></li>
 
28
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
 
29
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
30
    </ul>
 
31
  </div>
 
32
  <div id="navrow2" class="tabs2">
 
33
    <ul class="tablist">
 
34
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
 
35
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
 
36
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
 
37
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
 
38
    </ul>
 
39
  </div>
 
40
  <div id="nav-path" class="navpath">
 
41
    <ul>
 
42
      <li class="navelem"><a class="el" href="namespaceGdk.html">Gdk</a> </li>
 
43
      <li class="navelem"><a class="el" href="classGdk_1_1PixbufAnimationIter.html">PixbufAnimationIter</a> </li>
 
44
    </ul>
 
45
  </div>
 
46
</div>
 
47
<div class="header">
 
48
  <div class="summary">
 
49
<a href="#pub-methods">Public Member Functions</a> &#124;
 
50
<a href="#related">Related Functions</a> </div>
 
51
  <div class="headertitle">
 
52
<h1>Gdk::PixbufAnimationIter Class Reference</h1> </div>
 
53
</div>
 
54
<div class="contents">
 
55
<!-- doxytag: class="Gdk::PixbufAnimationIter" --><!-- doxytag: inherits="Glib::Object" -->
 
56
<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>
 
57
<div class="dynheader">
 
58
Inheritance diagram for Gdk::PixbufAnimationIter:</div>
 
59
<div class="dyncontent">
 
60
<div class="center"><img src="classGdk_1_1PixbufAnimationIter__inherit__graph.png" border="0" usemap="#Gdk_1_1PixbufAnimationIter_inherit__map" alt="Inheritance graph"/></div>
 
61
<map name="Gdk_1_1PixbufAnimationIter_inherit__map" id="Gdk_1_1PixbufAnimationIter_inherit__map">
 
62
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="44,166,135,197"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="29,86,149,117"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="36,6,143,37"/></map>
 
63
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
 
64
<div class="dynheader">
 
65
Collaboration diagram for Gdk::PixbufAnimationIter:</div>
 
66
<div class="dyncontent">
 
67
<div class="center"><img src="classGdk_1_1PixbufAnimationIter__coll__graph.png" border="0" usemap="#Gdk_1_1PixbufAnimationIter_coll__map" alt="Collaboration graph"/></div>
 
68
<map name="Gdk_1_1PixbufAnimationIter_coll__map" id="Gdk_1_1PixbufAnimationIter_coll__map">
 
69
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="44,166,135,197"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="29,86,149,117"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="36,6,143,37"/></map>
 
70
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
 
71
 
 
72
<p><a href="classGdk_1_1PixbufAnimationIter-members.html">List of all members.</a></p>
 
73
<table class="memberdecls">
 
74
<tr><td colspan="2"><h2><a name="pub-methods"></a>
 
75
Public Member Functions</h2></td></tr>
 
76
<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>
 
77
<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>
 
78
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a5aac29041dd100a119b8aa703dbafe3f"></a><br/></td></tr>
 
79
<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>
 
80
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a8d6407acb0d49bc5ff6ed415d93b536b"></a><br/></td></tr>
 
81
<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>
 
82
<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>
 
83
<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>
 
84
<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>
 
85
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/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>
 
86
<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>
 
87
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/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>
 
88
<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>
 
89
<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>
 
90
<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>
 
91
<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" href="../../../glibmm-2.4/reference/html/structGlib_1_1TimeVal.html">Glib::TimeVal</a>&amp; current_time)</td></tr>
 
92
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Possibly advances an animation to a new frame. <a href="#ac4f9496b9197f968656760fa16218f25"></a><br/></td></tr>
 
93
<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>
 
94
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Possibly advances an animation to a new frame. <a href="#a1bd10ac0d757e79e1d0e4fda7778d0a0"></a><br/></td></tr>
 
95
<tr><td colspan="2"><h2><a name="related"></a>
 
96
Related Functions</h2></td></tr>
 
97
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
 
98
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><br class="typebreak"/>
 
99
&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>
 
100
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a0c68bd7a2e248042af42c41d2aa11016"></a><br/></td></tr>
 
101
</table>
 
102
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
103
<div class="textblock"><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>
 
104
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
 
105
<a class="anchor" id="abb04812c40c3cde3adae527f91e992b4"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::~PixbufAnimationIter" ref="abb04812c40c3cde3adae527f91e992b4" args="()" -->
 
106
<div class="memitem">
 
107
<div class="memproto">
 
108
      <table class="memname">
 
109
        <tr>
 
110
          <td class="memname">virtual Gdk::PixbufAnimationIter::~PixbufAnimationIter </td>
 
111
          <td>(</td>
 
112
          <td class="paramname"></td><td>)</td>
 
113
          <td><code> [virtual]</code></td>
 
114
        </tr>
 
115
      </table>
 
116
</div>
 
117
<div class="memdoc">
 
118
 
 
119
</div>
 
120
</div>
 
121
<hr/><h2>Member Function Documentation</h2>
 
122
<a class="anchor" id="ac4f9496b9197f968656760fa16218f25"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::advance" ref="ac4f9496b9197f968656760fa16218f25" args="(const Glib::TimeVal &amp;current_time)" -->
 
123
<div class="memitem">
 
124
<div class="memproto">
 
125
      <table class="memname">
 
126
        <tr>
 
127
          <td class="memname">bool Gdk::PixbufAnimationIter::advance </td>
 
128
          <td>(</td>
 
129
          <td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/structGlib_1_1TimeVal.html">Glib::TimeVal</a> &amp;&#160;</td>
 
130
          <td class="paramname"><em>current_time</em></td><td>)</td>
 
131
          <td></td>
 
132
        </tr>
 
133
      </table>
 
134
</div>
 
135
<div class="memdoc">
 
136
 
 
137
<p>Possibly advances an animation to a new frame. </p>
 
138
<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>
 
139
<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 as the animation ...">get_pixbuf()</a> is called. That is, you can't go backward in time; animations only play forward.</p>
 
140
<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>
 
141
<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 as the animation ...">get_pixbuf()</a> and update the display with the new pixbuf.</p>
 
142
<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>
 
143
<dl><dt><b>Parameters:</b></dt><dd>
 
144
  <table class="params">
 
145
    <tr><td class="paramname">current_time</td><td>Current time. </td></tr>
 
146
  </table>
 
147
  </dd>
 
148
</dl>
 
149
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the image may need updating. </dd></dl>
 
150
 
 
151
</div>
 
152
</div>
 
153
<a class="anchor" id="a1bd10ac0d757e79e1d0e4fda7778d0a0"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::advance" ref="a1bd10ac0d757e79e1d0e4fda7778d0a0" args="()" -->
 
154
<div class="memitem">
 
155
<div class="memproto">
 
156
      <table class="memname">
 
157
        <tr>
 
158
          <td class="memname">bool Gdk::PixbufAnimationIter::advance </td>
 
159
          <td>(</td>
 
160
          <td class="paramname"></td><td>)</td>
 
161
          <td></td>
 
162
        </tr>
 
163
      </table>
 
164
</div>
 
165
<div class="memdoc">
 
166
 
 
167
<p>Possibly advances an animation to a new frame. </p>
 
168
<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>
 
169
<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 as the animation ...">get_pixbuf()</a> and update the display with the new pixbuf.</p>
 
170
<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>
 
171
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the image may need updating. </dd></dl>
 
172
 
 
173
</div>
 
174
</div>
 
175
<a class="anchor" id="a59be27954e4c177236c5bebfa6c84602"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::get_delay_time" ref="a59be27954e4c177236c5bebfa6c84602" args="() const " -->
 
176
<div class="memitem">
 
177
<div class="memproto">
 
178
      <table class="memname">
 
179
        <tr>
 
180
          <td class="memname">int Gdk::PixbufAnimationIter::get_delay_time </td>
 
181
          <td>(</td>
 
182
          <td class="paramname"></td><td>)</td>
 
183
          <td> const</td>
 
184
        </tr>
 
185
      </table>
 
186
</div>
 
187
<div class="memdoc">
 
188
 
 
189
<p>Gets the number of milliseconds the current pixbuf should be displayed, or -1 if the current pixbuf should be displayed forever. </p>
 
190
<p>Glib::signal_timeout.connect() conveniently takes a timeout in milliseconds, so you can use a timeout to schedule the next update.</p>
 
191
<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>
 
192
<dl class="return"><dt><b>Returns:</b></dt><dd>Delay time in milliseconds (thousandths of a second). </dd></dl>
 
193
 
 
194
</div>
 
195
</div>
 
196
<a class="anchor" id="a66d583297b87ac3f2b1424526afe962c"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::get_pixbuf" ref="a66d583297b87ac3f2b1424526afe962c" args="()" -->
 
197
<div class="memitem">
 
198
<div class="memproto">
 
199
      <table class="memname">
 
200
        <tr>
 
201
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/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>
 
202
          <td>(</td>
 
203
          <td class="paramname"></td><td>)</td>
 
204
          <td></td>
 
205
        </tr>
 
206
      </table>
 
207
</div>
 
208
<div class="memdoc">
 
209
 
 
210
<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>
 
211
<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 the current pixbuf s...">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>
 
212
<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>
 
213
<dl class="return"><dt><b>Returns:</b></dt><dd>The pixbuf to be displayed. </dd></dl>
 
214
 
 
215
</div>
 
216
</div>
 
217
<a class="anchor" id="a2b0c8610e86dd96f49425d48396797be"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::get_pixbuf" ref="a2b0c8610e86dd96f49425d48396797be" args="() const " -->
 
218
<div class="memitem">
 
219
<div class="memproto">
 
220
      <table class="memname">
 
221
        <tr>
 
222
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/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>
 
223
          <td>(</td>
 
224
          <td class="paramname"></td><td>)</td>
 
225
          <td> const</td>
 
226
        </tr>
 
227
      </table>
 
228
</div>
 
229
<div class="memdoc">
 
230
 
 
231
<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>
 
232
<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 the current pixbuf s...">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>
 
233
<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>
 
234
<dl class="return"><dt><b>Returns:</b></dt><dd>The pixbuf to be displayed. </dd></dl>
 
235
 
 
236
</div>
 
237
</div>
 
238
<a class="anchor" id="a5aac29041dd100a119b8aa703dbafe3f"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::gobj" ref="a5aac29041dd100a119b8aa703dbafe3f" args="()" -->
 
239
<div class="memitem">
 
240
<div class="memproto">
 
241
      <table class="memname">
 
242
        <tr>
 
243
          <td class="memname">GdkPixbufAnimationIter* Gdk::PixbufAnimationIter::gobj </td>
 
244
          <td>(</td>
 
245
          <td class="paramname"></td><td>)</td>
 
246
          <td><code> [inline]</code></td>
 
247
        </tr>
 
248
      </table>
 
249
</div>
 
250
<div class="memdoc">
 
251
 
 
252
<p>Provides access to the underlying C GObject. </p>
 
253
 
 
254
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html#a4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.</p>
 
255
 
 
256
</div>
 
257
</div>
 
258
<a class="anchor" id="a8d6407acb0d49bc5ff6ed415d93b536b"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::gobj" ref="a8d6407acb0d49bc5ff6ed415d93b536b" args="() const " -->
 
259
<div class="memitem">
 
260
<div class="memproto">
 
261
      <table class="memname">
 
262
        <tr>
 
263
          <td class="memname">const GdkPixbufAnimationIter* Gdk::PixbufAnimationIter::gobj </td>
 
264
          <td>(</td>
 
265
          <td class="paramname"></td><td>)</td>
 
266
          <td> const<code> [inline]</code></td>
 
267
        </tr>
 
268
      </table>
 
269
</div>
 
270
<div class="memdoc">
 
271
 
 
272
<p>Provides access to the underlying C GObject. </p>
 
273
 
 
274
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html#a778a94181132976bbfb0519793f3b32e">Glib::ObjectBase</a>.</p>
 
275
 
 
276
</div>
 
277
</div>
 
278
<a class="anchor" id="ae2e23368fa026c6deeaacd4168074a44"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::gobj_copy" ref="ae2e23368fa026c6deeaacd4168074a44" args="()" -->
 
279
<div class="memitem">
 
280
<div class="memproto">
 
281
      <table class="memname">
 
282
        <tr>
 
283
          <td class="memname">GdkPixbufAnimationIter* Gdk::PixbufAnimationIter::gobj_copy </td>
 
284
          <td>(</td>
 
285
          <td class="paramname"></td><td>)</td>
 
286
          <td></td>
 
287
        </tr>
 
288
      </table>
 
289
</div>
 
290
<div class="memdoc">
 
291
 
 
292
<p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p>
 
293
 
 
294
</div>
 
295
</div>
 
296
<a class="anchor" id="ad50a6088b03fb35fe65dea11debecd84"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::on_currently_loading_frame" ref="ad50a6088b03fb35fe65dea11debecd84" args="() const " -->
 
297
<div class="memitem">
 
298
<div class="memproto">
 
299
      <table class="memname">
 
300
        <tr>
 
301
          <td class="memname">bool Gdk::PixbufAnimationIter::on_currently_loading_frame </td>
 
302
          <td>(</td>
 
303
          <td class="paramname"></td><td>)</td>
 
304
          <td> const</td>
 
305
        </tr>
 
306
      </table>
 
307
</div>
 
308
<div class="memdoc">
 
309
 
 
310
<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>
 
311
<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>
 
312
<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>
 
313
<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>
 
314
 
 
315
</div>
 
316
</div>
 
317
<hr/><h2>Friends And Related Function Documentation</h2>
 
318
<a class="anchor" id="a0c68bd7a2e248042af42c41d2aa11016"></a><!-- doxytag: member="Gdk::PixbufAnimationIter::wrap" ref="a0c68bd7a2e248042af42c41d2aa11016" args="(GdkPixbufAnimationIter *object, bool take_copy=false)" -->
 
319
<div class="memitem">
 
320
<div class="memproto">
 
321
      <table class="memname">
 
322
        <tr>
 
323
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGdk_1_1PixbufAnimationIter.html">Gdk::PixbufAnimationIter</a> &gt; wrap </td>
 
324
          <td>(</td>
 
325
          <td class="paramtype">GdkPixbufAnimationIter *&#160;</td>
 
326
          <td class="paramname"><em>object</em>, </td>
 
327
        </tr>
 
328
        <tr>
 
329
          <td class="paramkey"></td>
 
330
          <td></td>
 
331
          <td class="paramtype">bool&#160;</td>
 
332
          <td class="paramname"><em>take_copy</em> = <code>false</code>&#160;</td>
 
333
        </tr>
 
334
        <tr>
 
335
          <td></td>
 
336
          <td>)</td>
 
337
          <td></td><td><code> [related]</code></td>
 
338
        </tr>
 
339
      </table>
 
340
</div>
 
341
<div class="memdoc">
 
342
 
 
343
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
 
344
<dl><dt><b>Parameters:</b></dt><dd>
 
345
  <table class="params">
 
346
    <tr><td class="paramname">object</td><td>The C instance. </td></tr>
 
347
    <tr><td class="paramname">take_copy</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>
 
348
  </table>
 
349
  </dd>
 
350
</dl>
 
351
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
 
352
 
 
353
</div>
 
354
</div>
 
355
<hr/>The documentation for this class was generated from the following file:<ul>
 
356
<li>gdkmm/pixbufanimationiter.h</li>
 
357
</ul>
 
358
</div>
 
359
<hr class="footer"/><address class="footer"><small>Generated on Fri Jul 8 2011 13:31:44 for gtkmm by&#160;
 
360
<a href="http://www.doxygen.org/index.html">
 
361
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
 
362
</body>
 
363
</html>