<?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/Recent/RecentChooserMenu.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/Recent/RecentChooserMenu.chs" #-}</span>
<a name="line-3"></a><span class='hs-comment'>-- -*-haskell-*-</span>
<a name="line-4"></a><span class='hs-comment'>-- GIMP Toolkit (GTK) Widget RecentChooserMenu</span>
<a name="line-5"></a><span class='hs-comment'>--</span>
<a name="line-6"></a><span class='hs-comment'>-- Author : Andy Stewart</span>
<a name="line-7"></a><span class='hs-comment'>--</span>
<a name="line-8"></a><span class='hs-comment'>-- Created: 27 Mar 2010</span>
<a name="line-9"></a><span class='hs-comment'>--</span>
<a name="line-10"></a><span class='hs-comment'>-- Copyright (C) 2010 Andy Stewart</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 Lesser 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.1 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'>-- Lesser 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'>-- |</span>
<a name="line-23"></a><span class='hs-comment'>-- Maintainer : gtk2hs-users@lists.sourceforge.net</span>
<a name="line-24"></a><span class='hs-comment'>-- Stability : provisional</span>
<a name="line-25"></a><span class='hs-comment'>-- Portability : portable (depends on GHC)</span>
<a name="line-26"></a><span class='hs-comment'>--</span>
<a name="line-27"></a><span class='hs-comment'>-- Displays recently used files in a menu</span>
<a name="line-28"></a><span class='hs-comment'>--</span>
<a name="line-29"></a><span class='hs-comment'>-- * Module available since Gtk+ version 2.10</span>
<a name="line-30"></a><span class='hs-comment'>--</span>
<a name="line-31"></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'>Recent</span><span class='hs-varop'>.</span><span class='hs-conid'>RecentChooserMenu</span> <span class='hs-layout'>(</span>
<a name="line-32"></a>
<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'>-- | 'RecentChooserMenu' is a widget suitable for displaying recently used</span>
<a name="line-36"></a><span class='hs-comment'>-- files inside a menu. It can be used to set a sub-menu of a 'MenuItem' using</span>
<a name="line-37"></a><span class='hs-comment'>-- 'menuItemSetSubmenu', or as the menu of a 'MenuToolButton'.</span>
<a name="line-38"></a><span class='hs-comment'>--</span>
<a name="line-39"></a><span class='hs-comment'>-- Note that 'RecentChooserMenu' does not have any methods of its own.</span>
<a name="line-40"></a><span class='hs-comment'>-- Instead, you should use the functions that work on a 'RecentChooser'.</span>
<a name="line-41"></a><span class='hs-comment'>--</span>
<a name="line-42"></a><span class='hs-comment'>-- Note also that 'RecentChooserMenu' does not support multiple filters, as</span>
<a name="line-43"></a><span class='hs-comment'>-- it has no way to let the user choose between them as the</span>
<a name="line-44"></a><span class='hs-comment'>-- 'RecentChooserWidget' and 'RecentChooserDialog' widgets do. Thus using</span>
<a name="line-45"></a><span class='hs-comment'>-- 'recentChooserAddFilter' on a 'RecentChooserMenu' widget will yield the same</span>
<a name="line-46"></a><span class='hs-comment'>-- effects as using 'recentChooserSetFilter', replacing any currently set</span>
<a name="line-47"></a><span class='hs-comment'>-- filter with the supplied filter; 'recentChooserRemoveFilter' will remove any</span>
<a name="line-48"></a><span class='hs-comment'>-- currently set 'RecentFilter' object and will unset the current filter;</span>
<a name="line-49"></a><span class='hs-comment'>-- 'recentChooserListFilters' will return a list containing a single</span>
<a name="line-50"></a><span class='hs-comment'>-- 'RecentFilter' object.</span>
<a name="line-51"></a><span class='hs-comment'>--</span>
<a name="line-52"></a><span class='hs-comment'>-- Recently used files are supported since Gtk+ 2.10.</span>
<a name="line-53"></a>
<a name="line-54"></a><span class='hs-comment'>-- * Class Hierarchy</span>
<a name="line-55"></a><span class='hs-comment'>--</span>
<a name="line-56"></a><span class='hs-comment'>-- |</span>
<a name="line-57"></a><span class='hs-comment'>-- @</span>
<a name="line-58"></a><span class='hs-comment'>-- | 'GObject'</span>
<a name="line-59"></a><span class='hs-comment'>-- | +----'Object'</span>
<a name="line-60"></a><span class='hs-comment'>-- | +----'Widget'</span>
<a name="line-61"></a><span class='hs-comment'>-- | +----'Container'</span>
<a name="line-62"></a><span class='hs-comment'>-- | +----'MenuShell'</span>
<a name="line-63"></a><span class='hs-comment'>-- | +----'Menu'</span>
<a name="line-64"></a><span class='hs-comment'>-- | +----RecentChooserMenu</span>
<a name="line-65"></a><span class='hs-comment'>-- @</span>
<a name="line-66"></a>
<a name="line-67"></a>
<a name="line-68"></a><span class='hs-comment'>-- * Types</span>
<a name="line-69"></a> <span class='hs-conid'>RecentChooserMenu</span><span class='hs-layout'>,</span>
<a name="line-70"></a> <span class='hs-conid'>RecentChooserMenuClass</span><span class='hs-layout'>,</span>
<a name="line-71"></a> <span class='hs-varid'>castToRecentChooserMenu</span><span class='hs-layout'>,</span>
<a name="line-72"></a> <span class='hs-varid'>toRecentChooserMenu</span><span class='hs-layout'>,</span>
<a name="line-73"></a>
<a name="line-74"></a><span class='hs-comment'>-- * Constructors</span>
<a name="line-75"></a> <span class='hs-varid'>recentChooserMenuNew</span><span class='hs-layout'>,</span>
<a name="line-76"></a> <span class='hs-varid'>recentChooserMenuNewForManager</span><span class='hs-layout'>,</span>
<a name="line-77"></a>
<a name="line-78"></a><span class='hs-comment'>-- * Attributes</span>
<a name="line-79"></a> <span class='hs-varid'>recentChooserMenuShowNumbers</span><span class='hs-layout'>,</span>
<a name="line-80"></a>
<a name="line-81"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-82"></a>
<a name="line-83"></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-84"></a>
<a name="line-85"></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-86"></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-87"></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'>Properties</span>
<a name="line-88"></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-89"></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-90"></a><span class='hs-comment'>{-# LINE 89 "./Graphics/UI/Gtk/Recent/RecentChooserMenu.chs" #-}</span>
<a name="line-91"></a>
<a name="line-92"></a>
<a name="line-93"></a><span class='hs-comment'>{-# LINE 91 "./Graphics/UI/Gtk/Recent/RecentChooserMenu.chs" #-}</span>
<a name="line-94"></a>
<a name="line-95"></a>
<a name="line-96"></a>
<a name="line-97"></a><span class='hs-comment'>--------------------</span>
<a name="line-98"></a><span class='hs-comment'>-- Constructors</span>
<a name="line-99"></a>
<a name="line-100"></a><a name="recentChooserMenuNew"></a><span class='hs-comment'>-- | Creates a new 'RecentChooserMenu' widget.</span>
<a name="line-101"></a><span class='hs-comment'>--</span>
<a name="line-102"></a><span class='hs-comment'>-- This kind of widget shows the list of recently used resources as a menu,</span>
<a name="line-103"></a><span class='hs-comment'>-- each item as a menu item. Each item inside the menu might have an icon,</span>
<a name="line-104"></a><span class='hs-comment'>-- representing its MIME type, and a number, for mnemonic access.</span>
<a name="line-105"></a><span class='hs-comment'>--</span>
<a name="line-106"></a><span class='hs-comment'>-- This widget implements the 'RecentChooser' interface.</span>
<a name="line-107"></a><span class='hs-comment'>--</span>
<a name="line-108"></a><span class='hs-comment'>-- This widget creates its own 'RecentManager' object. See the</span>
<a name="line-109"></a><span class='hs-comment'>-- 'recentChooserMenuNewForManager' function to know how to create a</span>
<a name="line-110"></a><span class='hs-comment'>-- 'RecentChooserMenu' widget bound to another 'RecentManager' object.</span>
<a name="line-111"></a><span class='hs-comment'>--</span>
<a name="line-112"></a><span class='hs-comment'>--</span>
<a name="line-113"></a><span class='hs-comment'>-- * Available since Gtk+ version 2.10</span>
<a name="line-114"></a><span class='hs-comment'>--</span>
<a name="line-115"></a><span class='hs-definition'>recentChooserMenuNew</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>RecentChooserMenu</span>
<a name="line-116"></a><span class='hs-definition'>recentChooserMenuNew</span> <span class='hs-keyglyph'>=</span>
<a name="line-117"></a> <span class='hs-varid'>makeNewObject</span> <span class='hs-varid'>mkRecentChooserMenu</span> <span class='hs-varop'>$</span>
<a name="line-118"></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'>RecentChooserMenu</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-119"></a> <span class='hs-varid'>gtk_recent_chooser_menu_new</span>
<a name="line-120"></a><span class='hs-comment'>{-# LINE 117 "./Graphics/UI/Gtk/Recent/RecentChooserMenu.chs" #-}</span>
<a name="line-121"></a>
<a name="line-122"></a><a name="recentChooserMenuNewForManager"></a><span class='hs-comment'>-- | Creates a new 'RecentChooserMenu' widget using @manager@ as the</span>
<a name="line-123"></a><span class='hs-comment'>-- underlying recently used resources manager.</span>
<a name="line-124"></a><span class='hs-comment'>--</span>
<a name="line-125"></a><span class='hs-comment'>-- This is useful if you have implemented your own recent manager, or if you</span>
<a name="line-126"></a><span class='hs-comment'>-- have a customized instance of a 'RecentManager' object or if you wish to</span>
<a name="line-127"></a><span class='hs-comment'>-- share a common 'RecentManager' object among multiple 'RecentChooser'</span>
<a name="line-128"></a><span class='hs-comment'>-- widgets.</span>
<a name="line-129"></a><span class='hs-comment'>--</span>
<a name="line-130"></a><span class='hs-comment'>--</span>
<a name="line-131"></a><span class='hs-comment'>-- * Available since Gtk+ version 2.10</span>
<a name="line-132"></a><span class='hs-comment'>--</span>
<a name="line-133"></a><span class='hs-definition'>recentChooserMenuNewForManager</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>RecentManagerClass</span> <span class='hs-varid'>manager</span>
<a name="line-134"></a> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>manager</span> <span class='hs-comment'>-- ^ @manager@ - a 'RecentManager'</span>
<a name="line-135"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>RecentChooserMenu</span> <span class='hs-comment'>-- ^ returns a new 'RecentChooserMenu', bound to manager.</span>
<a name="line-136"></a><span class='hs-definition'>recentChooserMenuNewForManager</span> <span class='hs-varid'>manager</span> <span class='hs-keyglyph'>=</span>
<a name="line-137"></a> <span class='hs-varid'>makeNewObject</span> <span class='hs-varid'>mkRecentChooserMenu</span> <span class='hs-varop'>$</span>
<a name="line-138"></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'>RecentChooserMenu</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-139"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>RecentManager</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_recent_chooser_menu_new_for_manager</span> <span class='hs-varid'>argPtr1</span><span class='hs-layout'>)</span>
<a name="line-140"></a><span class='hs-comment'>{-# LINE 136 "./Graphics/UI/Gtk/Recent/RecentChooserMenu.chs" #-}</span>
<a name="line-141"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toRecentManager</span> <span class='hs-varid'>manager</span><span class='hs-layout'>)</span>
<a name="line-142"></a>
<a name="line-143"></a><span class='hs-comment'>--------------------</span>
<a name="line-144"></a><span class='hs-comment'>-- Attributes</span>
<a name="line-145"></a>
<a name="line-146"></a><a name="recentChooserMenuShowNumbers"></a><span class='hs-comment'>-- | Whether the first ten items in the menu should be prepended by a number acting as a unique mnemonic.</span>
<a name="line-147"></a><span class='hs-comment'>--</span>
<a name="line-148"></a><span class='hs-comment'>-- Default value: 'False'</span>
<a name="line-149"></a><span class='hs-comment'>--</span>
<a name="line-150"></a><span class='hs-comment'>-- * Available since Gtk+ version 2.10</span>
<a name="line-151"></a><span class='hs-comment'>--</span>
<a name="line-152"></a><span class='hs-definition'>recentChooserMenuShowNumbers</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>RecentChooserMenuClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Attr</span> <span class='hs-varid'>self</span> <span class='hs-conid'>Bool</span>
<a name="line-153"></a><span class='hs-definition'>recentChooserMenuShowNumbers</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>newAttrFromBoolProperty</span> <span class='hs-str'>"show-numbers"</span>
<a name="line-154"></a>
<a name="line-155"></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_recent_chooser_menu_new"</span>
<a name="line-156"></a> <span class='hs-varid'>gtk_recent_chooser_menu_new</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>
<a name="line-157"></a>
<a name="line-158"></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_recent_chooser_menu_new_for_manager"</span>
<a name="line-159"></a> <span class='hs-varid'>gtk_recent_chooser_menu_new_for_manager</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'>RecentManager</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>
