<?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>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>dist/build/Graphics/UI/Gtk/Display/AccelLabel.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>-- GENERATED by C->Haskell Compiler, version 0.13.4 (gtk2hs branch) "Bin IO", 13 Nov 2004 (Haskell)</span>
<a name="line-2"></a><span class='hs-comment'>-- Edit the ORIGNAL .chs file instead!</span>
<a name="line-3"></a>
<a name="line-4"></a>
<a name="line-5"></a><span class='hs-comment'>{-# LINE 1 "./Graphics/UI/Gtk/Display/AccelLabel.chs" #-}</span>
<a name="line-6"></a><span class='hs-comment'>-- -*-haskell-*-</span>
<a name="line-7"></a><span class='hs-comment'>-- GIMP Toolkit (GTK) Widget AccelLabel</span>
<a name="line-8"></a><span class='hs-comment'>--</span>
<a name="line-9"></a><span class='hs-comment'>-- Author : Axel Simon</span>
<a name="line-10"></a><span class='hs-comment'>--</span>
<a name="line-11"></a><span class='hs-comment'>-- Created: 23 May 2001</span>
<a name="line-12"></a><span class='hs-comment'>--</span>
<a name="line-13"></a><span class='hs-comment'>-- Copyright (C) 1999-2005 Axel Simon</span>
<a name="line-14"></a><span class='hs-comment'>--</span>
<a name="line-15"></a><span class='hs-comment'>-- This library is free software; you can redistribute it and/or</span>
<a name="line-16"></a><span class='hs-comment'>-- modify it under the terms of the GNU Lesser General Public</span>
<a name="line-17"></a><span class='hs-comment'>-- License as published by the Free Software Foundation; either</span>
<a name="line-18"></a><span class='hs-comment'>-- version 2.1 of the License, or (at your option) any later version.</span>
<a name="line-19"></a><span class='hs-comment'>--</span>
<a name="line-20"></a><span class='hs-comment'>-- This library is distributed in the hope that it will be useful,</span>
<a name="line-21"></a><span class='hs-comment'>-- but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="line-22"></a><span class='hs-comment'>-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="line-23"></a><span class='hs-comment'>-- Lesser General Public License for more details.</span>
<a name="line-24"></a><span class='hs-comment'>--</span>
<a name="line-25"></a><span class='hs-comment'>-- |</span>
<a name="line-26"></a><span class='hs-comment'>-- Maintainer : gtk2hs-users@lists.sourceforge.net</span>
<a name="line-27"></a><span class='hs-comment'>-- Stability : provisional</span>
<a name="line-28"></a><span class='hs-comment'>-- Portability : portable (depends on GHC)</span>
<a name="line-29"></a><span class='hs-comment'>--</span>
<a name="line-30"></a><span class='hs-comment'>-- A label which displays an accelerator key on the right of the text</span>
<a name="line-31"></a><span class='hs-comment'>--</span>
<a name="line-32"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>Gtk</span><span class='hs-varop'>.</span><span class='hs-conid'>Display</span><span class='hs-varop'>.</span><span class='hs-conid'>AccelLabel</span> <span class='hs-layout'>(</span>
<a name="line-33"></a><span class='hs-comment'>-- * Detail</span>
<a name="line-34"></a><span class='hs-comment'>-- </span>
<a name="line-35"></a><span class='hs-comment'>-- | The 'AccelLabel' widget is a subclass of 'Label' that also displays an</span>
<a name="line-36"></a><span class='hs-comment'>-- accelerator key on the right of the label text, e.g. \'Ctl+S\'. It is</span>
<a name="line-37"></a><span class='hs-comment'>-- commonly used in menus to show the keyboard short-cuts for commands.</span>
<a name="line-38"></a><span class='hs-comment'>--</span>
<a name="line-39"></a><span class='hs-comment'>-- The accelerator key to display is not set explicitly. Instead, the</span>
<a name="line-40"></a><span class='hs-comment'>-- 'AccelLabel' displays the accelerators which have been added to a particular</span>
<a name="line-41"></a><span class='hs-comment'>-- widget. This widget is set by calling 'accelLabelSetAccelWidget'.</span>
<a name="line-42"></a><span class='hs-comment'>--</span>
<a name="line-43"></a><span class='hs-comment'>-- For example, a 'MenuItem' widget may have an accelerator added to emit</span>
<a name="line-44"></a><span class='hs-comment'>-- the \"activate\" signal when the \'Ctl+S\' key combination is pressed. A</span>
<a name="line-45"></a><span class='hs-comment'>-- 'AccelLabel' is created and added to the 'MenuItem', and</span>
<a name="line-46"></a><span class='hs-comment'>-- 'accelLabelSetAccelWidget' is called with the 'MenuItem' as the second</span>
<a name="line-47"></a><span class='hs-comment'>-- argument. The 'AccelLabel' will now display \'Ctl+S\' after its label.</span>
<a name="line-48"></a><span class='hs-comment'>--</span>
<a name="line-49"></a><span class='hs-comment'>-- Note that creating a 'MenuItem' with </span>
<a name="line-50"></a><span class='hs-comment'>-- 'Graphics.UI.Gtk.MenuComboToolbar.MenuItem.menuItemNewWithLabel' (or one of</span>
<a name="line-51"></a><span class='hs-comment'>-- the similar functions for 'CheckMenuItem' and 'RadioMenuItem') automatically</span>
<a name="line-52"></a><span class='hs-comment'>-- adds a 'AccelLabel' to the 'MenuItem' and calls 'accelLabelSetAccelWidget'</span>
<a name="line-53"></a><span class='hs-comment'>-- to set it up for you.</span>
<a name="line-54"></a><span class='hs-comment'>--</span>
<a name="line-55"></a><span class='hs-comment'>-- An 'AccelLabel' will only display accelerators which have</span>
<a name="line-56"></a><span class='hs-comment'>-- 'Graphics.UI.Gtk.Abstract.Widget.AccelVisible'</span>
<a name="line-57"></a><span class='hs-comment'>-- set (see 'Graphics.UI.Gtk.Abstract.Widget.AccelFlags').</span>
<a name="line-58"></a><span class='hs-comment'>-- A 'AccelLabel' can display multiple accelerators and</span>
<a name="line-59"></a><span class='hs-comment'>-- even signal names, though it is almost always used to display just one</span>
<a name="line-60"></a><span class='hs-comment'>-- accelerator key.</span>
<a name="line-61"></a>
<a name="line-62"></a><span class='hs-comment'>-- * Class Hierarchy</span>
<a name="line-63"></a><span class='hs-comment'>-- |</span>
<a name="line-64"></a><span class='hs-comment'>-- @</span>
<a name="line-65"></a><span class='hs-comment'>-- | 'GObject'</span>
<a name="line-66"></a><span class='hs-comment'>-- | +----'Object'</span>
<a name="line-67"></a><span class='hs-comment'>-- | +----'Widget'</span>
<a name="line-68"></a><span class='hs-comment'>-- | +----'Misc'</span>
<a name="line-69"></a><span class='hs-comment'>-- | +----'Label'</span>
<a name="line-70"></a><span class='hs-comment'>-- | +----AccelLabel</span>
<a name="line-71"></a><span class='hs-comment'>-- @</span>
<a name="line-72"></a>
<a name="line-73"></a><span class='hs-comment'>-- * Types</span>
<a name="line-74"></a> <span class='hs-conid'>AccelLabel</span><span class='hs-layout'>,</span>
<a name="line-75"></a> <span class='hs-conid'>AccelLabelClass</span><span class='hs-layout'>,</span>
<a name="line-76"></a> <span class='hs-varid'>castToAccelLabel</span><span class='hs-layout'>,</span> <span class='hs-varid'>gTypeAccelLabel</span><span class='hs-layout'>,</span>
<a name="line-77"></a> <span class='hs-varid'>toAccelLabel</span><span class='hs-layout'>,</span>
<a name="line-78"></a>
<a name="line-79"></a><span class='hs-comment'>-- * Constructors</span>
<a name="line-80"></a> <span class='hs-varid'>accelLabelNew</span><span class='hs-layout'>,</span>
<a name="line-81"></a>
<a name="line-82"></a><span class='hs-comment'>-- * Methods</span>
<a name="line-83"></a> <span class='hs-varid'>accelLabelSetAccelWidget</span><span class='hs-layout'>,</span>
<a name="line-84"></a> <span class='hs-varid'>accelLabelGetAccelWidget</span><span class='hs-layout'>,</span>
<a name="line-85"></a>
<a name="line-86"></a><span class='hs-comment'>-- * Attributes</span>
<a name="line-87"></a> <span class='hs-varid'>accelLabelAccelWidget</span><span class='hs-layout'>,</span>
<a name="line-88"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-89"></a>
<a name="line-90"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span> <span class='hs-layout'>(</span><span class='hs-varid'>liftM</span><span class='hs-layout'>)</span>
<a name="line-91"></a>
<a name="line-92"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Glib</span><span class='hs-varop'>.</span><span class='hs-conid'>FFI</span>
<a name="line-93"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Glib</span><span class='hs-varop'>.</span><span class='hs-conid'>UTFString</span>
<a name="line-94"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Glib</span><span class='hs-varop'>.</span><span class='hs-conid'>Attributes</span>
<a name="line-95"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>Gtk</span><span class='hs-varop'>.</span><span class='hs-conid'>Abstract</span><span class='hs-varop'>.</span><span class='hs-conid'>Object</span> <span class='hs-layout'>(</span><span class='hs-varid'>makeNewObject</span><span class='hs-layout'>)</span>
<a name="line-96"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>Gtk</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span>
<a name="line-97"></a><span class='hs-comment'>{-# LINE 91 "./Graphics/UI/Gtk/Display/AccelLabel.chs" #-}</span>
<a name="line-98"></a>
<a name="line-99"></a>
<a name="line-100"></a><span class='hs-comment'>{-# LINE 93 "./Graphics/UI/Gtk/Display/AccelLabel.chs" #-}</span>
<a name="line-101"></a>
<a name="line-102"></a><span class='hs-comment'>--------------------</span>
<a name="line-103"></a><span class='hs-comment'>-- Constructors</span>
<a name="line-104"></a>
<a name="line-105"></a><a name="accelLabelNew"></a><span class='hs-comment'>-- | Creates a new 'AccelLabel'.</span>
<a name="line-106"></a><span class='hs-comment'>--</span>
<a name="line-107"></a><span class='hs-definition'>accelLabelNew</span> <span class='hs-keyglyph'>::</span>
<a name="line-108"></a> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ @string@ - the label string.</span>
<a name="line-109"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>AccelLabel</span>
<a name="line-110"></a><span class='hs-definition'>accelLabelNew</span> <span class='hs-varid'>string</span> <span class='hs-keyglyph'>=</span>
<a name="line-111"></a> <span class='hs-varid'>makeNewObject</span> <span class='hs-varid'>mkAccelLabel</span> <span class='hs-varop'>$</span>
<a name="line-112"></a> <span class='hs-varid'>liftM</span> <span class='hs-layout'>(</span><span class='hs-varid'>castPtr</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>Widget</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>AccelLabel</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-113"></a> <span class='hs-varid'>withUTFString</span> <span class='hs-varid'>string</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>stringPtr</span> <span class='hs-keyglyph'>-></span>
<a name="line-114"></a> <span class='hs-varid'>gtk_accel_label_new</span>
<a name="line-115"></a><span class='hs-comment'>{-# LINE 107 "./Graphics/UI/Gtk/Display/AccelLabel.chs" #-}</span>
<a name="line-116"></a> <span class='hs-varid'>stringPtr</span>
<a name="line-117"></a>
<a name="line-118"></a><span class='hs-comment'>--------------------</span>
<a name="line-119"></a><span class='hs-comment'>-- Methods</span>
<a name="line-120"></a>
<a name="line-121"></a><a name="accelLabelSetAccelWidget"></a><span class='hs-comment'>-- | Sets the widget to be monitored by this accelerator label.</span>
<a name="line-122"></a><span class='hs-comment'>--</span>
<a name="line-123"></a><span class='hs-definition'>accelLabelSetAccelWidget</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>AccelLabelClass</span> <span class='hs-varid'>self</span><span class='hs-layout'>,</span> <span class='hs-conid'>WidgetClass</span> <span class='hs-varid'>accelWidget</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span>
<a name="line-124"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>accelWidget</span> <span class='hs-comment'>-- ^ @accelWidget@ - the widget to be monitored.</span>
<a name="line-125"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-126"></a><span class='hs-definition'>accelLabelSetAccelWidget</span> <span class='hs-varid'>self</span> <span class='hs-varid'>accelWidget</span> <span class='hs-keyglyph'>=</span>
<a name="line-127"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>AccelLabel</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>Widget</span> <span class='hs-varid'>arg2</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg2</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr2</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_accel_label_set_accel_widget</span> <span class='hs-varid'>argPtr1</span> <span class='hs-varid'>argPtr2</span><span class='hs-layout'>)</span>
<a name="line-128"></a><span class='hs-comment'>{-# LINE 119 "./Graphics/UI/Gtk/Display/AccelLabel.chs" #-}</span>
<a name="line-129"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toAccelLabel</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span>
<a name="line-130"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toWidget</span> <span class='hs-varid'>accelWidget</span><span class='hs-layout'>)</span>
<a name="line-131"></a>
<a name="line-132"></a><a name="accelLabelGetAccelWidget"></a><span class='hs-comment'>-- | Fetches the widget monitored by this accelerator label. See</span>
<a name="line-133"></a><span class='hs-comment'>-- 'accelLabelSetAccelWidget'.</span>
<a name="line-134"></a><span class='hs-comment'>--</span>
<a name="line-135"></a><span class='hs-definition'>accelLabelGetAccelWidget</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>AccelLabelClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span>
<a name="line-136"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>Widget</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- ^ returns the object monitored by the accelerator</span>
<a name="line-137"></a> <span class='hs-comment'>-- label, or @Nothing@.</span>
<a name="line-138"></a><span class='hs-definition'>accelLabelGetAccelWidget</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=</span>
<a name="line-139"></a> <span class='hs-varid'>maybeNull</span> <span class='hs-layout'>(</span><span class='hs-varid'>makeNewObject</span> <span class='hs-varid'>mkWidget</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-140"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>AccelLabel</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_accel_label_get_accel_widget</span> <span class='hs-varid'>argPtr1</span><span class='hs-layout'>)</span>
<a name="line-141"></a><span class='hs-comment'>{-# LINE 131 "./Graphics/UI/Gtk/Display/AccelLabel.chs" #-}</span>
<a name="line-142"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toAccelLabel</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span>
<a name="line-143"></a>
<a name="line-144"></a><span class='hs-comment'>--------------------</span>
<a name="line-145"></a><span class='hs-comment'>-- Attributes</span>
<a name="line-146"></a>
<a name="line-147"></a><a name="accelLabelAccelWidget"></a><span class='hs-comment'>-- | The widget to be monitored for accelerator changes.</span>
<a name="line-148"></a><span class='hs-comment'>--</span>
<a name="line-149"></a><span class='hs-definition'>accelLabelAccelWidget</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>AccelLabelClass</span> <span class='hs-varid'>self</span><span class='hs-layout'>,</span> <span class='hs-conid'>WidgetClass</span> <span class='hs-varid'>accelWidget</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>ReadWriteAttr</span> <span class='hs-varid'>self</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>Widget</span><span class='hs-layout'>)</span> <span class='hs-varid'>accelWidget</span>
<a name="line-150"></a><span class='hs-definition'>accelLabelAccelWidget</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>newAttr</span>
<a name="line-151"></a> <span class='hs-varid'>accelLabelGetAccelWidget</span>
<a name="line-152"></a> <span class='hs-varid'>accelLabelSetAccelWidget</span>
<a name="line-153"></a>
<a name="line-154"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"gtk_accel_label_new"</span>
<a name="line-155"></a> <span class='hs-varid'>gtk_accel_label_new</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>CChar</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>Widget</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-156"></a>
<a name="line-157"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>safe</span> <span class='hs-str'>"gtk_accel_label_set_accel_widget"</span>
<a name="line-158"></a> <span class='hs-varid'>gtk_accel_label_set_accel_widget</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>AccelLabel</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>Widget</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-159"></a>
<a name="line-160"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"gtk_accel_label_get_accel_widget"</span>
<a name="line-161"></a> <span class='hs-varid'>gtk_accel_label_get_accel_widget</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>AccelLabel</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>Widget</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
</pre></body>
</html>
