<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>gtkmm 2.4: Gtk::ToggleButton Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../index.html">Main Page</a>
<a href="group__Widgets.html">Widgets</a>
<a class="qindex" href="namespaces.html"> Namespaces</a>
<a href="../../tutorial/html/index.html"> Book</a>
</center>
<hr width="100%"/>
<!-- begin main content -->
<div id="content">
<!-- Generated by Doxygen 1.5.1 -->
<div class="nav">
<a class="el" href="namespaceGtk.html">Gtk</a>::<a class="el" href="classGtk_1_1ToggleButton.html">ToggleButton</a></div>
<h1>Gtk::ToggleButton Class Reference<br>
<small>
[<a class="el" href="group__Widgets.html">Widgets</a>]</small>
</h1><!-- doxytag: class="Gtk::ToggleButton" --><!-- doxytag: inherits="Gtk::Button" -->Inheritance diagram for Gtk::ToggleButton:<p><center><img src="classGtk_1_1ToggleButton__inherit__graph.png" border="0" usemap="#Gtk_1_1ToggleButton__inherit__map" alt="Inheritance graph"></center>
<map name="Gtk_1_1ToggleButton__inherit__map">
<area href="classGtk_1_1CheckButton.html" shape="rect" coords="51,702,184,729" alt="">
<area href="classGtk_1_1Button.html" shape="rect" coords="71,548,164,574" alt="">
<area href="classGtk_1_1Bin.html" shape="rect" coords="81,470,153,497" alt="">
<area href="classGtk_1_1Container.html" shape="rect" coords="61,393,173,420" alt="">
<area href="classGtk_1_1Widget.html" shape="rect" coords="71,316,164,342" alt="">
<area href="classGtk_1_1Object.html" shape="rect" coords="5,238,96,265" alt="">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1Object.html" shape="rect" coords="7,161,100,188" alt="">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html" shape="rect" coords="53,84,179,110" alt="">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1Interface.html" shape="rect" coords="128,161,237,188" alt="">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classsigc_1_1trackable.html" shape="rect" coords="60,6,172,33" alt="">
<area href="classAtk_1_1Implementor.html" shape="rect" coords="120,238,251,265" alt="">
<area href="classGtk_1_1RadioButton.html" shape="rect" coords="53,780,181,806" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classGtk_1_1ToggleButton-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
A <a class="el" href="classGtk_1_1ToggleButton.html">Gtk::ToggleButton</a> will remain 'pressed-in' when clicked.
<p>
Clicking again will cause the toggle button to return to it's normal state. The state of a <a class="el" href="classGtk_1_1ToggleButton.html">Gtk::ToggleButton</a> can be set specifically using <a class="el" href="classGtk_1_1ToggleButton.html#88f56cc3b99057fdffca3e0d0b5001a2">set_active()</a>, and retrieved using <a class="el" href="classGtk_1_1ToggleButton.html#3a0e039f50815795a46656ae5761e531">get_active()</a>. To simply switch the state of a toggle button, use <a class="el" href="classGtk_1_1ToggleButton.html#1fcff3b2f50b5a2e78b51339660f5c3a">toggled()</a>.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#3a0e039f50815795a46656ae5761e531">get_active</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#e2fa52a4ec5fd95602eee60c41103b8e">get_inconsistent</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the value set by <a class="el" href="classGtk_1_1ToggleButton.html#4ee24bcd23c08ed5b01b3260e5eb320a">set_inconsistent()</a>. <a href="#e2fa52a4ec5fd95602eee60c41103b8e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#878ad33e61e5df827ac87a2e04199fdc">get_mode</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves whether the button is displayed as a separate indicator and label. <a href="#878ad33e61e5df827ac87a2e04199fdc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GtkToggleButton* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#e48839ba71f7dd62410bcbcde26103ef">gobj</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#e48839ba71f7dd62410bcbcde26103ef"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GtkToggleButton* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#af95f140bb908c7424ce489c8c988993">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#af95f140bb908c7424ce489c8c988993"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><<br>
bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#69e563b72397d77b67debf35541a236c">property_active</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If the toggle button should be pressed in or not. <a href="#69e563b72397d77b67debf35541a236c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><bool> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#a822bd30fbc8f7c0c048535127abc1ef">property_active</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If the toggle button should be pressed in or not. <a href="#a822bd30fbc8f7c0c048535127abc1ef"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><<br>
bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#04e5eb753c6c5b309fee70a268983c6d">property_draw_indicator</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If the toggle part of the button is displayed. <a href="#04e5eb753c6c5b309fee70a268983c6d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><bool> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#525c57372c7eb32a2c2b9ce44753ac1e">property_draw_indicator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If the toggle part of the button is displayed. <a href="#525c57372c7eb32a2c2b9ce44753ac1e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><<br>
bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#7f7f04ca8f7ad5228ad905b3d74a1d8c">property_inconsistent</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If the toggle button is in an in between state. <a href="#7f7f04ca8f7ad5228ad905b3d74a1d8c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><bool> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#a307db71584e2165b590e175b80feb5b">property_inconsistent</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If the toggle button is in an in between state. <a href="#a307db71584e2165b590e175b80feb5b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#88f56cc3b99057fdffca3e0d0b5001a2">set_active</a> (bool is_active=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#4ee24bcd23c08ed5b01b3260e5eb320a">set_inconsistent</a> (bool setting=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a toggle button, and the current values in that range are inconsistent, you may want to display the toggle in an "in between" state. <a href="#4ee24bcd23c08ed5b01b3260e5eb320a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#f989c82e500dd819c9253131d563b543">set_mode</a> (bool draw_indicator=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the button is displayed as a separate indicator and label. <a href="#f989c82e500dd819c9253131d563b543"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a><void> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#85ce4ecde9214e112d1b739ba5fe6ef8">signal_toggled</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted whenever the toggle tool button changes state. <a href="#85ce4ecde9214e112d1b739ba5fe6ef8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#1a3d2264b3995cb3e6e8b3cb1d95bf6a">ToggleButton</a> (const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& stock_id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a toggle button containing the image and text from a stock item. <a href="#1a3d2264b3995cb3e6e8b3cb1d95bf6a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#119f705699e515078c92b51b1f152497">ToggleButton</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& label, bool mnemonic=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a toggle button with a label. <a href="#119f705699e515078c92b51b1f152497"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#945ddca141501dc344d281981a59330f">ToggleButton</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty toggle button. <a href="#945ddca141501dc344d281981a59330f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#1fcff3b2f50b5a2e78b51339660f5c3a">toggled</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#8d3423ad5415631cdba5324874eb83c9">~ToggleButton</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#61f3c4a4eeb448e533579dc0509d363b">on_toggled</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGtk_1_1ToggleButton.html">Gtk::ToggleButton</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#ff198f3e8571926bffa8450220573901">wrap</a> (GtkToggleButton* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#ff198f3e8571926bffa8450220573901"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="8d3423ad5415631cdba5324874eb83c9"></a><!-- doxytag: member="Gtk::ToggleButton::~ToggleButton" ref="8d3423ad5415631cdba5324874eb83c9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gtk::ToggleButton::~ToggleButton </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="945ddca141501dc344d281981a59330f"></a><!-- doxytag: member="Gtk::ToggleButton::ToggleButton" ref="945ddca141501dc344d281981a59330f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::ToggleButton::ToggleButton </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an empty toggle button.
<p>
With an empty button, you can <a class="el" href="classGtk_1_1Container.html#e5f3b9c32b1b74e7613997843e91f4cc">Gtk::Button::add()</a> a widget such as a Gtk::Pixmap or <a class="el" href="classGtk_1_1Box.html">Gtk::Box</a>.<p>
If you just wish to add a <a class="el" href="classGtk_1_1Label.html">Gtk::Label</a>, you may want to use the Gtk::ToggleButton(const Glib::ustring& label) constructor directly instead.
</div>
</div><p>
<a class="anchor" name="119f705699e515078c92b51b1f152497"></a><!-- doxytag: member="Gtk::ToggleButton::ToggleButton" ref="119f705699e515078c92b51b1f152497" args="(const Glib::ustring &label, bool mnemonic=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::ToggleButton::ToggleButton </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>label</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>mnemonic</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a toggle button with a label.
<p>
You won't be able to add a widget to this button since it already contains a <a class="el" href="classGtk_1_1Label.html">Gtk::Label</a>
</div>
</div><p>
<a class="anchor" name="1a3d2264b3995cb3e6e8b3cb1d95bf6a"></a><!-- doxytag: member="Gtk::ToggleButton::ToggleButton" ref="1a3d2264b3995cb3e6e8b3cb1d95bf6a" args="(const StockID &stock_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::ToggleButton::ToggleButton </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td>
<td class="paramname"> <em>stock_id</em> </td>
<td> ) </td>
<td width="100%"><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a toggle button containing the image and text from a stock item.
<p>
<a class="el" href="namespaceGtk_1_1Stock.html">Stock</a> ids have identifiers like <a class="el" href="namespaceGtk_1_1Stock.html#783d80fdc67520898ed369836f1f3390">Gtk::Stock::OK</a> and <a class="el" href="namespaceGtk_1_1Stock.html#4cbfe0fbbd18329f560bb225081743c9">Gtk::Stock::APPLY</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>stock_id</em> </td><td>The stock item. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3a0e039f50815795a46656ae5761e531"></a><!-- doxytag: member="Gtk::ToggleButton::get_active" ref="3a0e039f50815795a46656ae5761e531" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::ToggleButton::get_active </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="e2fa52a4ec5fd95602eee60c41103b8e"></a><!-- doxytag: member="Gtk::ToggleButton::get_inconsistent" ref="e2fa52a4ec5fd95602eee60c41103b8e" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::ToggleButton::get_inconsistent </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the value set by <a class="el" href="classGtk_1_1ToggleButton.html#4ee24bcd23c08ed5b01b3260e5eb320a">set_inconsistent()</a>.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if the button is displayed as inconsistent, <code>false</code> otherwise. </dd></dl>
</div>
</div><p>
<a class="anchor" name="878ad33e61e5df827ac87a2e04199fdc"></a><!-- doxytag: member="Gtk::ToggleButton::get_mode" ref="878ad33e61e5df827ac87a2e04199fdc" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::ToggleButton::get_mode </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves whether the button is displayed as a separate indicator and label.
<p>
See <a class="el" href="classGtk_1_1ToggleButton.html#f989c82e500dd819c9253131d563b543">set_mode()</a>. <dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if the togglebutton is drawn as a separate indicator and label. </dd></dl>
</div>
</div><p>
<a class="anchor" name="e48839ba71f7dd62410bcbcde26103ef"></a><!-- doxytag: member="Gtk::ToggleButton::gobj" ref="e48839ba71f7dd62410bcbcde26103ef" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GtkToggleButton* Gtk::ToggleButton::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> 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_1Button.html#e0feae414420fe321854c52e7103c65d">Gtk::Button</a>.
<p>
Reimplemented in <a class="el" href="classGtk_1_1CheckButton.html#1f9b7c835dd5ad9b96345731fe5566a2">Gtk::CheckButton</a>, and <a class="el" href="classGtk_1_1RadioButton.html#5aae12d73235d9e420d3a2d4e69a7190">Gtk::RadioButton</a>.
</div>
</div><p>
<a class="anchor" name="af95f140bb908c7424ce489c8c988993"></a><!-- doxytag: member="Gtk::ToggleButton::gobj" ref="af95f140bb908c7424ce489c8c988993" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkToggleButton* Gtk::ToggleButton::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><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_1Button.html#ac9db3896fa8b7576c6f3720846faa1c">Gtk::Button</a>.
<p>
Reimplemented in <a class="el" href="classGtk_1_1CheckButton.html#9c03c6bb7097d41b6a1d7437259e7cee">Gtk::CheckButton</a>, and <a class="el" href="classGtk_1_1RadioButton.html#43c24cc7bea2c2edf043f4b76c632ee7">Gtk::RadioButton</a>.
</div>
</div><p>
<a class="anchor" name="61f3c4a4eeb448e533579dc0509d363b"></a><!-- doxytag: member="Gtk::ToggleButton::on_toggled" ref="61f3c4a4eeb448e533579dc0509d363b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Gtk::ToggleButton::on_toggled </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="69e563b72397d77b67debf35541a236c"></a><!-- doxytag: member="Gtk::ToggleButton::property_active" ref="69e563b72397d77b67debf35541a236c" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><bool> Gtk::ToggleButton::property_active </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If the toggle button should be pressed in or not.
<p>
You rarely need to use properties because there are get_ and set_ methods for almost all of them. <dl class="return" compact><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><p>
<a class="anchor" name="a822bd30fbc8f7c0c048535127abc1ef"></a><!-- doxytag: member="Gtk::ToggleButton::property_active" ref="a822bd30fbc8f7c0c048535127abc1ef" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><bool> Gtk::ToggleButton::property_active </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If the toggle button should be pressed in or not.
<p>
You rarely need to use properties because there are get_ and set_ methods for almost all of them. <dl class="return" compact><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><p>
<a class="anchor" name="04e5eb753c6c5b309fee70a268983c6d"></a><!-- doxytag: member="Gtk::ToggleButton::property_draw_indicator" ref="04e5eb753c6c5b309fee70a268983c6d" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><bool> Gtk::ToggleButton::property_draw_indicator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If the toggle part of the button is displayed.
<p>
You rarely need to use properties because there are get_ and set_ methods for almost all of them. <dl class="return" compact><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><p>
<a class="anchor" name="525c57372c7eb32a2c2b9ce44753ac1e"></a><!-- doxytag: member="Gtk::ToggleButton::property_draw_indicator" ref="525c57372c7eb32a2c2b9ce44753ac1e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><bool> Gtk::ToggleButton::property_draw_indicator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If the toggle part of the button is displayed.
<p>
You rarely need to use properties because there are get_ and set_ methods for almost all of them. <dl class="return" compact><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><p>
<a class="anchor" name="7f7f04ca8f7ad5228ad905b3d74a1d8c"></a><!-- doxytag: member="Gtk::ToggleButton::property_inconsistent" ref="7f7f04ca8f7ad5228ad905b3d74a1d8c" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><bool> Gtk::ToggleButton::property_inconsistent </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If the toggle button is in an in between state.
<p>
You rarely need to use properties because there are get_ and set_ methods for almost all of them. <dl class="return" compact><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><p>
<a class="anchor" name="a307db71584e2165b590e175b80feb5b"></a><!-- doxytag: member="Gtk::ToggleButton::property_inconsistent" ref="a307db71584e2165b590e175b80feb5b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><bool> Gtk::ToggleButton::property_inconsistent </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If the toggle button is in an in between state.
<p>
You rarely need to use properties because there are get_ and set_ methods for almost all of them. <dl class="return" compact><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><p>
<a class="anchor" name="88f56cc3b99057fdffca3e0d0b5001a2"></a><!-- doxytag: member="Gtk::ToggleButton::set_active" ref="88f56cc3b99057fdffca3e0d0b5001a2" args="(bool is_active=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::ToggleButton::set_active </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>is_active</em> = <code>true</code> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="4ee24bcd23c08ed5b01b3260e5eb320a"></a><!-- doxytag: member="Gtk::ToggleButton::set_inconsistent" ref="4ee24bcd23c08ed5b01b3260e5eb320a" args="(bool setting=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::ToggleButton::set_inconsistent </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>setting</em> = <code>true</code> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a toggle button, and the current values in that range are inconsistent, you may want to display the toggle in an "in between" state.
<p>
This function turns on "in between" display. Normally you would turn off the inconsistent state again if the user toggles the toggle button. This has to be done manually, <a class="el" href="classGtk_1_1ToggleButton.html#4ee24bcd23c08ed5b01b3260e5eb320a">set_inconsistent()</a> only affects visual appearance, it doesn't affect the semantics of the button. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>setting</em> </td><td><code>true</code> if state is inconsistent. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f989c82e500dd819c9253131d563b543"></a><!-- doxytag: member="Gtk::ToggleButton::set_mode" ref="f989c82e500dd819c9253131d563b543" args="(bool draw_indicator=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::ToggleButton::set_mode </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>draw_indicator</em> = <code>true</code> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets whether the button is displayed as a separate indicator and label.
<p>
You can call this function on a checkbutton or a radiobutton with <em>draw_indicator</em> = <code>false</code> to make the button look like a normal button<p>
This function only affects instances of classes like <a class="el" href="classGtk_1_1CheckButton.html">Gtk::CheckButton</a> and <a class="el" href="classGtk_1_1RadioButton.html">Gtk::RadioButton</a> that derive from <a class="el" href="classGtk_1_1ToggleButton.html">Gtk::ToggleButton</a>, not instances of <a class="el" href="classGtk_1_1ToggleButton.html">Gtk::ToggleButton</a> itself. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>draw_indicator</em> </td><td>If <code>true</code>, draw the button as a separate indicator and label; if <code>false</code>, draw the button like a normal button. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="85ce4ecde9214e112d1b739ba5fe6ef8"></a><!-- doxytag: member="Gtk::ToggleButton::signal_toggled" ref="85ce4ecde9214e112d1b739ba5fe6ef8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > Gtk::ToggleButton::signal_toggled </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Emitted whenever the toggle tool button changes state.
<p>
<dl class="user" compact><dt><b>Prototype:</b></dt><dd><code>void on_my_toggled()</code> </dd></dl>
</div>
</div><p>
<a class="anchor" name="1fcff3b2f50b5a2e78b51339660f5c3a"></a><!-- doxytag: member="Gtk::ToggleButton::toggled" ref="1fcff3b2f50b5a2e78b51339660f5c3a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::ToggleButton::toggled </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="ff198f3e8571926bffa8450220573901"></a><!-- doxytag: member="Gtk::ToggleButton::wrap" ref="ff198f3e8571926bffa8450220573901" args="(GtkToggleButton *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1ToggleButton.html">Gtk::ToggleButton</a>* wrap </td>
<td>(</td>
<td class="paramtype">GtkToggleButton * </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 width="100%"><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object.
<p>
<dl compact><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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="togglebutton_8h.html">togglebutton.h</a></ul>
</div>
<!-- end main content -->
<hr><address><small>
Generated for gtkmm 2.4 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.5.1 © 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
9411cff4bc6d4e61b29ae81cd24665af
>
files
>
745
