<?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/Glade.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a>
<a name="line-2"></a><span class='hs-comment'>{-# LINE 2 "./Graphics/UI/Gtk/Glade.chs" #-}</span>
<a name="line-3"></a><span class='hs-comment'>-- GIMP Toolkit (GTK) Binding for Haskell: binding to Libglade -*-haskell-*-</span>
<a name="line-4"></a><span class='hs-comment'>-- for loading XML widget specifications</span>
<a name="line-5"></a><span class='hs-comment'>--</span>
<a name="line-6"></a><span class='hs-comment'>-- Author : Manuel M T Chakravarty</span>
<a name="line-7"></a><span class='hs-comment'>-- Created: 13 March 2002</span>
<a name="line-8"></a><span class='hs-comment'>--</span>
<a name="line-9"></a><span class='hs-comment'>-- Copyright (c) 2002 Manuel M T Chakravarty</span>
<a name="line-10"></a><span class='hs-comment'>-- Modified 2003, 2005 by Duncan Coutts (gtk2hs port)</span>
<a name="line-11"></a><span class='hs-comment'>--</span>
<a name="line-12"></a><span class='hs-comment'>-- This library is free software; you can redistribute it and/or</span>
<a name="line-13"></a><span class='hs-comment'>-- modify it under the terms of the GNU Library General Public</span>
<a name="line-14"></a><span class='hs-comment'>-- License as published by the Free Software Foundation; either</span>
<a name="line-15"></a><span class='hs-comment'>-- version 2 of the License, or (at your option) any later version.</span>
<a name="line-16"></a><span class='hs-comment'>--</span>
<a name="line-17"></a><span class='hs-comment'>-- This library is distributed in the hope that it will be useful,</span>
<a name="line-18"></a><span class='hs-comment'>-- but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="line-19"></a><span class='hs-comment'>-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="line-20"></a><span class='hs-comment'>-- Library General Public License for more details.</span>
<a name="line-21"></a><span class='hs-comment'>--</span>
<a name="line-22"></a><span class='hs-comment'>-- Notes:</span>
<a name="line-23"></a><span class='hs-comment'>--</span>
<a name="line-24"></a><span class='hs-comment'>-- glade_xml_signal_autoconnect() is not supported. The C variant is not</span>
<a name="line-25"></a><span class='hs-comment'>-- suitable for Haskell as -rdynamic leads to huge executable and we</span>
<a name="line-26"></a><span class='hs-comment'>-- usually don't want to connect staticly named functions, but closures.</span>
<a name="line-27"></a><span class='hs-comment'>--</span>
<a name="line-28"></a><span class='hs-comment'>-- glade_xml_construct() is not bound, as it doesn't seem to be useful</span>
<a name="line-29"></a><span class='hs-comment'>-- in Haskell. As usual, the signal_connect_data variant for</span>
<a name="line-30"></a><span class='hs-comment'>-- registering signal handlers isn't bound either. Moreover, the</span>
<a name="line-31"></a><span class='hs-comment'>-- connect_full functions are not bound.</span>
<a name="line-32"></a><span class='hs-comment'>--</span>
<a name="line-33"></a><span class='hs-comment'>-- |</span>
<a name="line-34"></a><span class='hs-comment'>--</span>
<a name="line-35"></a><span class='hs-comment'>-- Libglade facilitates loading of XML specifications of whole widget trees</span>
<a name="line-36"></a><span class='hs-comment'>-- that have been interactively designed with the GUI builder Glade. The</span>
<a name="line-37"></a><span class='hs-comment'>-- present module exports operations for manipulating 'GladeXML' objects.</span>
<a name="line-38"></a><span class='hs-comment'>--</span>
<a name="line-39"></a><span class='hs-comment'>-- * This binding does not support Libglade functionality that is exclusively</span>
<a name="line-40"></a><span class='hs-comment'>-- meant for extending Libglade with new widgets. Like new widgets, such</span>
<a name="line-41"></a><span class='hs-comment'>-- functionality is currently expected to be implemented in C.</span>
<a name="line-42"></a><span class='hs-comment'>--</span>
<a name="line-43"></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'>Glade</span> <span class='hs-layout'>(</span>
<a name="line-44"></a>
<a name="line-45"></a> <span class='hs-comment'>-- * Data types</span>
<a name="line-46"></a> <span class='hs-comment'>--</span>
<a name="line-47"></a> <span class='hs-conid'>GladeXMLClass</span><span class='hs-layout'>,</span> <span class='hs-conid'>GladeXML</span><span class='hs-layout'>,</span>
<a name="line-48"></a>
<a name="line-49"></a> <span class='hs-comment'>-- * Creation operations</span>
<a name="line-50"></a> <span class='hs-comment'>--</span>
<a name="line-51"></a> <span class='hs-varid'>xmlNew</span><span class='hs-layout'>,</span> <span class='hs-varid'>xmlNewWithRootAndDomain</span><span class='hs-layout'>,</span>
<a name="line-52"></a>
<a name="line-53"></a> <span class='hs-comment'>-- * Obtaining widget handles</span>
<a name="line-54"></a> <span class='hs-comment'>--</span>
<a name="line-55"></a> <span class='hs-varid'>xmlGetWidget</span><span class='hs-layout'>,</span> <span class='hs-varid'>xmlGetWidgetRaw</span>
<a name="line-56"></a>
<a name="line-57"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-58"></a>
<a name="line-59"></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-60"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Exception</span> <span class='hs-layout'>(</span><span class='hs-varid'>evaluate</span><span class='hs-layout'>)</span>
<a name="line-61"></a>
<a name="line-62"></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-63"></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'>GType</span>
<a name="line-64"></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-65"></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'>GObject</span> <span class='hs-layout'>(</span><span class='hs-varid'>constructNewGObject</span><span class='hs-layout'>)</span>
<a name="line-66"></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'>Glade</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span>
<a name="line-67"></a><span class='hs-comment'>{-# LINE 66 "./Graphics/UI/Gtk/Glade.chs" #-}</span>
<a name="line-68"></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'>GList</span>
<a name="line-69"></a>
<a name="line-70"></a>
<a name="line-71"></a><span class='hs-comment'>{-# LINE 69 "./Graphics/UI/Gtk/Glade.chs" #-}</span>
<a name="line-72"></a>
<a name="line-73"></a>
<a name="line-74"></a><a name="xmlNew"></a><span class='hs-comment'>-- | Create a new XML object (and the corresponding widgets) from the given</span>
<a name="line-75"></a><span class='hs-comment'>-- XML file.</span>
<a name="line-76"></a><span class='hs-comment'>--</span>
<a name="line-77"></a><span class='hs-comment'>-- This corresponds to 'xmlNewWithRootAndDomain', but without the ability</span>
<a name="line-78"></a><span class='hs-comment'>-- to specify a root widget or translation domain.</span>
<a name="line-79"></a><span class='hs-comment'>--</span>
<a name="line-80"></a><span class='hs-definition'>xmlNew</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span> <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'>GladeXML</span><span class='hs-layout'>)</span>
<a name="line-81"></a><span class='hs-definition'>xmlNew</span> <span class='hs-varid'>file</span> <span class='hs-keyglyph'>=</span>
<a name="line-82"></a> <span class='hs-varid'>withCString</span> <span class='hs-varid'>file</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>strPtr1</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-83"></a> <span class='hs-varid'>xmlPtr</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>glade_xml_new</span> <span class='hs-varid'>strPtr1</span> <span class='hs-varid'>nullPtr</span> <span class='hs-varid'>nullPtr</span>
<a name="line-84"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>xmlPtr</span><span class='hs-varop'>==</span><span class='hs-varid'>nullPtr</span> <span class='hs-keyword'>then</span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span>
<a name="line-85"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>liftM</span> <span class='hs-conid'>Just</span> <span class='hs-varop'>$</span> <span class='hs-varid'>constructNewGObject</span> <span class='hs-varid'>mkGladeXML</span> <span class='hs-layout'>(</span><span class='hs-varid'>return</span> <span class='hs-varid'>xmlPtr</span><span class='hs-layout'>)</span>
<a name="line-86"></a>
<a name="line-87"></a><a name="xmlNewWithRootAndDomain"></a><span class='hs-comment'>-- | Create a new GladeXML object (and the corresponding widgets) from the</span>
<a name="line-88"></a><span class='hs-comment'>-- given XML file.</span>
<a name="line-89"></a><span class='hs-comment'>--</span>
<a name="line-90"></a><span class='hs-comment'>-- Optionally it will only build the interface from the widget</span>
<a name="line-91"></a><span class='hs-comment'>-- node @root@ (if it is not 'Nothing'). This feature is useful if you only</span>
<a name="line-92"></a><span class='hs-comment'>-- want to build say a toolbar or menu from the XML file, but not the window</span>
<a name="line-93"></a><span class='hs-comment'>-- it is embedded in.</span>
<a name="line-94"></a><span class='hs-comment'>--</span>
<a name="line-95"></a><span class='hs-comment'>-- Note also that the XML parse tree is cached to speed up creating another</span>
<a name="line-96"></a><span class='hs-comment'>-- 'GladeXML' object for the same file.</span>
<a name="line-97"></a><span class='hs-comment'>--</span>
<a name="line-98"></a><span class='hs-definition'>xmlNewWithRootAndDomain</span> <span class='hs-keyglyph'>::</span>
<a name="line-99"></a> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ the XML file name.</span>
<a name="line-100"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ @root@ - the widget node in fname to start building</span>
<a name="line-101"></a> <span class='hs-comment'>-- from (or 'Nothing')</span>
<a name="line-102"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ @domain@ - the translation domain for the XML file (or</span>
<a name="line-103"></a> <span class='hs-comment'>-- 'Nothing' for default)</span>
<a name="line-104"></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'>GladeXML</span><span class='hs-layout'>)</span>
<a name="line-105"></a><span class='hs-definition'>xmlNewWithRootAndDomain</span> <span class='hs-varid'>file</span> <span class='hs-varid'>rootWidgetName</span> <span class='hs-varid'>domain</span> <span class='hs-keyglyph'>=</span>
<a name="line-106"></a> <span class='hs-varid'>maybeNull</span> <span class='hs-layout'>(</span><span class='hs-varid'>constructNewGObject</span> <span class='hs-varid'>mkGladeXML</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-107"></a> <span class='hs-varid'>withCString</span> <span class='hs-varid'>file</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>filePtr</span> <span class='hs-keyglyph'>-></span>
<a name="line-108"></a> <span class='hs-varid'>maybeWith</span> <span class='hs-varid'>withCString</span> <span class='hs-varid'>rootWidgetName</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>rootWidgetNamePtr</span> <span class='hs-keyglyph'>-></span>
<a name="line-109"></a> <span class='hs-varid'>maybeWith</span> <span class='hs-varid'>withCString</span> <span class='hs-varid'>domain</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>domainPtr</span> <span class='hs-keyglyph'>-></span>
<a name="line-110"></a> <span class='hs-varid'>glade_xml_new</span>
<a name="line-111"></a><span class='hs-comment'>{-# LINE 108 "./Graphics/UI/Gtk/Glade.chs" #-}</span>
<a name="line-112"></a> <span class='hs-varid'>filePtr</span>
<a name="line-113"></a> <span class='hs-varid'>rootWidgetNamePtr</span>
<a name="line-114"></a> <span class='hs-varid'>domainPtr</span>
<a name="line-115"></a>
<a name="line-116"></a><a name="xmlGetWidget"></a><span class='hs-comment'>-- | Get the widget that has the given name in</span>
<a name="line-117"></a><span class='hs-comment'>-- the interface description. If the named widget cannot be found</span>
<a name="line-118"></a><span class='hs-comment'>-- or is of the wrong type the result is an error.</span>
<a name="line-119"></a><span class='hs-comment'>--</span>
<a name="line-120"></a><span class='hs-definition'>xmlGetWidget</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>WidgetClass</span> <span class='hs-varid'>widget</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span>
<a name="line-121"></a> <span class='hs-conid'>GladeXML</span>
<a name="line-122"></a> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>GObject</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>widget</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- ^ a dynamic cast function that returns the type of</span>
<a name="line-123"></a> <span class='hs-comment'>-- object that you expect, eg castToButton</span>
<a name="line-124"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ the second parameter is the ID of the widget in</span>
<a name="line-125"></a> <span class='hs-comment'>-- the glade xml file, eg \"button1\".</span>
<a name="line-126"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>widget</span>
<a name="line-127"></a><span class='hs-definition'>xmlGetWidget</span> <span class='hs-varid'>xml</span> <span class='hs-varid'>cast</span> <span class='hs-varid'>name</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-128"></a> <span class='hs-varid'>maybeWidget</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>xmlGetWidgetRaw</span> <span class='hs-varid'>xml</span> <span class='hs-varid'>name</span>
<a name="line-129"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>maybeWidget</span> <span class='hs-keyword'>of</span>
<a name="line-130"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>widget</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>evaluate</span> <span class='hs-layout'>(</span><span class='hs-varid'>cast</span> <span class='hs-layout'>(</span><span class='hs-varid'>toGObject</span> <span class='hs-varid'>widget</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-131"></a> <span class='hs-comment'>--the cast will return an error if the object is of the wrong type</span>
<a name="line-132"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>fail</span> <span class='hs-varop'>$</span> <span class='hs-str'>"glade.xmlGetWidget: no object named "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>show</span> <span class='hs-varid'>name</span> <span class='hs-varop'>++</span> <span class='hs-str'>" in the glade file"</span>
<a name="line-133"></a>
<a name="line-134"></a><a name="xmlGetWidgetRaw"></a><span class='hs-comment'>-- | Like 'xmlGetWidget' but it does not do any casting and if the named</span>
<a name="line-135"></a><span class='hs-comment'>-- widget is not found then the result is 'Nothing' rather than an error.</span>
<a name="line-136"></a><span class='hs-comment'>--</span>
<a name="line-137"></a><span class='hs-definition'>xmlGetWidgetRaw</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GladeXML</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <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>
<a name="line-138"></a><span class='hs-definition'>xmlGetWidgetRaw</span> <span class='hs-varid'>xml</span> <span class='hs-varid'>name</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-varid'>withCString</span> <span class='hs-varid'>name</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>namePtr</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-141"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>GladeXML</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-varid'>arg2</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'>glade_xml_get_widget</span> <span class='hs-varid'>argPtr1</span> <span class='hs-varid'>arg2</span><span class='hs-layout'>)</span> <span class='hs-varid'>xml</span> <span class='hs-varid'>namePtr</span>
<a name="line-142"></a>
<a name="line-143"></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'>"glade_xml_new"</span>
<a name="line-144"></a> <span class='hs-varid'>glade_xml_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-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-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'>GladeXML</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-145"></a>
<a name="line-146"></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'>"glade_xml_get_widget"</span>
<a name="line-147"></a> <span class='hs-varid'>glade_xml_get_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'>GladeXML</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'>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><span class='hs-layout'>)</span>
</pre></body>
</html>
