<?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 GtkToggleAction</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_GtkTextView.html">Previous: Class GtkTextView</a></li>
<li class="next"><a href="gtk_GtkToggleButton.html">Next: Class GtkToggleButton</a></li>
<li class="clear"></li>
</ul><div id="page_body"><h1><span class="toc_number">10.120</span>Class GtkToggleAction</h1><p class="brief">An action which can be toggled between two states </p>
<pre class="prototype">Class GtkToggleAction( [name],[label],[tooltip],[stock_id] )</pre>
<table class="prototype">
<tbody><tr class="optparam"><td class="name">name</td><td class="content"> A unique name for the action </td></tr>
<tr class="optparam"><td class="name">label</td><td class="content"> The label displayed in menu items and on buttons </td></tr>
<tr class="optparam"><td class="name">tooltip</td><td class="content"> A tooltip for the action </td></tr>
<tr class="optparam"><td class="name">stock_id</td><td class="content"> The stock icon to display in widgets representing the action </td></tr>
</tbody>
</table>
<p>A GtkToggleAction corresponds roughly to a GtkCheckMenuItem. It has an "active" state specifying whether the action has been checked or not. </p>
<p>To add the action to a GtkActionGroup and set the accelerator for the action, call gtk_action_group_add_action_with_accel(). </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>Returns the checked state of the toggle action. </td></tr>
<tr><td><a href="#get_draw_as_radio">get_draw_as_radio</a></td><td>Returns whether the action should have proxies like a radio action. </td></tr>
<tr><td><a href="#set_active">set_active</a></td><td>Sets the checked state on the toggle action. </td></tr>
<tr><td><a href="#set_draw_as_radio">set_draw_as_radio</a></td><td>Sets whether the action should have proxies like a radio action. </td></tr>
<tr><td><a href="#signal_toggled">signal_toggled</a></td><td>Connect a VMSlot to the action toggled signal and return it </td></tr>
<tr><td><a href="#toggled">toggled</a></td><td>Emits the "toggled" signal on the toggle action. </td></tr>
</tbody>
</table>
<h2>Methods</h2><h3><a name="get_active">get_active</a></h3><p class="brief">Returns the checked state of the toggle action. </p>
<pre class="prototype">GtkToggleAction.get_active()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">the checked state of the toggle action </td></tr>
</tbody>
</table>
<h3><a name="get_draw_as_radio">get_draw_as_radio</a></h3><p class="brief">Returns whether the action should have proxies like a radio action. </p>
<pre class="prototype">GtkToggleAction.get_draw_as_radio()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">whether the action should have proxies like a radio action. </td></tr>
</tbody>
</table>
<h3><a name="set_active">set_active</a></h3><p class="brief">Sets the checked state on the toggle action. </p>
<pre class="prototype">GtkToggleAction.set_active( is_active )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">is_active</td><td class="content"> (boolean) whether the action should be checked or not </td></tr>
</tbody>
</table>
<h3><a name="set_draw_as_radio">set_draw_as_radio</a></h3><p class="brief">Sets whether the action should have proxies like a radio action. </p>
<pre class="prototype">GtkToggleAction.set_draw_as_radio( draw_as_radio )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">draw_as_radio</td><td class="content"> (boolean) whether the action should have proxies like a radio action </td></tr>
</tbody>
</table>
<h3><a name="signal_toggled">signal_toggled</a></h3><p class="brief">Connect a VMSlot to the action toggled signal and return it </p>
<pre class="prototype">GtkToggleAction.signal_toggled()</pre>
<h3><a name="toggled">toggled</a></h3><p class="brief">Emits the "toggled" signal on the toggle action. </p>
<pre class="prototype">GtkToggleAction.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_GtkTextView.html">Previous: Class GtkTextView</a></li>
<li class="next"><a href="gtk_GtkToggleButton.html">Next: Class GtkToggleButton</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>
