Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > media > main-release > by-pkgid > 22e237efd6851989a23adf3360bb53d0 > files > 239

gtkmm2.4-doc-2.20.3-1mdv2010.1.x86_64.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"/>
<title>gtkmm: Gtk::CellRendererSpinner 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="namespaceGtk.html">Gtk</a>::<a class="el" href="classGtk_1_1CellRendererSpinner.html">CellRendererSpinner</a>
  </div>
</div>
<div class="contents">
<h1>Gtk::CellRendererSpinner Class Reference<br/>
<small>
[<a class="el" href="group__TreeView.html">TreeView Classes</a>]</small>
</h1><!-- doxytag: class="Gtk::CellRendererSpinner" --><!-- doxytag: inherits="Gtk::CellRenderer" -->
<p>Renders a spinning animation in a cell. <a href="#_details">More...</a></p>

<p>Inherits <a class="el" href="classGtk_1_1CellRenderer.html">Gtk::CellRenderer</a>.</p>
<div class="dynheader">
Collaboration diagram for Gtk::CellRendererSpinner:</div>
<div class="dynsection">
<div class="center"><img src="classGtk_1_1CellRendererSpinner__coll__graph.png" border="0" usemap="#Gtk_1_1CellRendererSpinner_coll__map" alt="Collaboration graph"/></div>
<map name="Gtk_1_1CellRendererSpinner_coll__map" id="Gtk_1_1CellRendererSpinner_coll__map">
<area shape="rect" href="classGtk_1_1CellRenderer.html" title="CellRenderers are used by Gtk::TreeView columns to render the Gtk::TreeModel column..." alt="" coords="28,315,151,344"/><area shape="rect" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non&#45;widget objects such..." alt="" coords="45,237,133,267"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="44,160,135,189"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="29,83,149,112"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/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="classGtk_1_1CellRendererSpinner-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="classGtk_1_1CellRendererSpinner.html#af55dcd387e3f65b2fcd1859902f44fd4">~CellRendererSpinner</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkCellRendererSpinner*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CellRendererSpinner.html#ae2cffdb4bfcf7254204845b1fa514384">gobj</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#ae2cffdb4bfcf7254204845b1fa514384"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GtkCellRendererSpinner*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CellRendererSpinner.html#a834c7220911b5457c4f6503dbc82431f">gobj</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a834c7220911b5457c4f6503dbc82431f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CellRendererSpinner.html#a4124d0825033590785de3ca317b382ce">CellRendererSpinner</a> ()</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>&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CellRendererSpinner.html#a14ea3a3ca1e27c20b68a8b38da69023e">property_active</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the spinner is active (ie. <a href="#a14ea3a3ca1e27c20b68a8b38da69023e"></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"/>
&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CellRendererSpinner.html#a26aea87e5132058169ada98c38ad6e1e">property_active</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the spinner is active (ie. <a href="#a26aea87e5132058169ada98c38ad6e1e"></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>&lt; guint &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CellRendererSpinner.html#a056885e7da4bffca484be34b65f5bf06">property_pulse</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Pulse of the spinner. <a href="#a056885e7da4bffca484be34b65f5bf06"></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"/>
&lt; guint &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CellRendererSpinner.html#a2e9d3cdde6a04b849aea1be35e2b4388">property_pulse</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Pulse of the spinner. <a href="#a2e9d3cdde6a04b849aea1be35e2b4388"></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><br class="typebreak"/>
&lt; <a class="el" href="classGtk_1_1IconSize.html">Gtk::IconSize</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CellRendererSpinner.html#a030aee5303b9f7c12a024ba3cbf8a9ac">property_size</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The GtkIconSize value that specifies the size of the rendered spinner. <a href="#a030aee5303b9f7c12a024ba3cbf8a9ac"></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"/>
&lt; <a class="el" href="classGtk_1_1IconSize.html">Gtk::IconSize</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CellRendererSpinner.html#adfe046f35b07f775283876452bcf8530">property_size</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The GtkIconSize value that specifies the size of the rendered spinner. <a href="#adfe046f35b07f775283876452bcf8530"></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_1CellRendererSpinner.html">Gtk::CellRendererSpinner</a>*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CellRendererSpinner.html#ab202dff7e38dba5981b868b509dcccab">wrap</a> (GtkCellRendererSpinner* object, bool take_copy=false)</td></tr>
<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="#ab202dff7e38dba5981b868b509dcccab"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Renders a spinning animation in a cell. </p>
<p>A <a class="el" href="classGtk_1_1CellRendererSpinner.html" title="Renders a spinning animation in a cell.">CellRendererSpinner</a> can be used as an alternative to <a class="el" href="classGtk_1_1CellRendererProgress.html" title="Renders numbers as progress bars.">CellRendererProgress</a> for displaying indefinite activity, instead of actual progress.</p>
<p>To start the animation in a cell, set the active property to true and increment the pulse property at regular intervals. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af55dcd387e3f65b2fcd1859902f44fd4"></a><!-- doxytag: member="Gtk::CellRendererSpinner::~CellRendererSpinner" ref="af55dcd387e3f65b2fcd1859902f44fd4" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual Gtk::CellRendererSpinner::~CellRendererSpinner </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a4124d0825033590785de3ca317b382ce"></a><!-- doxytag: member="Gtk::CellRendererSpinner::CellRendererSpinner" ref="a4124d0825033590785de3ca317b382ce" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Gtk::CellRendererSpinner::CellRendererSpinner </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a834c7220911b5457c4f6503dbc82431f"></a><!-- doxytag: member="Gtk::CellRendererSpinner::gobj" ref="a834c7220911b5457c4f6503dbc82431f" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const GtkCellRendererSpinner* Gtk::CellRendererSpinner::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 GtkObject. </p>

