Sophie: ghc-gtk-devel-0.11.2-5.fc14 i686

ghc-gtk-devel-0.11.2-5.fc14.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Graphics.UI.Gtk.Embedding.Socket</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_Graphics-UI-Gtk-Embedding-Socket.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>gtk-0.11.2: Binding to the Gtk+ graphical user interface library.</TD
><TD CLASS="topbut"
><A HREF="src/Graphics-UI-Gtk-Embedding-Socket.html"
>Source code</A
></TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Graphics.UI.Gtk.Embedding.Socket</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>portable (depends on GHC)</TD
></TR
><TR
><TD CLASS="infohead"
>Stability</TD
><TD CLASS="infoval"
>provisional</TD
></TR
><TR
><TD CLASS="infohead"
>Maintainer</TD
><TD CLASS="infoval"
>gtk2hs-users@lists.sourceforge.net</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
><B
>Contents</B
></TD
></TR
><TR
><TD
><DL
><DT
><A HREF="#1"
>Detail
</A
></DT
><DT
><A HREF="#2"
>Class Hierarchy
</A
></DT
><DT
><A HREF="#3"
>Types
</A
></DT
><DT
><A HREF="#4"
>Constructors
</A
></DT
><DT
><A HREF="#5"
>Methods
</A
></DT
><DT
><A HREF="#6"
>Signals
</A
></DT
><DT
><A HREF="#7"
>Deprecated
</A
></DT
></DL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
>Container for widgets from other processes
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3ASocket"
>Socket</A
> </TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>class</SPAN
> <A HREF="Graphics-UI-Gtk-Abstract-Container.html#t%3AContainerClass"
>ContainerClass</A
> o =&gt; <A HREF="#t%3ASocketClass"
>SocketClass</A
> o </TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AcastToSocket"
>castToSocket</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/glib-0.11.2/System-Glib-GObject.html#t%3AGObjectClass"
>GObjectClass</A
> obj =&gt; obj -&gt; <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgTypeSocket"
>gTypeSocket</A
> :: <A HREF="Graphics-UI-Gtk-Abstract-Widget.html#t%3AGType"
>GType</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AtoSocket"
>toSocket</A
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> o =&gt; o -&gt; <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3ANativeWindowId"
>NativeWindowId</A
> </TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsocketNew"
>socketNew</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsocketHasPlug"
>socketHasPlug</A
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> s =&gt; s -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsocketAddId"
>socketAddId</A
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self =&gt; self -&gt; <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ANativeWindowId"
>NativeWindowId</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsocketGetId"
>socketGetId</A
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self =&gt; self -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ANativeWindowId"
>NativeWindowId</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsocketGetPlugWindow"
>socketGetPlugWindow</A
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self =&gt; self -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Graphics-UI-Gtk-Gdk-DrawWindow.html#t%3ADrawWindow"
>DrawWindow</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsocketPlugAdded"
>socketPlugAdded</A
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self =&gt; <A HREF="/usr/share/doc/ghc/html/libraries/glib-0.11.2/System-Glib-Signals.html#t%3ASignal"
>Signal</A
> self (<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
>)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsocketPlugRemoved"
>socketPlugRemoved</A
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self =&gt; <A HREF="/usr/share/doc/ghc/html/libraries/glib-0.11.2/System-Glib-Signals.html#t%3ASignal"
>Signal</A
> self (<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
>)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AonPlugAdded"
>onPlugAdded</A
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self =&gt; self -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="/usr/share/doc/ghc/html/libraries/glib-0.11.2/System-Glib-Signals.html#t%3AConnectId"
>ConnectId</A
> self)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AafterPlugAdded"
>afterPlugAdded</A
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self =&gt; self -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="/usr/share/doc/ghc/html/libraries/glib-0.11.2/System-Glib-Signals.html#t%3AConnectId"
>ConnectId</A
> self)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AonPlugRemoved"
>onPlugRemoved</A
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self =&gt; self -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="/usr/share/doc/ghc/html/libraries/glib-0.11.2/System-Glib-Signals.html#t%3AConnectId"
>ConnectId</A
> self)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AafterPlugRemoved"
>afterPlugRemoved</A
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self =&gt; self -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="/usr/share/doc/ghc/html/libraries/glib-0.11.2/System-Glib-Signals.html#t%3AConnectId"
>ConnectId</A
> self)</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="1"
><A NAME="1"
>Detail
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Together with <TT
><A HREF="Graphics-UI-Gtk-Embedding-Plug.html#t%3APlug"
>Plug</A
></TT
>, <TT
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TT
> provides the ability to embed widgets from
 one process into another process in a fashion that is transparent to the
 user. One process creates a <TT
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TT
> widget and, passes the that widget's
 window ID to the other process, which then creates a <TT
