Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 36a4a1ce4320fd74059ccc32828cc5d4 > files > 50

gtkmm3.0-doc-3.14.0-2.mga5.noarch.rpm

<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.7"/>
<title>gtkmm: Gdk::PixbufAnimationIter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">gtkmm
   &#160;<span id="projectnumber">3.14.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <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 id="navrow2" class="tabs2">
    <ul class="tablist">
      <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="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceGdk.html">Gdk</a></li><li class="navelem"><a class="el" href="classGdk_1_1PixbufAnimationIter.html">PixbufAnimationIter</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#related">Related Functions</a> &#124;
<a href="classGdk_1_1PixbufAnimationIter-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Gdk::PixbufAnimationIter Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<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="classGdk_1_1PixbufAnimationIter.html#details">More...</a></p>

<p><code>#include &lt;gdkmm/pixbufanimationiter.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Gdk::PixbufAnimationIter:</div>
<div class="dyncontent">
<div class="center"><img src="classGdk_1_1PixbufAnimationIter__inherit__graph.png" border="0" usemap="#Gdk_1_1PixbufAnimationIter_inherit__map" alt="Inheritance graph"/></div>
<map name="Gdk_1_1PixbufAnimationIter_inherit__map" id="Gdk_1_1PixbufAnimationIter_inherit__map">
<area shape="rect" id="node2" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="47,155,141,181"/><area shape="rect" id="node3" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="31,80,157,107"/><area shape="rect" id="node4" href="http://library.gnome.org/devel/libsigc++/unstable/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="37,5,152,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abb04812c40c3cde3adae527f91e992b4"><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 class="separator:abb04812c40c3cde3adae527f91e992b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5aac29041dd100a119b8aa703dbafe3f"><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 class="memdesc:a5aac29041dd100a119b8aa703dbafe3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject.  <a href="#a5aac29041dd100a119b8aa703dbafe3f">More...</a><br /></td></tr>
<tr class="separator:a5aac29041dd100a119b8aa703dbafe3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d6407acb0d49bc5ff6ed415d93b536b"><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 class="memdesc:a8d6407acb0d49bc5ff6ed415d93b536b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject.  <a href="#a8d6407acb0d49bc5ff6ed415d93b536b">More...</a><br /></td></tr>
<tr class="separator:a8d6407acb0d49bc5ff6ed415d93b536b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2e23368fa026c6deeaacd4168074a44"><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 class="memdesc:ae2e23368fa026c6deeaacd4168074a44"><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">More...</a><br /></td></tr>
<tr class="separator:ae2e23368fa026c6deeaacd4168074a44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59be27954e4c177236c5bebfa6c84602"><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 class="memdesc:a59be27954e4c177236c5bebfa6c84602"><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">More...</a><br /></td></tr>
<tr class="separator:a59be27954e4c177236c5bebfa6c84602"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66d583297b87ac3f2b1424526afe962c"><td class="memItemLeft" align="right" valign="top"><a class="elRef" 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 class="memdesc:a66d583297b87ac3f2b1424526afe962c"><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" title="Queries the width of a pixbuf. ">Gdk::Pixbuf::get_width()</a>, <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>:get_height()).  <a href="#a66d583297b87ac3f2b1424526afe962c">More...</a><br /></td></tr>
<tr class="separator:a66d583297b87ac3f2b1424526afe962c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b0c8610e86dd96f49425d48396797be"><td class="memItemLeft" align="right" valign="top"><a class="elRef" 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 class="memdesc:a2b0c8610e86dd96f49425d48396797be"><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" title="Queries the width of a pixbuf. ">Gdk::Pixbuf::get_width()</a>, <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>:get_height()).  <a href="#a2b0c8610e86dd96f49425d48396797be">More...</a><br /></td></tr>
<tr class="separator:a2b0c8610e86dd96f49425d48396797be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad50a6088b03fb35fe65dea11debecd84"><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 class="memdesc:ad50a6088b03fb35fe65dea11debecd84"><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">More...</a><br /></td></tr>
<tr class="separator:ad50a6088b03fb35fe65dea11debecd84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4f9496b9197f968656760fa16218f25"><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="http://library.gnome.org/devel/glibmm/unstable/structGlib_1_1TimeVal.html">Glib::TimeVal</a>&amp; current_time)</td></tr>
<tr class="memdesc:ac4f9496b9197f968656760fa16218f25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Possibly advances an animation to a new frame.  <a href="#ac4f9496b9197f968656760fa16218f25">More...</a><br /></td></tr>
<tr class="separator:ac4f9496b9197f968656760fa16218f25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bd10ac0d757e79e1d0e4fda7778d0a0"><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 class="memdesc:a1bd10ac0d757e79e1d0e4fda7778d0a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Possibly advances an animation to a new frame.  <a href="#a1bd10ac0d757e79e1d0e4fda7778d0a0">More...</a><br /></td></tr>
<tr class="separator:a1bd10ac0d757e79e1d0e4fda7778d0a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a31e2babdc64bd6bd10ee3c05178204f9"><td class="memItemLeft" align="right" valign="top">static GType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1PixbufAnimationIter.html#a31e2babdc64bd6bd10ee3c05178204f9">get_type</a> ()</td></tr>
<tr class="memdesc:a31e2babdc64bd6bd10ee3c05178204f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the GType for this class, for use with the underlying GObject type system.  <a href="#a31e2babdc64bd6bd10ee3c05178204f9">More...</a><br /></td></tr>
<tr class="separator:a31e2babdc64bd6bd10ee3c05178204f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:a0c68bd7a2e248042af42c41d2aa11016"><td class="memItemLeft" align="right" valign="top"><a class="elRef" 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 class="memdesc:a0c68bd7a2e248042af42c41d2aa11016"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object.  <a href="#a0c68bd7a2e248042af42c41d2aa11016">More...</a><br /></td></tr>
<tr class="separator:a0c68bd7a2e248042af42c41d2aa11016"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<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>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="abb04812c40c3cde3adae527f91e992b4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual Gdk::PixbufAnimationIter::~PixbufAnimationIter </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac4f9496b9197f968656760fa16218f25"></a>
<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" 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>)</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" title="Get an iterator for displaying an animation. ">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" title="Get an iterator for displaying an animation. ">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>
<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 as the animation ...">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_14000012">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">current_time</td><td>Current time. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the image may need updating. </dd></dl>

