<!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.Display.AccelLabel</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-Display-AccelLabel.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-Display-AccelLabel.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.Display.AccelLabel</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></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A label which displays an accelerator key on the right of the text
</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:AccelLabel">AccelLabel</a> </li><li class="src short"><span class="keyword">class</span> <a href="Graphics-UI-Gtk-Display-Label.html#t:LabelClass">LabelClass</a> o => <a href="#t:AccelLabelClass">AccelLabelClass</a> o </li><li class="src short"><a href="#v:castToAccelLabel">castToAccelLabel</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-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a></li><li class="src short"><a href="#v:gTypeAccelLabel">gTypeAccelLabel</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a></li><li class="src short"><a href="#v:toAccelLabel">toAccelLabel</a> :: <a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabelClass">AccelLabelClass</a> o => o -> <a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a></li><li class="src short"><a href="#v:accelLabelNew">accelLabelNew</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-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a></li><li class="src short"><a href="#v:accelLabelSetAccelWidget">accelLabelSetAccelWidget</a> :: (<a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabelClass">AccelLabelClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> accelWidget) => self -> accelWidget -> <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:accelLabelGetAccelWidget">accelLabelGetAccelWidget</a> :: <a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabelClass">AccelLabelClass</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-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a>)</li><li class="src short"><a href="#v:accelLabelAccelWidget">accelLabelAccelWidget</a> :: (<a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabelClass">AccelLabelClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> accelWidget) => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:ReadWriteAttr">ReadWriteAttr</a> self (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a>) accelWidget</li></ul></div><div id="interface"><h1 id="g:1">Detail
</h1><div class="doc"><p>The <code><a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a></code> widget is a subclass of <code><a href="Graphics-UI-Gtk-Display-Label.html#t:Label">Label</a></code> that also displays an
accelerator key on the right of the label text, e.g. 'Ctl+S'. It is
commonly used in menus to show the keyboard short-cuts for commands.
</p><p>The accelerator key to display is not set explicitly. Instead, the
<code><a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a></code> displays the accelerators which have been added to a particular
widget. This widget is set by calling <code><a href="Graphics-UI-Gtk-Display-AccelLabel.html#v:accelLabelSetAccelWidget">accelLabelSetAccelWidget</a></code>.
</p><p>For example, a <code><a href="Graphics-UI-Gtk-MenuComboToolbar-MenuItem.html#t:MenuItem">MenuItem</a></code> widget may have an accelerator added to emit
the "activate" signal when the 'Ctl+S' key combination is pressed. A
<code><a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a></code> is created and added to the <code><a href="Graphics-UI-Gtk-MenuComboToolbar-MenuItem.html#t:MenuItem">MenuItem</a></code>, and
<code><a href="Graphics-UI-Gtk-Display-AccelLabel.html#v:accelLabelSetAccelWidget">accelLabelSetAccelWidget</a></code> is called with the <code><a href="Graphics-UI-Gtk-MenuComboToolbar-MenuItem.html#t:MenuItem">MenuItem</a></code> as the second
argument. The <code><a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a></code> will now display 'Ctl+S' after its label.
</p><p>Note that creating a <code><a href="Graphics-UI-Gtk-MenuComboToolbar-MenuItem.html#t:MenuItem">MenuItem</a></code> with
<code>Graphics.UI.Gtk.MenuComboToolbar.MenuItem.menuItemNewWithLabel</code> (or one of
the similar functions for <code><a href="Graphics-UI-Gtk-MenuComboToolbar-CheckMenuItem.html#t:CheckMenuItem">CheckMenuItem</a></code> and <code><a href="Graphics-UI-Gtk-MenuComboToolbar-RadioMenuItem.html#t:RadioMenuItem">RadioMenuItem</a></code>) automatically
adds a <code><a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a></code> to the <code><a href="Graphics-UI-Gtk-MenuComboToolbar-MenuItem.html#t:MenuItem">MenuItem</a></code> and calls <code><a href="Graphics-UI-Gtk-Display-AccelLabel.html#v:accelLabelSetAccelWidget">accelLabelSetAccelWidget</a></code>
to set it up for you.
</p><p>An <code><a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a></code> will only display accelerators which have
<code>Graphics.UI.Gtk.Abstract.Widget.AccelVisible</code>
set (see <code>Graphics.UI.Gtk.Abstract.Widget.AccelFlags</code>).
A <code><a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a></code> can display multiple accelerators and
even signal names, though it is almost always used to display just one
accelerator key.
</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-Misc.html#t:Misc">Misc</a></code>
| +----<code><a href="Graphics-UI-Gtk-Display-Label.html#t:Label">Label</a></code>
| +----AccelLabel
</pre></div><h1 id="g:3">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:AccelLabel" class="def">AccelLabel</a> <a href="src/Graphics-UI-Gtk-Types.html#AccelLabel" class="link">Source</a></p><div class="subs instances"><p id="control.i:AccelLabel" class="caption collapser" onclick="toggleSection('i:AccelLabel')">Instances</p><div id="section.i:AccelLabel" 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-Display-AccelLabel.html#t:AccelLabel">AccelLabel</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-Display-AccelLabel.html#t:AccelLabel">AccelLabel</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-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabelClass">AccelLabelClass</a> <a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Display-Label.html#t:LabelClass">LabelClass</a> <a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Abstract-Misc.html#t:MiscClass">MiscClass</a> <a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabel">AccelLabel</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-Display-AccelLabel.html#t:AccelLabel">AccelLabel</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-Display-AccelLabel.html#t:AccelLabel">AccelLabel</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-Display-Label.html#t:LabelClass">LabelClass</a> o => <a name="t:AccelLabelClass" class="def">AccelLabelClass</a> o <a href="src/Graphics-UI-Gtk-Types.html#AccelLabelClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:AccelLabelClass" class="caption collapser" onclick="toggleSection('i:AccelLabelClass')">Instances</p><div id="section.i:AccelLabelClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabelClass">AccelLabelClass</a> <a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:castToAccelLabel" class="def">castToAccelLabel</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-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a><a href="src/Graphics-UI-Gtk-Types.html#castToAccelLabel" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:gTypeAccelLabel" class="def">gTypeAccelLabel</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a><a href="src/Graphics-UI-Gtk-Types.html#gTypeAccelLabel" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:toAccelLabel" class="def">toAccelLabel</a> :: <a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabelClass">AccelLabelClass</a> o => o -> <a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a><a href="src/Graphics-UI-Gtk-Types.html#toAccelLabel" class="link">Source</a></p></div><h1 id="g:4">Constructors
</h1><div class="top"><p class="src"><a name="v:accelLabelNew" class="def">accelLabelNew</a><a href="src/Graphics-UI-Gtk-Display-AccelLabel.html#accelLabelNew" 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>string</code> - the label string.
</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-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Creates a new <code><a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabel">AccelLabel</a></code>.
</p></div></div><h1 id="g:5">Methods
</h1><div class="top"><p class="src"><a name="v:accelLabelSetAccelWidget" class="def">accelLabelSetAccelWidget</a><a href="src/Graphics-UI-Gtk-Display-AccelLabel.html#accelLabelSetAccelWidget" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabelClass">AccelLabelClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> accelWidget)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> accelWidget</td><td class="doc"><p><code>accelWidget</code> - the widget to be monitored.
</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 widget to be monitored by this accelerator label.
</p></div></div><div class="top"><p class="src"><a name="v:accelLabelGetAccelWidget" class="def">accelLabelGetAccelWidget</a><a href="src/Graphics-UI-Gtk-Display-AccelLabel.html#accelLabelGetAccelWidget" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabelClass">AccelLabelClass</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-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a>)</td><td class="doc"><p>returns the object monitored by the accelerator
label, or <code>Nothing</code>.
</p></td></tr></table></div><div class="doc"><p>Fetches the widget monitored by this accelerator label. See
<code><a href="Graphics-UI-Gtk-Display-AccelLabel.html#v:accelLabelSetAccelWidget">accelLabelSetAccelWidget</a></code>.
</p></div></div><h1 id="g:6">Attributes
</h1><div class="top"><p class="src"><a name="v:accelLabelAccelWidget" class="def">accelLabelAccelWidget</a> :: (<a href="Graphics-UI-Gtk-Display-AccelLabel.html#t:AccelLabelClass">AccelLabelClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> accelWidget) => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:ReadWriteAttr">ReadWriteAttr</a> self (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a>) accelWidget<a href="src/Graphics-UI-Gtk-Display-AccelLabel.html#accelLabelAccelWidget" class="link">Source</a></p><div class="doc"><p>The widget to be monitored for accelerator changes.
</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>
