<!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/html; charset=UTF-8" /><title>Graphics.UI.Gtk.Buttons.ToggleButton</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Graphics-UI-Gtk-Buttons-ToggleButton.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">gtk-0.12.0: Binding to the Gtk+ graphical user interface library.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable (depends on GHC)</td></tr><tr><th>Stability</th><td>provisional</td></tr><tr><th>Maintainer</th><td>gtk2hs-users@lists.sourceforge.net</td></tr></table><p class="caption">Graphics.UI.Gtk.Buttons.ToggleButton</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Detail
</a></li><li><a href="#g:2">Class Hierarchy
</a></li><li><a href="#g:3">Types
</a></li><li><a href="#g:4">Constructors
</a></li><li><a href="#g:5">Methods
</a></li><li><a href="#g:6">Attributes
</a></li><li><a href="#g:7">Signals
</a></li><li><a href="#g:8">Deprecated
</a></li><li><a href="#g:9">Signals
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Create buttons which retain their state
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:ToggleButton">ToggleButton</a> </li><li class="src short"><span class="keyword">class</span> <a href="Graphics-UI-Gtk-Buttons-Button.html#t:ButtonClass">ButtonClass</a> o => <a href="#t:ToggleButtonClass">ToggleButtonClass</a> o </li><li class="src short"><a href="#v:castToToggleButton">castToToggleButton</a> :: <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> obj => obj -> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></li><li class="src short"><a href="#v:gTypeToggleButton">gTypeToggleButton</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a></li><li class="src short"><a href="#v:toToggleButton">toToggleButton</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> o => o -> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></li><li class="src short"><a href="#v:toggleButtonNew">toggleButtonNew</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></li><li class="src short"><a href="#v:toggleButtonNewWithLabel">toggleButtonNewWithLabel</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></li><li class="src short"><a href="#v:toggleButtonNewWithMnemonic">toggleButtonNewWithMnemonic</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></li><li class="src short"><a href="#v:toggleButtonSetMode">toggleButtonSetMode</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:toggleButtonGetMode">toggleButtonGetMode</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:toggleButtonToggled">toggleButtonToggled</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:toggleButtonGetActive">toggleButtonGetActive</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:toggleButtonSetActive">toggleButtonSetActive</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:toggleButtonGetInconsistent">toggleButtonGetInconsistent</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:toggleButtonSetInconsistent">toggleButtonSetInconsistent</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:toggleButtonActive">toggleButtonActive</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:toggleButtonInconsistent">toggleButtonInconsistent</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:toggleButtonDrawIndicator">toggleButtonDrawIndicator</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:toggleButtonMode">toggleButtonMode</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:toggled">toggled</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li><li class="src short"><a href="#v:onToggled">onToggled</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:ConnectId">ConnectId</a> self)</li><li class="src short"><a href="#v:afterToggled">afterToggled</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:ConnectId">ConnectId</a> self)</li></ul></div><div id="interface"><h1 id="g:1">Detail
</h1><div class="doc"><p>A <code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></code> is a <code><a href="Graphics-UI-Gtk-Buttons-Button.html#t:Button">Button</a></code> which will remain 'pressed-in' when
clicked. Clicking again will cause the toggle button to return to its normal
state.
</p><p>A toggle button is created by calling either <code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#v:toggleButtonNew">toggleButtonNew</a></code> or
<code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#v:toggleButtonNewWithLabel">toggleButtonNewWithLabel</a></code>. If using the former, it is advisable to pack a
widget, (such as a <code><a href="Graphics-UI-Gtk-Display-Label.html#t:Label">Label</a></code> and/or a <code><a href="Graphics-UI-Gtk-Gdk-Pixmap.html#t:Pixmap">Pixmap</a></code>), into the toggle button's
container. (See <code><a href="Graphics-UI-Gtk-Buttons-Button.html#t:Button">Button</a></code> for more information).
</p><p>The state of a <code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></code> can be set specifically using
<code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#v:toggleButtonSetActive">toggleButtonSetActive</a></code>, and retrieved using <code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#v:toggleButtonGetActive">toggleButtonGetActive</a></code>.
</p><p>To simply switch the state of a toggle button, use <code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#v:toggleButtonToggled">toggleButtonToggled</a></code>.
</p></div><h1 id="g:2">Class Hierarchy
</h1><div class="doc"><pre>
| <code><a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObject">GObject</a></code>
| +----<code><a href="Graphics-UI-Gtk-Abstract-Object.html#t:Object">Object</a></code>
| +----<code><a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a></code>
| +----<code><a href="Graphics-UI-Gtk-Abstract-Container.html#t:Container">Container</a></code>
| +----<code><a href="Graphics-UI-Gtk-Abstract-Bin.html#t:Bin">Bin</a></code>
| +----<code><a href="Graphics-UI-Gtk-Buttons-Button.html#t:Button">Button</a></code>
| +----ToggleButton
| +----<code><a href="Graphics-UI-Gtk-Buttons-CheckButton.html#t:CheckButton">CheckButton</a></code>
</pre></div><h1 id="g:3">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ToggleButton" class="def">ToggleButton</a> <a href="src/Graphics-UI-Gtk-Types.html#ToggleButton" class="link">Source</a></p><div class="subs instances"><p id="control.i:ToggleButton" class="caption collapser" onclick="toggleSection('i:ToggleButton')">Instances</p><div id="section.i:ToggleButton" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Buttons-Button.html#t:ButtonClass">ButtonClass</a> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Abstract-Bin.html#t:BinClass">BinClass</a> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Abstract-Container.html#t:ContainerClass">ContainerClass</a> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Abstract-Object.html#t:ObjectClass">ObjectClass</a> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a href="Graphics-UI-Gtk-Buttons-Button.html#t:ButtonClass">ButtonClass</a> o => <a name="t:ToggleButtonClass" class="def">ToggleButtonClass</a> o <a href="src/Graphics-UI-Gtk-Types.html#ToggleButtonClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:ToggleButtonClass" class="caption collapser" onclick="toggleSection('i:ToggleButtonClass')">Instances</p><div id="section.i:ToggleButtonClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> <a href="Graphics-UI-Gtk-Buttons-RadioButton.html#t:RadioButton">RadioButton</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> <a href="Graphics-UI-Gtk-Buttons-CheckButton.html#t:CheckButton">CheckButton</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:castToToggleButton" class="def">castToToggleButton</a> :: <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> obj => obj -> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a><a href="src/Graphics-UI-Gtk-Types.html#castToToggleButton" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:gTypeToggleButton" class="def">gTypeToggleButton</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a><a href="src/Graphics-UI-Gtk-Types.html#gTypeToggleButton" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:toToggleButton" class="def">toToggleButton</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> o => o -> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a><a href="src/Graphics-UI-Gtk-Types.html#toToggleButton" class="link">Source</a></p></div><h1 id="g:4">Constructors
</h1><div class="top"><p class="src"><a name="v:toggleButtonNew" class="def">toggleButtonNew</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a><a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#toggleButtonNew" class="link">Source</a></p><div class="doc"><p>Creates a new toggle button. A widget should be packed into the button,
as in <code>Graphics.UI.Gtk.Buttons.Button.buttonNew</code>.
</p></div></div><div class="top"><p class="src"><a name="v:toggleButtonNewWithLabel" class="def">toggleButtonNewWithLabel</a><a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#toggleButtonNewWithLabel" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p><code>label</code> - a string containing the message to be
placed in the toggle button.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Creates a new toggle button with a text label.
</p></div></div><div class="top"><p class="src"><a name="v:toggleButtonNewWithMnemonic" class="def">toggleButtonNewWithMnemonic</a><a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#toggleButtonNewWithMnemonic" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p><code>label</code> - the text of the button, with an underscore
in front of the mnemonic character
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Creates a new <code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></code> containing a label. The label will be
created using <code>Graphics.UI.Gtk.Display.Label.labelNewWithMnemonic</code>,
so underscores in <code>label</code> indicate the
mnemonic for the button.
</p></div></div><h1 id="g:5">Methods
</h1><div class="top"><p class="src"><a name="v:toggleButtonSetMode" class="def">toggleButtonSetMode</a><a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#toggleButtonSetMode" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p><code>drawIndicator</code> - if <code>True</code>, draw the button as a separate
indicator and label; if <code>False</code>, draw the button like a normal
button
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Sets whether the button is displayed as a separate indicator and label.
You can call this function on a <code><a href="Graphics-UI-Gtk-Buttons-CheckButton.html#t:CheckButton">CheckButton</a></code> or a <code><a href="Graphics-UI-Gtk-Buttons-RadioButton.html#t:RadioButton">RadioButton</a></code> with <code>False</code>
to make the button look like a normal button.
</p><p>This function only affects instances of classes like <code><a href="Graphics-UI-Gtk-Buttons-CheckButton.html#t:CheckButton">CheckButton</a></code> and
<code><a href="Graphics-UI-Gtk-Buttons-RadioButton.html#t:RadioButton">RadioButton</a></code> that derive from <code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></code>, not instances of
<code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></code> itself.
</p></div></div><div class="top"><p class="src"><a name="v:toggleButtonGetMode" class="def">toggleButtonGetMode</a><a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#toggleButtonGetMode" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>returns <code>True</code> if the togglebutton is drawn as a separate
indicator and label.
</p></td></tr></table></div><div class="doc"><p>Retrieves whether the button is displayed as a separate indicator and
label. See <code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#v:toggleButtonSetMode">toggleButtonSetMode</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:toggleButtonToggled" class="def">toggleButtonToggled</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#toggleButtonToggled" class="link">Source</a></p><div class="doc"><p>Emits the toggled signal on the <code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></code>. There is no good reason
for an application ever to call this function.
</p></div></div><div class="top"><p class="src"><a name="v:toggleButtonGetActive" class="def">toggleButtonGetActive</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#toggleButtonGetActive" class="link">Source</a></p><div class="doc"><p>Queries a <code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></code> and returns its current state. Returns <code>True</code> if
the toggle button is pressed in and <code>False</code> if it is raised.
</p></div></div><div class="top"><p class="src"><a name="v:toggleButtonSetActive" class="def">toggleButtonSetActive</a><a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#toggleButtonSetActive" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p><code>isActive</code> - <code>True</code> or <code>False</code>.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Sets the status of the toggle button. Set to <code>True</code> if you want the
<code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButton">ToggleButton</a></code> to be 'pressed in', and <code>False</code> to raise it. This action
causes the toggled signal to be emitted.
</p></div></div><div class="top"><p class="src"><a name="v:toggleButtonGetInconsistent" class="def">toggleButtonGetInconsistent</a><a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#toggleButtonGetInconsistent" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>returns <code>True</code> if the button is displayed as inconsistent,
<code>False</code> otherwise
</p></td></tr></table></div><div class="doc"><p>Gets the value set by <code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#v:toggleButtonSetInconsistent">toggleButtonSetInconsistent</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:toggleButtonSetInconsistent" class="def">toggleButtonSetInconsistent</a><a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#toggleButtonSetInconsistent" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p><code>setting</code> - <code>True</code> if state is inconsistent
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><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. 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,
<code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#v:toggleButtonSetInconsistent">toggleButtonSetInconsistent</a></code> only affects visual appearance, it doesn't
affect the semantics of the button.
</p></div></div><h1 id="g:6">Attributes
</h1><div class="top"><p class="src"><a name="v:toggleButtonActive" class="def">toggleButtonActive</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#toggleButtonActive" class="link">Source</a></p><div class="doc"><p>If the toggle button should be pressed in or not.
</p><p>Default value: <code>False</code>
</p></div></div><div class="top"><p class="src"><a name="v:toggleButtonInconsistent" class="def">toggleButtonInconsistent</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#toggleButtonInconsistent" class="link">Source</a></p><div class="doc"><p>If the toggle button is in an "in between" state.
</p><p>Default value: <code>False</code>
</p></div></div><div class="top"><p class="src"><a name="v:toggleButtonDrawIndicator" class="def">toggleButtonDrawIndicator</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#toggleButtonDrawIndicator" class="link">Source</a></p><div class="doc"><p>If the toggle part of the button is displayed.
</p><p>Default value: <code>False</code>
</p></div></div><div class="top"><p class="src"><a name="v:toggleButtonMode" class="def">toggleButtonMode</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#toggleButtonMode" class="link">Source</a></p><div class="doc"><p>'mode' property. See <code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#v:toggleButtonGetMode">toggleButtonGetMode</a></code> and <code><a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#v:toggleButtonSetMode">toggleButtonSetMode</a></code>
</p></div></div><h1 id="g:7">Signals
</h1><div class="top"><p class="src"><a name="v:toggled" class="def">toggled</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#toggled" class="link">Source</a></p><div class="doc"><p>Should be connected if you wish to perform an action whenever the
<code>ToggleButton'</code>s state is changed.
</p></div></div><h1 id="g:8">Deprecated
</h1><h1 id="g:9">Signals
</h1><div class="top"><p class="src"><a name="v:onToggled" class="def">onToggled</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:ConnectId">ConnectId</a> self)<a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#onToggled" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:afterToggled" class="def">afterToggled</a> :: <a href="Graphics-UI-Gtk-Buttons-ToggleButton.html#t:ToggleButtonClass">ToggleButtonClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:ConnectId">ConnectId</a> self)<a href="src/Graphics-UI-Gtk-Buttons-ToggleButton.html#afterToggled" class="link">Source</a></p><div class="doc"><p>Whenever the state of the button is changed, the toggled signal is
emitted.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