</div>
</div>
<a class="anchor" id="a1bd10ac0d757e79e1d0e4fda7778d0a0"></a>
<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>)</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" title="Get an iterator for displaying an animation. ">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 as the animation ...">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_14000013">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
<dl class="section return"><dt>Returns</dt><dd>true if the image may need updating. </dd></dl>

</div>
</div>
<a class="anchor" id="a59be27954e4c177236c5bebfa6c84602"></a>
<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>)</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_14000008">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
<dl class="section return"><dt>Returns</dt><dd>Delay time in milliseconds (thousandths of a second). </dd></dl>

</div>
</div>
<a class="anchor" id="a66d583297b87ac3f2b1424526afe962c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" 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>)</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" title="Queries the width of a pixbuf. ">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 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" title="Creates a new Gdk::Pixbuf with a copy of the information in the specified pixbuf. ...">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_14000009">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The pixbuf to be displayed. </dd></dl>

</div>
</div>
<a class="anchor" id="a2b0c8610e86dd96f49425d48396797be"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" 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>)</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" title="Queries the width of a pixbuf. ">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 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" title="Creates a new Gdk::Pixbuf with a copy of the information in the specified pixbuf. ...">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_14000010">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The pixbuf to be displayed. </dd></dl>

</div>
</div>
<a class="anchor" id="a31e2babdc64bd6bd10ee3c05178204f9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static GType Gdk::PixbufAnimationIter::get_type </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get the GType for this class, for use with the underlying GObject type system. </p>

</div>
</div>
<a class="anchor" id="a5aac29041dd100a119b8aa703dbafe3f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">GdkPixbufAnimationIter* Gdk::PixbufAnimationIter::gobj </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

</div>
</div>
<a class="anchor" id="a8d6407acb0d49bc5ff6ed415d93b536b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const GdkPixbufAnimationIter* Gdk::PixbufAnimationIter::gobj </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

</div>
</div>
<a class="anchor" id="ae2e23368fa026c6deeaacd4168074a44"></a>
<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>)</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>
<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>)</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_14000011">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the frame we're on is partially loaded, or the last frame. </dd></dl>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a0c68bd7a2e248042af42c41d2aa11016"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" 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>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>A <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">object</td><td>The C instance. </td></tr>
    <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>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A C++ instance that wraps this C instance. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 23 2014 12:59:12 for gtkmm by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.7
</small></address>
</body>
</html>