<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" >
<head><meta content="text/html;charset=&quot;utf-8&quot;" http-equiv="Content-type"/><link href="faldoc.css" rel="stylesheet" type="text/css"/><title> - Class GtkToggleToolButton</title></head><body class="faldoc"><ul class="navi_top"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="gtk.html">Up: The Falcon GTK Binding module</a></li>
<li class="prev"><a href="gtk_GtkToggleButton.html">Previous: Class GtkToggleButton</a></li>
<li class="next"><a href="gtk_GtkToolButton.html">Next: Class GtkToolButton</a></li>
<li class="clear"></li>
</ul><div id="page_body"><h1><span class="toc_number">10.122</span>Class GtkToggleToolButton</h1><p class="brief">A GtkToolItem containing a toggle button </p>
<pre class="prototype">Class GtkToggleToolButton</pre>
<p>A GtkToggleToolButton is a GtkToolItem that contains a toggle button. </p>
<table class="members">
<tbody><tr class="member_type"><td class="member_type" colspan="2">Methods</td></tr>
<tr><td><a href="#get_active">get_active</a></td><td>Queries a GtkToggleToolButton and returns its current state. </td></tr>
<tr><td><a href="#new_from_stock">new_from_stock</a></td><td>Creates a new GtkToggleToolButton containing the image and text from a stock item. </td></tr>
<tr><td><a href="#set_active">set_active</a></td><td>Sets the status of the toggle tool button. </td></tr>
<tr><td><a href="#signal_toggled">signal_toggled</a></td><td>Emitted whenever the toggle tool button changes state. </td></tr>
</tbody>
</table>
<h2>Methods</h2><h3><a name="get_active">get_active</a></h3><p class="brief">Queries a GtkToggleToolButton and returns its current state. </p>
<pre class="prototype">GtkToggleToolButton.get_active()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">TRUE if the toggle tool button is pressed in, FALSE if not </td></tr>
</tbody>
</table>
<p>Returns TRUE if the toggle button is pressed in and FALSE if it is raised. </p>
<h3><a name="new_from_stock">new_from_stock</a></h3><p class="brief">Creates a new GtkToggleToolButton containing the image and text from a stock item. </p>
<pre class="prototype">GtkToggleToolButton.new_from_stock( stock_id )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">stock_id</td><td class="content"> the name of the stock item </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">A new GtkToggleToolButton </td></tr>
</tbody>
</table>
<p>Some stock ids have preprocessor macros like GTK_STOCK_OK and GTK_STOCK_APPLY. </p>
<p>It is an error if stock_id is not a name of a stock item. </p>
<h3><a name="set_active">set_active</a></h3><p class="brief">Sets the status of the toggle tool button. </p>
<pre class="prototype">GtkToggleToolButton.set_active( is_active )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">is_active</td><td class="content"> whether button should be active </td></tr>
</tbody>
</table>
<p>Set to TRUE if you want the GtkToggleButton to be 'pressed in', and FALSE to raise it. This action causes the toggled signal to be emitted. </p>
<h3><a name="signal_toggled">signal_toggled</a></h3><p class="brief">Emitted whenever the toggle tool button changes state. </p>
<pre class="prototype">GtkToggleToolButton.signal_toggled()</pre>
</div><ul class="navi_bottom"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="gtk.html">Up: The Falcon GTK Binding module</a></li>
<li class="prev"><a href="gtk_GtkToggleButton.html">Previous: Class GtkToggleButton</a></li>
<li class="next"><a href="gtk_GtkToolButton.html">Next: Class GtkToolButton</a></li>
<li class="clear"></li>
</ul><div class="signature">Made with <a href="faldoc 3.0">http://www.falconpl.org</a></div></body></html>