><A HREF="Graphics-UI-Gtk-Embedding-Plug.html#t%3APlug"
>Plug</A
></TT
> with that window
 ID. Any widgets contained in the <TT
><A HREF="Graphics-UI-Gtk-Embedding-Plug.html#t%3APlug"
>Plug</A
></TT
> then will appear inside the first
 applications window.
</P
><P
>The socket's window ID is obtained by using <TT
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#v%3AsocketGetId"
>socketGetId</A
></TT
>. Before using
 this function, the socket must have been realized, and for hence, have been
 added to its parent.
</P
><UL
><LI
> Obtaining the window ID of a socket.
</LI
></UL
><PRE
> socket &lt;- socketNew
 widgetShow socket
 containerAdd parent socket

 -- The following call is only necessary if one of
 -- the ancestors of the socket is not yet visible.
 --
 widgetRealize socket
 socketId &lt;- socketGetId socket
 putStrLn (&quot;The ID of the sockets window is &quot; ++ show socketId)
</PRE
><P
>Note that if you pass the window ID of the socket to another process that
 will create a plug in the socket, you must make sure that the socket widget
 is not destroyed until that plug is created. Violating this rule will cause
 unpredictable consequences, the most likely consequence being that the plug
 will appear as a separate toplevel window. You can check if the plug has
 been created by calling <TT
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#v%3AsocketHasPlug"
>socketHasPlug</A
></TT
>.
 If this returns <TT
>True</TT
>, then the plug has been successfully created inside
 of the socket.
</P
><P
>When Gtk+ is notified that the embedded window has been destroyed, then
 it will destroy the socket as well. You should always, therefore, be
 prepared for your sockets to be destroyed at any time when the main event
 loop is running.
</P
><P
>The communication between a <TT
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TT
> and a <TT
><A HREF="Graphics-UI-Gtk-Embedding-Plug.html#t%3APlug"
>Plug</A
></TT
> follows the XEmbed
 protocol. This protocol has also been implemented in other toolkits, e.g.
 Qt, allowing the same level of integration when embedding a Qt widget in
 Gtk+ or vice versa.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="2"
><A NAME="2"
>Class Hierarchy
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="doc"
><PRE
>
 | <TT
><A HREF="/usr/share/doc/ghc/html/libraries/glib-0.11.2/System-Glib-GObject.html#t%3AGObject"
>GObject</A
></TT
>
 | +----<TT
><A HREF="Graphics-UI-Gtk-Abstract-Object.html#t%3AObject"
>Object</A
></TT
>
 | +----<TT
><A HREF="Graphics-UI-Gtk-Abstract-Widget.html#t%3AWidget"
>Widget</A
></TT
>
 | +----<TT
><A HREF="Graphics-UI-Gtk-Abstract-Container.html#t%3AContainer"
>Container</A
></TT
>
 | +----Socket
