<?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/Windows/OffscreenWindow.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/Windows/OffscreenWindow.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 OffscreenWindow</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: 25 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'>-- A toplevel container widget used to manage offscreen rendering of child widgets.</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.20</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'>Windows</span><span class='hs-varop'>.</span><span class='hs-conid'>OffscreenWindow</span> <span class='hs-layout'>(</span>
<a name="line-32"></a><span class='hs-comment'>-- * Detail</span>
<a name="line-33"></a><span class='hs-comment'>-- | 'OffscreenWindow' is strictly intended to be used for obtaining snapshots of widgets that are not</span>
<a name="line-34"></a><span class='hs-comment'>-- part of a normal widget hierarchy. It differs from 'widgetGetSnapshot' in that the widget you</span>
<a name="line-35"></a><span class='hs-comment'>-- want to get a snapshot of need not be displayed on the user's screen as a part of a widget</span>
<a name="line-36"></a><span class='hs-comment'>-- hierarchy. However, since 'OffscreenWindow' is a toplevel widget you cannot obtain snapshots of a</span>
<a name="line-37"></a><span class='hs-comment'>-- full window with it since you cannot pack a toplevel widget in another toplevel.</span>
<a name="line-38"></a><span class='hs-comment'>--</span>
<a name="line-39"></a><span class='hs-comment'>-- The idea is to take a widget and manually set the state of it, add it to a 'OffscreenWindow' and</span>
<a name="line-40"></a><span class='hs-comment'>-- then retrieve the snapshot as a 'Pixmap' or 'Pixbuf'.</span>
<a name="line-41"></a><span class='hs-comment'>--</span>
<a name="line-42"></a><span class='hs-comment'>-- 'OffscreenWindow' derives from 'Window' only as an implementation detail. Applications should not</span>
<a name="line-43"></a><span class='hs-comment'>-- use any API specific to 'Window' to operate on this object. It should be treated as a 'Bin' that</span>
<a name="line-44"></a><span class='hs-comment'>-- has no parent widget.</span>
<a name="line-45"></a><span class='hs-comment'>--</span>
<a name="line-46"></a><span class='hs-comment'>-- When contained offscreen widgets are redrawn, 'OffscreenWindow' will emit a 'damageEvent' signal.</span>
<a name="line-47"></a>
<a name="line-48"></a><span class='hs-comment'>-- * Class Hierarchy</span>
<a name="line-49"></a><span class='hs-comment'>-- |</span>
<a name="line-50"></a><span class='hs-comment'>-- @</span>
<a name="line-51"></a><span class='hs-comment'>-- | 'GObject'</span>
<a name="line-52"></a><span class='hs-comment'>-- | +----'Object'</span>
<a name="line-53"></a><span class='hs-comment'>-- | +----'Widget'</span>
<a name="line-54"></a><span class='hs-comment'>-- | +----'Container'</span>
<a name="line-55"></a><span class='hs-comment'>-- | +----'Bin'</span>
<a name="line-56"></a><span class='hs-comment'>-- | +----Window</span>
<a name="line-57"></a><span class='hs-comment'>-- | +----'OffscreenWindow'</span>
<a name="line-58"></a><span class='hs-comment'>-- @</span>
<a name="line-59"></a>
<a name="line-60"></a>
<a name="line-61"></a><span class='hs-comment'>-- * Types</span>
<a name="line-62"></a> <span class='hs-conid'>OffscreenWindow</span><span class='hs-layout'>,</span>
<a name="line-63"></a> <span class='hs-conid'>OffscreenWindowClass</span><span class='hs-layout'>,</span>
<a name="line-64"></a> <span class='hs-varid'>castToOffscreenWindow</span><span class='hs-layout'>,</span> <span class='hs-varid'>gTypeOffscreenWindow</span><span class='hs-layout'>,</span>
<a name="line-65"></a> <span class='hs-varid'>toOffscreenWindow</span><span class='hs-layout'>,</span>
<a name="line-66"></a>
<a name="line-67"></a><span class='hs-comment'>-- * Constructors</span>
<a name="line-68"></a> <span class='hs-varid'>offscreenWindowNew</span><span class='hs-layout'>,</span>
<a name="line-69"></a>
<a name="line-70"></a><span class='hs-comment'>-- * Methods</span>
<a name="line-71"></a> <span class='hs-varid'>offscreenWindowGetPixmap</span><span class='hs-layout'>,</span>
<a name="line-72"></a> <span class='hs-varid'>offscreenWindowGetPixbuf</span><span class='hs-layout'>,</span>
<a name="line-73"></a>
<a name="line-74"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-75"></a>
<a name="line-76"></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-77"></a>
<a name="line-78"></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-79"></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-80"></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-81"></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-82"></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-83"></a><span class='hs-comment'>{-# LINE 82 "./Graphics/UI/Gtk/Windows/OffscreenWindow.chs" #-}</span>
<a name="line-84"></a>
<a name="line-85"></a>
<a name="line-86"></a><span class='hs-comment'>{-# LINE 84 "./Graphics/UI/Gtk/Windows/OffscreenWindow.chs" #-}</span>
<a name="line-87"></a>
<a name="line-88"></a>
<a name="line-89"></a><a name="offscreenWindowNew"></a><span class='hs-comment'>-- | Creates a toplevel container widget that is used to retrieve snapshots of widgets without showing</span>
<a name="line-90"></a><span class='hs-comment'>-- them on the screen. For widgets that are on the screen and part of a normal widget hierarchy,</span>
<a name="line-91"></a><span class='hs-comment'>-- 'widgetGetSnapshot' can be used instead.</span>
<a name="line-92"></a><span class='hs-comment'>--</span>
<a name="line-93"></a><span class='hs-comment'>-- * Available since Gtk+ version 2.20</span>
<a name="line-94"></a><span class='hs-comment'>--</span>
<a name="line-95"></a><span class='hs-definition'>offscreenWindowNew</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>OffscreenWindow</span>
<a name="line-96"></a><span class='hs-definition'>offscreenWindowNew</span> <span class='hs-keyglyph'>=</span>
<a name="line-97"></a> <span class='hs-varid'>makeNewObject</span> <span class='hs-varid'>mkOffscreenWindow</span> <span class='hs-varop'>$</span>
<a name="line-98"></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'>OffscreenWindow</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-99"></a> <span class='hs-varid'>gtk_offscreen_window_new</span>
<a name="line-100"></a><span class='hs-comment'>{-# LINE 97 "./Graphics/UI/Gtk/Windows/OffscreenWindow.chs" #-}</span>
<a name="line-101"></a>
<a name="line-102"></a><a name="offscreenWindowGetPixmap"></a><span class='hs-comment'>-- | Retrieves a snapshot of the contained widget in the form of a 'Pixmap'. If you need to keep this</span>
<a name="line-103"></a><span class='hs-comment'>-- around over window resizes then you should add a reference to it.</span>
<a name="line-104"></a><span class='hs-comment'>--</span>
<a name="line-105"></a><span class='hs-comment'>-- * Available since Gtk+ version 2.20</span>
<a name="line-106"></a><span class='hs-comment'>--</span>
<a name="line-107"></a><span class='hs-definition'>offscreenWindowGetPixmap</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>OffscreenWindowClass</span> <span class='hs-varid'>self</span>
<a name="line-108"></a> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span> <span class='hs-comment'>-- ^ @offscreen@ the 'OffscreenWindow' contained widget.</span>
<a name="line-109"></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'>Pixmap</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- ^ returns A 'Pixmap' pointer to the offscreen pixmap, or 'Nothing'.</span>
<a name="line-110"></a><span class='hs-definition'>offscreenWindowGetPixmap</span> <span class='hs-varid'>offscreen</span> <span class='hs-keyglyph'>=</span>
<a name="line-111"></a> <span class='hs-varid'>maybeNull</span> <span class='hs-layout'>(</span><span class='hs-varid'>makeNewGObject</span> <span class='hs-varid'>mkPixmap</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-112"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>OffscreenWindow</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_offscreen_window_get_pixmap</span> <span class='hs-varid'>argPtr1</span><span class='hs-layout'>)</span>
<a name="line-113"></a><span class='hs-comment'>{-# LINE 109 "./Graphics/UI/Gtk/Windows/OffscreenWindow.chs" #-}</span>
<a name="line-114"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toOffscreenWindow</span> <span class='hs-varid'>offscreen</span><span class='hs-layout'>)</span>
<a name="line-115"></a>
<a name="line-116"></a><a name="offscreenWindowGetPixbuf"></a><span class='hs-comment'>-- | Retrieves a snapshot of the contained widget in the form of a 'Pixbuf'.</span>
<a name="line-117"></a><span class='hs-comment'>--</span>
<a name="line-118"></a><span class='hs-comment'>-- * Available since Gtk+ version 2.20</span>
<a name="line-119"></a><span class='hs-comment'>--</span>
<a name="line-120"></a><span class='hs-definition'>offscreenWindowGetPixbuf</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>OffscreenWindowClass</span> <span class='hs-varid'>self</span>
<a name="line-121"></a> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span> <span class='hs-comment'>-- ^ @offscreen@ the 'OffscreenWindow' contained widget.</span>
<a name="line-122"></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'>Pixbuf</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- ^ returns A 'Pixbuf' pointer to the offscreen pixbuf, or 'Nothing'.</span>
<a name="line-123"></a><span class='hs-definition'>offscreenWindowGetPixbuf</span> <span class='hs-varid'>offscreen</span> <span class='hs-keyglyph'>=</span>
<a name="line-124"></a> <span class='hs-varid'>maybeNull</span> <span class='hs-layout'>(</span><span class='hs-varid'>wrapNewGObject</span> <span class='hs-varid'>mkPixbuf</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-125"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>OffscreenWindow</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_offscreen_window_get_pixbuf</span> <span class='hs-varid'>argPtr1</span><span class='hs-layout'>)</span>
<a name="line-126"></a><span class='hs-comment'>{-# LINE 121 "./Graphics/UI/Gtk/Windows/OffscreenWindow.chs" #-}</span>
<a name="line-127"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toOffscreenWindow</span> <span class='hs-varid'>offscreen</span><span class='hs-layout'>)</span>
<a name="line-128"></a>
<a name="line-129"></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_offscreen_window_new"</span>
<a name="line-130"></a> <span class='hs-varid'>gtk_offscreen_window_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-131"></a>
<a name="line-132"></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_offscreen_window_get_pixmap"</span>
<a name="line-133"></a> <span class='hs-varid'>gtk_offscreen_window_get_pixmap</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'>OffscreenWindow</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'>Pixmap</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-134"></a>
<a name="line-135"></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_offscreen_window_get_pixbuf"</span>
<a name="line-136"></a> <span class='hs-varid'>gtk_offscreen_window_get_pixbuf</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'>OffscreenWindow</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'>Pixbuf</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
</pre></body>
</html>
