<!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: Gtk::Spinner 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 Page</span></a></li>
<li><a href="pages.html"><span>Related 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 List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceGtk.html">Gtk</a>::<a class="el" href="classGtk_1_1Spinner.html">Spinner</a>
</div>
</div>
<div class="contents">
<h1>Gtk::Spinner Class Reference<br/>
<small>
[<a class="el" href="group__Widgets.html">Widgets</a>]</small>
</h1><!-- doxytag: class="Gtk::Spinner" --><!-- doxytag: inherits="Gtk::DrawingArea" -->
<p>A widget that displays a spinner animation. <a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classGtk_1_1DrawingArea.html">Gtk::DrawingArea</a>.</p>
<div class="dynheader">
Collaboration diagram for Gtk::Spinner:</div>
<div class="dynsection">
<div class="center"><img src="classGtk_1_1Spinner__coll__graph.png" border="0" usemap="#Gtk_1_1Spinner_coll__map" alt="Collaboration graph"/></div>
<map name="Gtk_1_1Spinner_coll__map" id="Gtk_1_1Spinner_coll__map">
<area shape="rect" href="classGtk_1_1DrawingArea.html" title="A widget for custom user interface elements." alt="" coords="52,392,175,421"/><area shape="rect" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)." alt="" coords="68,315,159,344"/><area shape="rect" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non-widget objects such..." alt="" coords="5,237,93,267"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="5,160,96,189"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="51,83,171,112"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="123,160,227,189"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="57,5,164,35"/><area shape="rect" href="classAtk_1_1Implementor.html" title="Atk::Implementor" alt="" coords="117,237,237,267"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classGtk_1_1Spinner-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Spinner.html#a555823f898d2d41a3f8d63418ddc46b4">~Spinner</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkSpinner* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Spinner.html#abe17cffe9c7a572c145f7b1a5b97a0af">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#abe17cffe9c7a572c145f7b1a5b97a0af"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GtkSpinner* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Spinner.html#a4decb0c07a05d468a3ab81f2c8537eb4">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a4decb0c07a05d468a3ab81f2c8537eb4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Spinner.html#ac95232e18f410eca09926d9e25efb738">Spinner</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Spinner.html#a108783a0f07a00756979be458bd42471">start</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts the animation of the spinner. <a href="#a108783a0f07a00756979be458bd42471"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Spinner.html#a0343bc16394f925e03ba2feead53a136">stop</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stops the animation of the spinner. <a href="#a0343bc16394f925e03ba2feead53a136"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Spinner.html#a1679936cbec4c2a32c2db84539cdeb85">property_active</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the spinner is active. <a href="#a1679936cbec4c2a32c2db84539cdeb85"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Spinner.html#abb806ae142a86f8d65fb6fb2c17d4b51">property_active</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the spinner is active. <a href="#abb806ae142a86f8d65fb6fb2c17d4b51"></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="el" href="classGtk_1_1Spinner.html">Gtk::Spinner</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Spinner.html#af75c8143663d0b0965a873e7bbeae3c2">wrap</a> (GtkSpinner* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </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="#af75c8143663d0b0965a873e7bbeae3c2"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A widget that displays a spinner animation. </p>
<dl class="since_2_20"><dt><b><a class="el" href="since_2_20.html#_since_2_20000025">Since gtkmm 2.20:</a></b></dt><dd></dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a555823f898d2d41a3f8d63418ddc46b4"></a><!-- doxytag: member="Gtk::Spinner::~Spinner" ref="a555823f898d2d41a3f8d63418ddc46b4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gtk::Spinner::~Spinner </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac95232e18f410eca09926d9e25efb738"></a><!-- doxytag: member="Gtk::Spinner::Spinner" ref="ac95232e18f410eca09926d9e25efb738" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::Spinner::Spinner </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4decb0c07a05d468a3ab81f2c8537eb4"></a><!-- doxytag: member="Gtk::Spinner::gobj" ref="a4decb0c07a05d468a3ab81f2c8537eb4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GtkSpinner* Gtk::Spinner::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GtkObject. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1DrawingArea.html#ae9f647a9c8ccbd24f9f9ee598e4f48d0">Gtk::DrawingArea</a>.</p>
</div>
</div>
<a class="anchor" id="abe17cffe9c7a572c145f7b1a5b97a0af"></a><!-- doxytag: member="Gtk::Spinner::gobj" ref="abe17cffe9c7a572c145f7b1a5b97a0af" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkSpinner* Gtk::Spinner::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GtkObject. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1DrawingArea.html#aeb0de16fc78aab19dbfdd84b00699f2d">Gtk::DrawingArea</a>.</p>
</div>
</div>
<a class="anchor" id="abb806ae142a86f8d65fb6fb2c17d4b51"></a><!-- doxytag: member="Gtk::Spinner::property_active" ref="abb806ae142a86f8d65fb6fb2c17d4b51" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><bool> Gtk::Spinner::property_active </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Whether the spinner is active. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a1679936cbec4c2a32c2db84539cdeb85"></a><!-- doxytag: member="Gtk::Spinner::property_active" ref="a1679936cbec4c2a32c2db84539cdeb85" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><bool> Gtk::Spinner::property_active </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Whether the spinner is active. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a108783a0f07a00756979be458bd42471"></a><!-- doxytag: member="Gtk::Spinner::start" ref="a108783a0f07a00756979be458bd42471" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Spinner::start </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Starts the animation of the spinner. </p>
<dl class="since_2_20"><dt><b><a class="el" href="since_2_20.html#_since_2_20000026">Since gtkmm 2.20:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a0343bc16394f925e03ba2feead53a136"></a><!-- doxytag: member="Gtk::Spinner::stop" ref="a0343bc16394f925e03ba2feead53a136" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Spinner::stop </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stops the animation of the spinner. </p>
<dl class="since_2_20"><dt><b><a class="el" href="since_2_20.html#_since_2_20000027">Since gtkmm 2.20:</a></b></dt><dd></dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="af75c8143663d0b0965a873e7bbeae3c2"></a><!-- doxytag: member="Gtk::Spinner::wrap" ref="af75c8143663d0b0965a873e7bbeae3c2" args="(GtkSpinner *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1Spinner.html">Gtk::Spinner</a>* wrap </td>
<td>(</td>
<td class="paramtype">GtkSpinner * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </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" href="../../../glibmm-2.4/reference/html/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> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </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>gtkmm/spinner.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:22:02 2010 for gtkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
22e237efd6851989a23adf3360bb53d0
>
files
>
670
