<?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/Embedding/Socket.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/Embedding/Socket.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 Socket</span>
<a name="line-5"></a><span class='hs-comment'>--</span>
<a name="line-6"></a><span class='hs-comment'>-- Author : Axel Simon, Andy Stewart</span>
<a name="line-7"></a><span class='hs-comment'>--</span>
<a name="line-8"></a><span class='hs-comment'>-- Created: 23 May 2001</span>
<a name="line-9"></a><span class='hs-comment'>--</span>
<a name="line-10"></a><span class='hs-comment'>-- Copyright (C) 1999-2005 Axel Simon</span>
<a name="line-11"></a><span class='hs-comment'>-- Copyright (C) 2009 Andy Stewart</span>
<a name="line-12"></a><span class='hs-comment'>--</span>
<a name="line-13"></a><span class='hs-comment'>-- This library is free software; you can redistribute it and/or</span>
<a name="line-14"></a><span class='hs-comment'>-- modify it under the terms of the GNU Lesser General Public</span>
<a name="line-15"></a><span class='hs-comment'>-- License as published by the Free Software Foundation; either</span>
<a name="line-16"></a><span class='hs-comment'>-- version 2.1 of the License, or (at your option) any later version.</span>
<a name="line-17"></a><span class='hs-comment'>--</span>
<a name="line-18"></a><span class='hs-comment'>-- This library is distributed in the hope that it will be useful,</span>
<a name="line-19"></a><span class='hs-comment'>-- but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="line-20"></a><span class='hs-comment'>-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="line-21"></a><span class='hs-comment'>-- Lesser General Public License for more details.</span>
<a name="line-22"></a><span class='hs-comment'>--</span>
<a name="line-23"></a><span class='hs-comment'>-- |</span>
<a name="line-24"></a><span class='hs-comment'>-- Maintainer : gtk2hs-users@lists.sourceforge.net</span>
<a name="line-25"></a><span class='hs-comment'>-- Stability : provisional</span>
<a name="line-26"></a><span class='hs-comment'>-- Portability : portable (depends on GHC)</span>
<a name="line-27"></a><span class='hs-comment'>--</span>
<a name="line-28"></a><span class='hs-comment'>-- Container for widgets from other processes</span>
<a name="line-29"></a><span class='hs-comment'>--</span>
<a name="line-30"></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'>Embedding</span><span class='hs-varop'>.</span><span class='hs-conid'>Socket</span> <span class='hs-layout'>(</span>
<a name="line-31"></a><span class='hs-comment'>-- * Detail</span>
<a name="line-32"></a><span class='hs-comment'>--</span>
<a name="line-33"></a><span class='hs-comment'>-- | Together with 'Plug', 'Socket' provides the ability to embed widgets from</span>
<a name="line-34"></a><span class='hs-comment'>-- one process into another process in a fashion that is transparent to the</span>
<a name="line-35"></a><span class='hs-comment'>-- user. One process creates a 'Socket' widget and, passes the that widget's</span>
<a name="line-36"></a><span class='hs-comment'>-- window ID to the other process, which then creates a 'Plug' with that window</span>
<a name="line-37"></a><span class='hs-comment'>-- ID. Any widgets contained in the 'Plug' then will appear inside the first</span>
<a name="line-38"></a><span class='hs-comment'>-- applications window.</span>
<a name="line-39"></a><span class='hs-comment'>--</span>
<a name="line-40"></a><span class='hs-comment'>-- The socket's window ID is obtained by using 'socketGetId'. Before using</span>
<a name="line-41"></a><span class='hs-comment'>-- this function, the socket must have been realized, and for hence, have been</span>
<a name="line-42"></a><span class='hs-comment'>-- added to its parent.</span>
<a name="line-43"></a><span class='hs-comment'>--</span>
<a name="line-44"></a><span class='hs-comment'>-- * Obtaining the window ID of a socket.</span>
<a name="line-45"></a><span class='hs-comment'>--</span>
<a name="line-46"></a><span class='hs-comment'>-- > socket <- socketNew</span>
<a name="line-47"></a><span class='hs-comment'>-- > widgetShow socket</span>
<a name="line-48"></a><span class='hs-comment'>-- > containerAdd parent socket</span>
<a name="line-49"></a><span class='hs-comment'>-- ></span>
<a name="line-50"></a><span class='hs-comment'>-- > -- The following call is only necessary if one of</span>
<a name="line-51"></a><span class='hs-comment'>-- > -- the ancestors of the socket is not yet visible.</span>
<a name="line-52"></a><span class='hs-comment'>-- > --</span>
<a name="line-53"></a><span class='hs-comment'>-- > widgetRealize socket</span>
<a name="line-54"></a><span class='hs-comment'>-- > socketId <- socketGetId socket</span>
<a name="line-55"></a><span class='hs-comment'>-- > putStrLn ("The ID of the sockets window is " ++ show socketId)</span>
<a name="line-56"></a><span class='hs-comment'>--</span>
<a name="line-57"></a><span class='hs-comment'>-- Note that if you pass the window ID of the socket to another process that</span>
<a name="line-58"></a><span class='hs-comment'>-- will create a plug in the socket, you must make sure that the socket widget</span>
<a name="line-59"></a><span class='hs-comment'>-- is not destroyed until that plug is created. Violating this rule will cause</span>
<a name="line-60"></a><span class='hs-comment'>-- unpredictable consequences, the most likely consequence being that the plug</span>
<a name="line-61"></a><span class='hs-comment'>-- will appear as a separate toplevel window. You can check if the plug has</span>
<a name="line-62"></a><span class='hs-comment'>-- been created by calling 'socketHasPlug'.</span>
<a name="line-63"></a><span class='hs-comment'>-- If this returns @True@, then the plug has been successfully created inside</span>
<a name="line-64"></a><span class='hs-comment'>-- of the socket.</span>
<a name="line-65"></a><span class='hs-comment'>--</span>
<a name="line-66"></a><span class='hs-comment'>-- When Gtk+ is notified that the embedded window has been destroyed, then</span>
<a name="line-67"></a><span class='hs-comment'>-- it will destroy the socket as well. You should always, therefore, be</span>
<a name="line-68"></a><span class='hs-comment'>-- prepared for your sockets to be destroyed at any time when the main event</span>
<a name="line-69"></a><span class='hs-comment'>-- loop is running.</span>
<a name="line-70"></a><span class='hs-comment'>--</span>
<a name="line-71"></a><span class='hs-comment'>-- The communication between a 'Socket' and a 'Plug' follows the XEmbed</span>
<a name="line-72"></a><span class='hs-comment'>-- protocol. This protocol has also been implemented in other toolkits, e.g.</span>
<a name="line-73"></a><span class='hs-comment'>-- Qt, allowing the same level of integration when embedding a Qt widget in</span>
<a name="line-74"></a><span class='hs-comment'>-- Gtk+ or vice versa.</span>
<a name="line-75"></a>
<a name="line-76"></a><span class='hs-comment'>-- * Class Hierarchy</span>
<a name="line-77"></a><span class='hs-comment'>-- |</span>
<a name="line-78"></a><span class='hs-comment'>-- @</span>
<a name="line-79"></a><span class='hs-comment'>-- | 'GObject'</span>
<a name="line-80"></a><span class='hs-comment'>-- | +----'Object'</span>
<a name="line-81"></a><span class='hs-comment'>-- | +----'Widget'</span>
<a name="line-82"></a><span class='hs-comment'>-- | +----'Container'</span>
<a name="line-83"></a><span class='hs-comment'>-- | +----Socket</span>
<a name="line-84"></a><span class='hs-comment'>-- @</span>
<a name="line-85"></a>
<a name="line-86"></a>
<a name="line-87"></a><span class='hs-comment'>-- * Types</span>
<a name="line-88"></a> <span class='hs-conid'>Socket</span><span class='hs-layout'>,</span>
<a name="line-89"></a> <span class='hs-conid'>SocketClass</span><span class='hs-layout'>,</span>
<a name="line-90"></a> <span class='hs-varid'>castToSocket</span><span class='hs-layout'>,</span> <span class='hs-varid'>gTypeSocket</span><span class='hs-layout'>,</span>
<a name="line-91"></a> <span class='hs-varid'>toSocket</span><span class='hs-layout'>,</span>
<a name="line-92"></a> <span class='hs-conid'>NativeWindowId</span><span class='hs-layout'>,</span>
<a name="line-93"></a>
<a name="line-94"></a><span class='hs-comment'>-- * Constructors</span>
<a name="line-95"></a> <span class='hs-varid'>socketNew</span><span class='hs-layout'>,</span>
<a name="line-96"></a>
<a name="line-97"></a><span class='hs-comment'>-- * Methods</span>
<a name="line-98"></a> <span class='hs-varid'>socketHasPlug</span><span class='hs-layout'>,</span>
<a name="line-99"></a> <span class='hs-varid'>socketAddId</span><span class='hs-layout'>,</span>
<a name="line-100"></a> <span class='hs-varid'>socketGetId</span><span class='hs-layout'>,</span>
<a name="line-101"></a>
<a name="line-102"></a> <span class='hs-varid'>socketGetPlugWindow</span><span class='hs-layout'>,</span>
<a name="line-103"></a>
<a name="line-104"></a>
<a name="line-105"></a><span class='hs-comment'>-- * Signals</span>
<a name="line-106"></a> <span class='hs-varid'>socketPlugAdded</span><span class='hs-layout'>,</span>
<a name="line-107"></a> <span class='hs-varid'>socketPlugRemoved</span><span class='hs-layout'>,</span>
<a name="line-108"></a>
<a name="line-109"></a><span class='hs-comment'>-- * Deprecated</span>
<a name="line-110"></a>
<a name="line-111"></a> <span class='hs-varid'>onPlugAdded</span><span class='hs-layout'>,</span>
<a name="line-112"></a> <span class='hs-varid'>afterPlugAdded</span><span class='hs-layout'>,</span>
<a name="line-113"></a> <span class='hs-varid'>onPlugRemoved</span><span class='hs-layout'>,</span>
<a name="line-114"></a> <span class='hs-varid'>afterPlugRemoved</span><span class='hs-layout'>,</span>
<a name="line-115"></a>
<a name="line-116"></a>
<a name="line-117"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-118"></a>
<a name="line-119"></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-120"></a>
<a name="line-121"></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-122"></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-123"></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-124"></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-125"></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-126"></a><span class='hs-comment'>{-# LINE 125 "./Graphics/UI/Gtk/Embedding/Socket.chs" #-}</span>
<a name="line-127"></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'>Signals</span>
<a name="line-128"></a><span class='hs-comment'>{-# LINE 126 "./Graphics/UI/Gtk/Embedding/Socket.chs" #-}</span>
<a name="line-129"></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'>Embedding</span><span class='hs-varop'>.</span><span class='hs-conid'>Embedding</span>
<a name="line-130"></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'>General</span><span class='hs-varop'>.</span><span class='hs-conid'>Structs</span>
<a name="line-131"></a>
<a name="line-132"></a>
<a name="line-133"></a><span class='hs-comment'>{-# LINE 130 "./Graphics/UI/Gtk/Embedding/Socket.chs" #-}</span>
<a name="line-134"></a>
<a name="line-135"></a>
<a name="line-136"></a>
<a name="line-137"></a><span class='hs-comment'>--------------------</span>
<a name="line-138"></a><span class='hs-comment'>-- Constructors</span>
<a name="line-139"></a>
<a name="line-140"></a><a name="socketNew"></a><span class='hs-comment'>-- | Create a new empty 'Socket'.</span>
<a name="line-141"></a><span class='hs-comment'>--</span>
<a name="line-142"></a><span class='hs-comment'>-- 'Socket' is a 'Container' for foreign applications that support the XEMBED</span>
<a name="line-143"></a><span class='hs-comment'>-- protocol. To connect two applications the 'NativeWindowId' has to be passed</span>
<a name="line-144"></a><span class='hs-comment'>-- either from this socket to the other application's 'Plug' or vice versa.</span>
<a name="line-145"></a><span class='hs-comment'>--</span>
<a name="line-146"></a><span class='hs-definition'>socketNew</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Socket</span>
<a name="line-147"></a><span class='hs-definition'>socketNew</span> <span class='hs-keyglyph'>=</span>
<a name="line-148"></a> <span class='hs-varid'>makeNewObject</span> <span class='hs-varid'>mkSocket</span> <span class='hs-varop'>$</span>
<a name="line-149"></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'>Socket</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-150"></a> <span class='hs-varid'>gtk_socket_new</span>
<a name="line-151"></a><span class='hs-comment'>{-# LINE 147 "./Graphics/UI/Gtk/Embedding/Socket.chs" #-}</span>
<a name="line-152"></a>
<a name="line-153"></a><span class='hs-comment'>--------------------</span>
<a name="line-154"></a><span class='hs-comment'>-- Methods</span>
<a name="line-155"></a>
<a name="line-156"></a><a name="socketAddId"></a><span class='hs-comment'>-- | Adds an XEMBED client, such as a 'Plug', to the 'Socket'. The client may</span>
<a name="line-157"></a><span class='hs-comment'>-- be in the same process or in a different process.</span>
<a name="line-158"></a><span class='hs-comment'>--</span>
<a name="line-159"></a><span class='hs-comment'>-- To embed a 'Plug' in a 'Socket', you can either create the 'Plug' with</span>
<a name="line-160"></a><span class='hs-comment'>-- @Graphics.UI.Gtk.Embedding.Plug.plugNew Nothing@, call</span>
<a name="line-161"></a><span class='hs-comment'>-- 'Graphics.UI.Gtk.Embedding.Plug.plugGetId' to get the window ID of the</span>
<a name="line-162"></a><span class='hs-comment'>-- plug, and then pass that to the 'socketAddId', or you can call</span>
<a name="line-163"></a><span class='hs-comment'>-- 'socketGetId' to get the window ID for the socket, and call</span>
<a name="line-164"></a><span class='hs-comment'>-- 'Graphics.UI.Gtk.Embedding.Plug.plugNew' passing in that ID.</span>
<a name="line-165"></a><span class='hs-comment'>--</span>
<a name="line-166"></a><span class='hs-comment'>-- The 'Socket' must have already be added into a toplevel window before you</span>
<a name="line-167"></a><span class='hs-comment'>-- can make this call.</span>
<a name="line-168"></a><span class='hs-comment'>--</span>
<a name="line-169"></a><span class='hs-definition'>socketAddId</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SocketClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span>
<a name="line-170"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>NativeWindowId</span> <span class='hs-comment'>-- ^ @windowId@ - the window ID of a client</span>
<a name="line-171"></a> <span class='hs-comment'>-- participating in the XEMBED protocol.</span>
<a name="line-172"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-173"></a><span class='hs-definition'>socketAddId</span> <span class='hs-varid'>self</span> <span class='hs-varid'>windowId</span> <span class='hs-keyglyph'>=</span>
<a name="line-174"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>Socket</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'>gtk_socket_add_id</span> <span class='hs-varid'>argPtr1</span> <span class='hs-varid'>arg2</span><span class='hs-layout'>)</span>
<a name="line-175"></a><span class='hs-comment'>{-# LINE 170 "./Graphics/UI/Gtk/Embedding/Socket.chs" #-}</span>
<a name="line-176"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toSocket</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span>
<a name="line-177"></a> <span class='hs-layout'>(</span><span class='hs-varid'>fromNativeWindowId</span> <span class='hs-varid'>windowId</span><span class='hs-layout'>)</span>
<a name="line-178"></a>
<a name="line-179"></a><a name="socketGetId"></a><span class='hs-comment'>-- | Gets the window ID of a 'Socket' widget, which can then be used to create</span>
<a name="line-180"></a><span class='hs-comment'>-- a client embedded inside the socket, for instance with</span>
<a name="line-181"></a><span class='hs-comment'>-- 'Graphics.UI.Gtk.Embedding.Plug.plugNew'.</span>
<a name="line-182"></a><span class='hs-comment'>--</span>
<a name="line-183"></a><span class='hs-comment'>-- The 'Socket' must have already be added into a toplevel window before you</span>
<a name="line-184"></a><span class='hs-comment'>-- can make this call.</span>
<a name="line-185"></a><span class='hs-comment'>--</span>
<a name="line-186"></a><span class='hs-definition'>socketGetId</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SocketClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>NativeWindowId</span>
<a name="line-187"></a><span class='hs-definition'>socketGetId</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=</span>
<a name="line-188"></a> <span class='hs-varid'>liftM</span> <span class='hs-varid'>toNativeWindowId</span> <span class='hs-varop'>$</span>
<a name="line-189"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>Socket</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_socket_get_id</span> <span class='hs-varid'>argPtr1</span><span class='hs-layout'>)</span>
<a name="line-190"></a><span class='hs-comment'>{-# LINE 184 "./Graphics/UI/Gtk/Embedding/Socket.chs" #-}</span>
<a name="line-191"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toSocket</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span>
<a name="line-192"></a>
<a name="line-193"></a>
<a name="line-194"></a><a name="socketGetPlugWindow"></a><span class='hs-comment'>-- | Retrieves the window of the plug. Use this to check if the plug has been</span>
<a name="line-195"></a><span class='hs-comment'>-- created inside of the socket.</span>
<a name="line-196"></a><span class='hs-comment'>--</span>
<a name="line-197"></a><span class='hs-comment'>-- * Available since Gtk+ version 2.14</span>
<a name="line-198"></a><span class='hs-comment'>--</span>
<a name="line-199"></a><span class='hs-definition'>socketGetPlugWindow</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SocketClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span>
<a name="line-200"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>DrawWindow</span> <span class='hs-comment'>-- ^ returns the window of the plug if available, or</span>
<a name="line-201"></a> <span class='hs-comment'>-- {@((void *)0)@, FIXME: this should probably be converted to a</span>
<a name="line-202"></a> <span class='hs-comment'>-- Maybe data type}</span>
<a name="line-203"></a><span class='hs-definition'>socketGetPlugWindow</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=</span>
<a name="line-204"></a> <span class='hs-varid'>makeNewGObject</span> <span class='hs-varid'>mkDrawWindow</span> <span class='hs-varop'>$</span>
<a name="line-205"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>Socket</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_socket_get_plug_window</span> <span class='hs-varid'>argPtr1</span><span class='hs-layout'>)</span>
<a name="line-206"></a><span class='hs-comment'>{-# LINE 199 "./Graphics/UI/Gtk/Embedding/Socket.chs" #-}</span>
<a name="line-207"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toSocket</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span>
<a name="line-208"></a>
<a name="line-209"></a>
<a name="line-210"></a><span class='hs-comment'>--------------------</span>
<a name="line-211"></a><span class='hs-comment'>-- Signals</span>
<a name="line-212"></a>
<a name="line-213"></a><a name="socketPlugAdded"></a><span class='hs-comment'>-- | This signal is emitted when a client is successfully added to the socket.</span>
<a name="line-214"></a><span class='hs-comment'>--</span>
<a name="line-215"></a><span class='hs-definition'>socketPlugAdded</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SocketClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Signal</span> <span class='hs-varid'>self</span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-216"></a><span class='hs-definition'>socketPlugAdded</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Signal</span> <span class='hs-layout'>(</span><span class='hs-varid'>connect_NONE__NONE</span> <span class='hs-str'>"plug-added"</span><span class='hs-layout'>)</span>
<a name="line-217"></a>
<a name="line-218"></a><a name="socketPlugRemoved"></a><span class='hs-comment'>-- | This signal is emitted when a client is removed from the socket. The</span>
<a name="line-219"></a><span class='hs-comment'>-- default action is to destroy the 'Socket' widget, so if you want to reuse it</span>
<a name="line-220"></a><span class='hs-comment'>-- you must add a signal handler that returns @True@.</span>
<a name="line-221"></a><span class='hs-comment'>--</span>
<a name="line-222"></a><span class='hs-definition'>socketPlugRemoved</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SocketClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Signal</span> <span class='hs-varid'>self</span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>Bool</span><span class='hs-layout'>)</span>
<a name="line-223"></a><span class='hs-definition'>socketPlugRemoved</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Signal</span> <span class='hs-layout'>(</span><span class='hs-varid'>connect_NONE__BOOL</span> <span class='hs-str'>"plug-removed"</span><span class='hs-layout'>)</span>
<a name="line-224"></a>
<a name="line-225"></a><span class='hs-comment'>--------------------</span>
<a name="line-226"></a><span class='hs-comment'>-- Deprecated Signals</span>
<a name="line-227"></a>
<a name="line-228"></a>
<a name="line-229"></a><a name="onPlugAdded"></a><span class='hs-definition'>onPlugAdded</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SocketClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span>
<a name="line-230"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-231"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>ConnectId</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span>
<a name="line-232"></a><span class='hs-definition'>onPlugAdded</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>connect_NONE__NONE</span> <span class='hs-str'>"plug-added"</span> <span class='hs-conid'>False</span>
<a name="line-233"></a><span class='hs-comment'>{-# DEPRECATED onPlugAdded "instead of 'onPlugAdded obj' use 'on obj socketPlugAdded'" #-}</span>
<a name="line-234"></a>
<a name="line-235"></a><a name="afterPlugAdded"></a><span class='hs-definition'>afterPlugAdded</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SocketClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span>
<a name="line-236"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-237"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>ConnectId</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span>
<a name="line-238"></a><span class='hs-definition'>afterPlugAdded</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>connect_NONE__NONE</span> <span class='hs-str'>"plug-added"</span> <span class='hs-conid'>True</span>
<a name="line-239"></a><span class='hs-comment'>{-# DEPRECATED afterPlugAdded "instead of 'afterPlugAdded obj' use 'after obj socketPlugAdded'" #-}</span>
<a name="line-240"></a>
<a name="line-241"></a><a name="onPlugRemoved"></a><span class='hs-definition'>onPlugRemoved</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SocketClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span>
<a name="line-242"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Bool</span>
<a name="line-243"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>ConnectId</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span>
<a name="line-244"></a><span class='hs-definition'>onPlugRemoved</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>connect_NONE__BOOL</span> <span class='hs-str'>"plug-removed"</span> <span class='hs-conid'>False</span>
<a name="line-245"></a><span class='hs-comment'>{-# DEPRECATED onPlugRemoved "instead of 'onPlugRemoved obj' use 'on obj socketPlugRemoved'" #-}</span>
<a name="line-246"></a>
<a name="line-247"></a><a name="afterPlugRemoved"></a><span class='hs-definition'>afterPlugRemoved</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SocketClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span>
<a name="line-248"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Bool</span>
<a name="line-249"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>ConnectId</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span>
<a name="line-250"></a><span class='hs-definition'>afterPlugRemoved</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>connect_NONE__BOOL</span> <span class='hs-str'>"plug-removed"</span> <span class='hs-conid'>True</span>
<a name="line-251"></a><span class='hs-comment'>{-# DEPRECATED afterPlugRemoved "instead of 'afterPlugRemoved obj' use 'after obj socketPlugRemoved'" #-}</span>
<a name="line-252"></a>
<a name="line-253"></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_socket_new"</span>
<a name="line-254"></a> <span class='hs-varid'>gtk_socket_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-255"></a>
<a name="line-256"></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_socket_add_id"</span>
<a name="line-257"></a> <span class='hs-varid'>gtk_socket_add_id</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'>Socket</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>CUInt</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-258"></a>
<a name="line-259"></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_socket_get_id"</span>
<a name="line-260"></a> <span class='hs-varid'>gtk_socket_get_id</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'>Socket</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'>CUInt</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-261"></a>
<a name="line-262"></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_socket_get_plug_window"</span>
<a name="line-263"></a> <span class='hs-varid'>gtk_socket_get_plug_window</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'>Socket</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'>DrawWindow</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
</pre></body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
677c1b5134368504c2e447757584d19e
>
files
>
995