<p>Reimplemented from <a class="el" href="classGtk_1_1CellRenderer.html#a8405f042907b039b6bd78882f4bdf8e7">Gtk::CellRenderer</a>.</p>

</div>
</div>
<a class="anchor" id="ae2cffdb4bfcf7254204845b1fa514384"></a><!-- doxytag: member="Gtk::CellRendererSpinner::gobj" ref="ae2cffdb4bfcf7254204845b1fa514384" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GtkCellRendererSpinner* Gtk::CellRendererSpinner::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 GtkObject. </p>

<p>Reimplemented from <a class="el" href="classGtk_1_1CellRenderer.html#ae40a869d68ddeb2601ed46c955514688">Gtk::CellRenderer</a>.</p>

</div>
</div>
<a class="anchor" id="a26aea87e5132058169ada98c38ad6e1e"></a><!-- doxytag: member="Gtk::CellRendererSpinner::property_active" ref="a26aea87e5132058169ada98c38ad6e1e" 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>&lt;bool&gt; Gtk::CellRendererSpinner::property_active </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Whether the spinner is active (ie. </p>
<p>shown) in the cell.</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="a14ea3a3ca1e27c20b68a8b38da69023e"></a><!-- doxytag: member="Gtk::CellRendererSpinner::property_active" ref="a14ea3a3ca1e27c20b68a8b38da69023e" 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>&lt;bool&gt; Gtk::CellRendererSpinner::property_active </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Whether the spinner is active (ie. </p>
<p>shown) in the cell.</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="a2e9d3cdde6a04b849aea1be35e2b4388"></a><!-- doxytag: member="Gtk::CellRendererSpinner::property_pulse" ref="a2e9d3cdde6a04b849aea1be35e2b4388" 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>&lt;guint&gt; Gtk::CellRendererSpinner::property_pulse </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Pulse of the spinner. </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="a056885e7da4bffca484be34b65f5bf06"></a><!-- doxytag: member="Gtk::CellRendererSpinner::property_pulse" ref="a056885e7da4bffca484be34b65f5bf06" 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>&lt;guint&gt; Gtk::CellRendererSpinner::property_pulse </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Pulse of the spinner. </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="adfe046f35b07f775283876452bcf8530"></a><!-- doxytag: member="Gtk::CellRendererSpinner::property_size" ref="adfe046f35b07f775283876452bcf8530" 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>&lt;<a class="el" href="classGtk_1_1IconSize.html">Gtk::IconSize</a>&gt; Gtk::CellRendererSpinner::property_size </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The GtkIconSize value that specifies the size of the rendered spinner. </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="a030aee5303b9f7c12a024ba3cbf8a9ac"></a><!-- doxytag: member="Gtk::CellRendererSpinner::property_size" ref="a030aee5303b9f7c12a024ba3cbf8a9ac" 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>&lt;<a class="el" href="classGtk_1_1IconSize.html">Gtk::IconSize</a>&gt; Gtk::CellRendererSpinner::property_size </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The GtkIconSize value that specifies the size of the rendered spinner. </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>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="ab202dff7e38dba5981b868b509dcccab"></a><!-- doxytag: member="Gtk::CellRendererSpinner::wrap" ref="ab202dff7e38dba5981b868b509dcccab" args="(GtkCellRendererSpinner *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classGtk_1_1CellRendererSpinner.html">Gtk::CellRendererSpinner</a>* wrap </td>
          <td>(</td>
          <td class="paramtype">GtkCellRendererSpinner *&#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" 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>&#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>gtkmm/cellrendererspinner.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:21:48 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>