</PRE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="3"
><A NAME="3"
>Types
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:Socket"
><A NAME="t%3ASocket"
></A
></A
><B
>Socket</B
>  </TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-Types.html#Socket"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Socket')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:Socket" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Eq.html#t%3AEq"
>Eq</A
> <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Ord.html#t%3AOrd"
>Ord</A
> <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/glib-0.11.2/System-Glib-GObject.html#t%3AGObjectClass"
>GObjectClass</A
> <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Graphics-UI-Gtk-Abstract-Container.html#t%3AContainerClass"
>ContainerClass</A
> <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Graphics-UI-Gtk-Abstract-Widget.html#t%3AWidgetClass"
>WidgetClass</A
> <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Graphics-UI-Gtk-Abstract-Object.html#t%3AObjectClass"
>ObjectClass</A
> <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>class</SPAN
> <A HREF="Graphics-UI-Gtk-Abstract-Container.html#t%3AContainerClass"
>ContainerClass</A
> o =&gt; <A NAME="t:SocketClass"
><A NAME="t%3ASocketClass"
></A
></A
><B
>SocketClass</B
> o </TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-Types.html#SocketClass"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:SocketClass')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:SocketClass" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:castToSocket"
><A NAME="v%3AcastToSocket"
></A
></A
><B
>castToSocket</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/glib-0.11.2/System-Glib-GObject.html#t%3AGObjectClass"
>GObjectClass</A
> obj =&gt; obj -&gt; <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-Types.html#castToSocket"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:gTypeSocket"
><A NAME="v%3AgTypeSocket"
></A
></A
><B
>gTypeSocket</B
> :: <A HREF="Graphics-UI-Gtk-Abstract-Widget.html#t%3AGType"
>GType</A
></TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-Types.html#gTypeSocket"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:toSocket"
><A NAME="v%3AtoSocket"
></A
></A
><B
>toSocket</B
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> o =&gt; o -&gt; <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-Types.html#toSocket"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:NativeWindowId"
><A NAME="t%3ANativeWindowId"
></A
></A
><B
>NativeWindowId</B
>  </TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-General-Structs.html#NativeWindowId"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>The identifer of a window of the underlying windowing system.
</TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:NativeWindowId')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:NativeWindowId" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Eq.html#t%3AEq"
>Eq</A
> <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ANativeWindowId"
>NativeWindowId</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Show.html#t%3AShow"
>Show</A
> <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ANativeWindowId"
>NativeWindowId</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="4"
><A NAME="4"
>Constructors
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:socketNew"
><A NAME="v%3AsocketNew"
></A
></A
><B
>socketNew</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-Embedding-Socket.html#socketNew"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Create a new empty <TT
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TT
>.
</P
><P
><TT
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TT
> is a <TT
><A HREF="Graphics-UI-Gtk-Abstract-Container.html#t%3AContainer"
>Container</A
></TT
> for foreign applications that support the XEMBED
 protocol. To connect two applications the <TT
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ANativeWindowId"
>NativeWindowId</A
></TT
> has to be passed
 either from this socket to the other application's <TT
><A HREF="Graphics-UI-Gtk-Embedding-Plug.html#t%3APlug"
>Plug</A
></TT
> or vice versa.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="5"
><A NAME="5"
>Methods
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:socketHasPlug"
><A NAME="v%3AsocketHasPlug"
></A
></A
><B
>socketHasPlug</B
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> s =&gt; s -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-Embedding-Embedding.html#socketHasPlug"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Test if a Plug is connected to the socket.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:socketAddId"
><A NAME="v%3AsocketAddId"
></A
></A
><B
>socketAddId</B
></TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-Embedding-Socket.html#socketAddId"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
>=&gt; self</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ANativeWindowId"
>NativeWindowId</A
></TD
><TD CLASS="rdoc"
><TT
>windowId</TT
> - the window ID of a client
 participating in the XEMBED protocol.
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
><P
>Adds an XEMBED client, such as a <TT
><A HREF="Graphics-UI-Gtk-Embedding-Plug.html#t%3APlug"
>Plug</A
></TT
>, to the <TT
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TT
>. The client may
 be in the same process or in a different process.
</P
><P
>To embed a <TT
><A HREF="Graphics-UI-Gtk-Embedding-Plug.html#t%3APlug"
>Plug</A
></TT
> in a <TT
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TT
>, you can either create the <TT
><A HREF="Graphics-UI-Gtk-Embedding-Plug.html#t%3APlug"
>Plug</A
></TT
> with
 <TT
>Graphics.UI.Gtk.Embedding.Plug.plugNew Nothing</TT
>, call
 Graphics.UI.Gtk.Embedding.Plug.plugGetId to get the window ID of the
 plug, and then pass that to the <TT
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#v%3AsocketAddId"
>socketAddId</A
></TT
>, or you can call
 <TT
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#v%3AsocketGetId"
>socketGetId</A
></TT
> to get the window ID for the socket, and call
 Graphics.UI.Gtk.Embedding.Plug.plugNew passing in that ID.
</P
><P
>The <TT
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TT
> must have already be added into a toplevel window before you
 can make this call.
