<!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::ToggleButton 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_1ToggleButton.html">ToggleButton</a>
</div>
</div>
<div class="contents">
<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" -->
<p>A <a class="el" href="classGtk_1_1ToggleButton.html" title="A Gtk::ToggleButton will remain 'pressed-in' when clicked.">Gtk::ToggleButton</a> will remain 'pressed-in' when clicked. <a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classGtk_1_1Button.html">Gtk::Button</a>.</p>
<p>Inherited by <a class="el" href="classGtk_1_1CheckButton.html">Gtk::CheckButton</a>.</p>
<div class="dynheader">
Collaboration diagram for Gtk::ToggleButton:</div>
<div class="dynsection">
<div class="center"><img src="classGtk_1_1ToggleButton__coll__graph.png" border="0" usemap="#Gtk_1_1ToggleButton_coll__map" alt="Collaboration graph"/></div>
<map name="Gtk_1_1ToggleButton_coll__map" id="Gtk_1_1ToggleButton_coll__map">
<area shape="rect" href="classGtk_1_1Button.html" title="A widget that creates a signal when clicked on." alt="" coords="69,547,157,576"/><area shape="rect" href="classGtk_1_1Bin.html" title="A container with just one child." alt="" coords="79,469,148,499"/><area shape="rect" href="classGtk_1_1Container.html" title="Abstract container class." alt="" coords="61,392,165,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_1ToggleButton-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_1ToggleButton.html#a8d3423ad5415631cdba5324874eb83c9">~ToggleButton</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkToggleButton* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#aaf95f140bb908c7424ce489c8c988993">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#aaf95f140bb908c7424ce489c8c988993"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GtkToggleButton* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#a64415628d18b8d76da14ce7109e9b6af">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a64415628d18b8d76da14ce7109e9b6af"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#a945ddca141501dc344d281981a59330f">ToggleButton</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty toggle button. <a href="#a945ddca141501dc344d281981a59330f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#a119f705699e515078c92b51b1f152497">ToggleButton</a> (const <a class="elRef" href="../../../glibmm-2.4/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="#a119f705699e515078c92b51b1f152497"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#a1a3d2264b3995cb3e6e8b3cb1d95bf6a">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="#a1a3d2264b3995cb3e6e8b3cb1d95bf6a"></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_1ToggleButton.html#af989c82e500dd819c9253131d563b543">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="#af989c82e500dd819c9253131d563b543"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#a5ab3a6085eed8a4d5be1a1c9f5c2ad75">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="#a5ab3a6085eed8a4d5be1a1c9f5c2ad75"></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_1ToggleButton.html#a88f56cc3b99057fdffca3e0d0b5001a2">set_active</a> (bool is_active=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#a5bd30cc7bae298aeeed1e5772e78c9cc">get_active</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#a4ee24bcd23c08ed5b01b3260e5eb320a">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="#a4ee24bcd23c08ed5b01b3260e5eb320a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#a768c29f0e5947ff7546760e106507a83">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#a4ee24bcd23c08ed5b01b3260e5eb320a" title="If the user has selected a range of elements (such as some text or spreadsheet cells)...">set_inconsistent()</a>. <a href="#a768c29f0e5947ff7546760e106507a83"></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_1ToggleButton.html#a1fcff3b2f50b5a2e78b51339660f5c3a">toggled</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#a85ce4ecde9214e112d1b739ba5fe6ef8">signal_toggled</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted whenever the toggle tool button changes state. <a href="#a85ce4ecde9214e112d1b739ba5fe6ef8"></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_1ToggleButton.html#aa822bd30fbc8f7c0c048535127abc1ef">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="#aa822bd30fbc8f7c0c048535127abc1ef"></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_1ToggleButton.html#a0b3c84c893cf04f78bbf0d0b88c24128">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="#a0b3c84c893cf04f78bbf0d0b88c24128"></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_1ToggleButton.html#aa307db71584e2165b590e175b80feb5b">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="#aa307db71584e2165b590e175b80feb5b"></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_1ToggleButton.html#a82ff49b58936c7982081821ffce90575">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="#a82ff49b58936c7982081821ffce90575"></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_1ToggleButton.html#a525c57372c7eb32a2c2b9ce44753ac1e">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="#a525c57372c7eb32a2c2b9ce44753ac1e"></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_1ToggleButton.html#aaaea66c93817d95707ea71c20c6936dd">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="#aaaea66c93817d95707ea71c20c6936dd"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#a61f3c4a4eeb448e533579dc0509d363b">on_toggled</a> ()</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_1ToggleButton.html">Gtk::ToggleButton</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleButton.html#aff198f3e8571926bffa8450220573901">wrap</a> (GtkToggleButton* 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="#aff198f3e8571926bffa8450220573901"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A <a class="el" href="classGtk_1_1ToggleButton.html" title="A Gtk::ToggleButton will remain 'pressed-in' when clicked.">Gtk::ToggleButton</a> will remain 'pressed-in' when clicked. </p>
<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" title="A Gtk::ToggleButton will remain 'pressed-in' when clicked.">Gtk::ToggleButton</a> can be set specifically using <a class="el" href="classGtk_1_1ToggleButton.html#a88f56cc3b99057fdffca3e0d0b5001a2">set_active()</a>, and retrieved using <a class="el" href="classGtk_1_1ToggleButton.html#a5bd30cc7bae298aeeed1e5772e78c9cc">get_active()</a>. To simply switch the state of a toggle button, use <a class="el" href="classGtk_1_1ToggleButton.html#a1fcff3b2f50b5a2e78b51339660f5c3a">toggled()</a>. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8d3423ad5415631cdba5324874eb83c9"></a><!-- doxytag: member="Gtk::ToggleButton::~ToggleButton" ref="a8d3423ad5415631cdba5324874eb83c9" 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><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a945ddca141501dc344d281981a59330f"></a><!-- doxytag: member="Gtk::ToggleButton::ToggleButton" ref="a945ddca141501dc344d281981a59330f" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an empty toggle button. </p>
<p>With an empty button, you can <a class="el" href="classGtk_1_1Container.html#ae5f3b9c32b1b74e7613997843e91f4cc">Gtk::Button::add()</a> a widget such as a Gtk::Pixmap or <a class="el" href="classGtk_1_1Box.html" title="A base class for box containers.">Gtk::Box</a>.</p>
<p>If you just wish to add a <a class="el" href="classGtk_1_1Label.html" title="A widget that displays a small to medium amount of text.">Gtk::Label</a>, you may want to use the Gtk::ToggleButton(const Glib::ustring& label) constructor directly instead. </p>
</div>
</div>
<a class="anchor" id="a119f705699e515078c92b51b1f152497"></a><!-- doxytag: member="Gtk::ToggleButton::ToggleButton" ref="a119f705699e515078c92b51b1f152497" 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" href="../../../glibmm-2.4/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><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a toggle button with a label. </p>
<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" title="A widget that displays a small to medium amount of text.">Gtk::Label</a> </p>
</div>
</div>
<a class="anchor" id="a1a3d2264b3995cb3e6e8b3cb1d95bf6a"></a><!-- doxytag: member="Gtk::ToggleButton::ToggleButton" ref="a1a3d2264b3995cb3e6e8b3cb1d95bf6a" 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><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>
<p><a class="el" href="namespaceGtk_1_1Stock.html">Stock</a> ids have identifiers like <a class="el" href="namespaceGtk_1_1Stock.html#a783d80fdc67520898ed369836f1f3390">Gtk::Stock::OK</a> and <a class="el" href="namespaceGtk_1_1Stock.html#a4cbfe0fbbd18329f560bb225081743c9">Gtk::Stock::APPLY</a>. </p>
<dl><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>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5bd30cc7bae298aeeed1e5772e78c9cc"></a><!-- doxytag: member="Gtk::ToggleButton::get_active" ref="a5bd30cc7bae298aeeed1e5772e78c9cc" 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> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a768c29f0e5947ff7546760e106507a83"></a><!-- doxytag: member="Gtk::ToggleButton::get_inconsistent" ref="a768c29f0e5947ff7546760e106507a83" 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> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the value set by <a class="el" href="classGtk_1_1ToggleButton.html#a4ee24bcd23c08ed5b01b3260e5eb320a" title="If the user has selected a range of elements (such as some text or spreadsheet cells)...">set_inconsistent()</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the button is displayed as inconsistent, <code>false</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a5ab3a6085eed8a4d5be1a1c9f5c2ad75"></a><!-- doxytag: member="Gtk::ToggleButton::get_mode" ref="a5ab3a6085eed8a4d5be1a1c9f5c2ad75" 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> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves whether the button is displayed as a separate indicator and label. </p>
<p>See <a class="el" href="classGtk_1_1ToggleButton.html#af989c82e500dd819c9253131d563b543" title="Sets whether the button is displayed as a separate indicator and label.">set_mode()</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the togglebutton is drawn as a separate indicator and label. </dd></dl>
</div>
</div>
<a class="anchor" id="a64415628d18b8d76da14ce7109e9b6af"></a><!-- doxytag: member="Gtk::ToggleButton::gobj" ref="a64415628d18b8d76da14ce7109e9b6af" 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> 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#a9ea06156c54545902608286d1a0d0e42">Gtk::Button</a>.</p>
<p>Reimplemented in <a class="el" href="classGtk_1_1CheckButton.html#a89c2952646c6133413f35f8c38a8f7c1">Gtk::CheckButton</a>, and <a class="el" href="classGtk_1_1RadioButton.html#a03095fa6bb24ec52d0cceaa3d5ac353d">Gtk::RadioButton</a>.</p>
</div>
</div>
<a class="anchor" id="aaf95f140bb908c7424ce489c8c988993"></a><!-- doxytag: member="Gtk::ToggleButton::gobj" ref="aaf95f140bb908c7424ce489c8c988993" 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><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#aac9db3896fa8b7576c6f3720846faa1c">Gtk::Button</a>.</p>
<p>Reimplemented in <a class="el" href="classGtk_1_1CheckButton.html#a9c03c6bb7097d41b6a1d7437259e7cee">Gtk::CheckButton</a>, and <a class="el" href="classGtk_1_1RadioButton.html#a43c24cc7bea2c2edf043f4b76c632ee7">Gtk::RadioButton</a>.</p>
</div>
</div>
<a class="anchor" id="a61f3c4a4eeb448e533579dc0509d363b"></a><!-- doxytag: member="Gtk::ToggleButton::on_toggled" ref="a61f3c4a4eeb448e533579dc0509d363b" 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><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0b3c84c893cf04f78bbf0d0b88c24128"></a><!-- doxytag: member="Gtk::ToggleButton::property_active" ref="a0b3c84c893cf04f78bbf0d0b88c24128" 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::ToggleButton::property_active </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the toggle button should be pressed in or not. </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="aa822bd30fbc8f7c0c048535127abc1ef"></a><!-- doxytag: member="Gtk::ToggleButton::property_active" ref="aa822bd30fbc8f7c0c048535127abc1ef" 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::ToggleButton::property_active </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the toggle button should be pressed in or not. </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="aaaea66c93817d95707ea71c20c6936dd"></a><!-- doxytag: member="Gtk::ToggleButton::property_draw_indicator" ref="aaaea66c93817d95707ea71c20c6936dd" 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::ToggleButton::property_draw_indicator </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the toggle part of the button is displayed. </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="a525c57372c7eb32a2c2b9ce44753ac1e"></a><!-- doxytag: member="Gtk::ToggleButton::property_draw_indicator" ref="a525c57372c7eb32a2c2b9ce44753ac1e" 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::ToggleButton::property_draw_indicator </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the toggle part of the button is displayed. </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="a82ff49b58936c7982081821ffce90575"></a><!-- doxytag: member="Gtk::ToggleButton::property_inconsistent" ref="a82ff49b58936c7982081821ffce90575" 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::ToggleButton::property_inconsistent </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the toggle button is in an 'in between' state. </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="aa307db71584e2165b590e175b80feb5b"></a><!-- doxytag: member="Gtk::ToggleButton::property_inconsistent" ref="aa307db71584e2165b590e175b80feb5b" 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::ToggleButton::property_inconsistent </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the toggle button is in an 'in between' state. </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="a88f56cc3b99057fdffca3e0d0b5001a2"></a><!-- doxytag: member="Gtk::ToggleButton::set_active" ref="a88f56cc3b99057fdffca3e0d0b5001a2" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a4ee24bcd23c08ed5b01b3260e5eb320a"></a><!-- doxytag: member="Gtk::ToggleButton::set_inconsistent" ref="a4ee24bcd23c08ed5b01b3260e5eb320a" 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></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>
<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#a4ee24bcd23c08ed5b01b3260e5eb320a" title="If the user has selected a range of elements (such as some text or spreadsheet cells)...">set_inconsistent()</a> only affects visual appearance, it doesn't affect the semantics of the button. </p>
<dl><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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af989c82e500dd819c9253131d563b543"></a><!-- doxytag: member="Gtk::ToggleButton::set_mode" ref="af989c82e500dd819c9253131d563b543" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets whether the button is displayed as a separate indicator and label. </p>
<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>
<p>This function only affects instances of classes like <a class="el" href="classGtk_1_1CheckButton.html" title="Create widgets with a discrete toggle button.">Gtk::CheckButton</a> and <a class="el" href="classGtk_1_1RadioButton.html" title="A single radio button performs the same basic function as a Gtk::CheckButton, as...">Gtk::RadioButton</a> that derive from <a class="el" href="classGtk_1_1ToggleButton.html" title="A Gtk::ToggleButton will remain 'pressed-in' when clicked.">Gtk::ToggleButton</a>, not instances of <a class="el" href="classGtk_1_1ToggleButton.html" title="A Gtk::ToggleButton will remain 'pressed-in' when clicked.">Gtk::ToggleButton</a> itself. </p>
<dl><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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a85ce4ecde9214e112d1b739ba5fe6ef8"></a><!-- doxytag: member="Gtk::ToggleButton::signal_toggled" ref="a85ce4ecde9214e112d1b739ba5fe6ef8" 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_1SignalProxy0.html">Glib::SignalProxy0</a>< void > Gtk::ToggleButton::signal_toggled </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Emitted whenever the toggle tool button changes state. </p>
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_toggled()</code> </dd></dl>
</div>
</div>
<a class="anchor" id="a1fcff3b2f50b5a2e78b51339660f5c3a"></a><!-- doxytag: member="Gtk::ToggleButton::toggled" ref="a1fcff3b2f50b5a2e78b51339660f5c3a" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="aff198f3e8571926bffa8450220573901"></a><!-- doxytag: member="Gtk::ToggleButton::wrap" ref="aff198f3e8571926bffa8450220573901" 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><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/togglebutton.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:22:04 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
>
727