</P
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:socketGetId"
><A NAME="v%3AsocketGetId"
></A
></A
><B
>socketGetId</B
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self =&gt; self -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ANativeWindowId"
>NativeWindowId</A
></TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-Embedding-Socket.html#socketGetId"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Gets the window ID of a <TT
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TT
> widget, which can then be used to create
 a client embedded inside the socket, for instance with
 Graphics.UI.Gtk.Embedding.Plug.plugNew.
</P
><P
>The <TT
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TT
> must have already be added into a toplevel window before you
 can make this call.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:socketGetPlugWindow"
><A NAME="v%3AsocketGetPlugWindow"
></A
></A
><B
>socketGetPlugWindow</B
></TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-Embedding-Socket.html#socketGetPlugWindow"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
>=&gt; self</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Graphics-UI-Gtk-Gdk-DrawWindow.html#t%3ADrawWindow"
>DrawWindow</A
></TD
><TD CLASS="rdoc"
>returns the window of the plug if available, or
 {<TT
>((void *)0)</TT
>, FIXME: this should probably be converted to a
 Maybe data type}
</TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
><P
>Retrieves the window of the plug. Use this to check if the plug has been
 created inside of the socket.
</P
><UL
><LI
> Available since Gtk+ version 2.14
</LI
></UL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="6"
><A NAME="6"
>Signals
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:socketPlugAdded"
><A NAME="v%3AsocketPlugAdded"
></A
></A
><B
>socketPlugAdded</B
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self =&gt; <A HREF="/usr/share/doc/ghc/html/libraries/glib-0.11.2/System-Glib-Signals.html#t%3ASignal"
>Signal</A
> self (<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
>)</TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-Embedding-Socket.html#socketPlugAdded"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>This signal is emitted when a client is successfully added to the socket.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:socketPlugRemoved"
><A NAME="v%3AsocketPlugRemoved"
></A
></A
><B
>socketPlugRemoved</B
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self =&gt; <A HREF="/usr/share/doc/ghc/html/libraries/glib-0.11.2/System-Glib-Signals.html#t%3ASignal"
>Signal</A
> self (<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
>)</TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-Embedding-Socket.html#socketPlugRemoved"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>This signal is emitted when a client is removed from the socket. The
 default action is to destroy the <TT
><A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocket"
>Socket</A
></TT
> widget, so if you want to reuse it
 you must add a signal handler that returns <TT
>True</TT
>.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="7"
><A NAME="7"
>Deprecated
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:onPlugAdded"
><A NAME="v%3AonPlugAdded"
></A
></A
><B
>onPlugAdded</B
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self =&gt; self -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="/usr/share/doc/ghc/html/libraries/glib-0.11.2/System-Glib-Signals.html#t%3AConnectId"
>ConnectId</A
> self)</TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-Embedding-Socket.html#onPlugAdded"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:afterPlugAdded"
><A NAME="v%3AafterPlugAdded"
></A
></A
><B
>afterPlugAdded</B
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self =&gt; self -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="/usr/share/doc/ghc/html/libraries/glib-0.11.2/System-Glib-Signals.html#t%3AConnectId"
>ConnectId</A
> self)</TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-Embedding-Socket.html#afterPlugAdded"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:onPlugRemoved"
><A NAME="v%3AonPlugRemoved"
></A
></A
><B
>onPlugRemoved</B
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self =&gt; self -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="/usr/share/doc/ghc/html/libraries/glib-0.11.2/System-Glib-Signals.html#t%3AConnectId"
>ConnectId</A
> self)</TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-Embedding-Socket.html#onPlugRemoved"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:afterPlugRemoved"
><A NAME="v%3AafterPlugRemoved"
></A
></A
><B
>afterPlugRemoved</B
> :: <A HREF="Graphics-UI-Gtk-Embedding-Socket.html#t%3ASocketClass"
>SocketClass</A
> self =&gt; self -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="/usr/share/doc/ghc/html/libraries/glib-0.11.2/System-Glib-Signals.html#t%3AConnectId"
>ConnectId</A
> self)</TD
><TD CLASS="declbut"
><A HREF="src/Graphics-UI-Gtk-Embedding-Socket.html#afterPlugRemoved"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.6.1</TD
></TR
></TABLE
></BODY
></HTML
>