<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Graphics.UI.Gtk.Misc.HandleBox</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Graphics-UI-Gtk-Misc-HandleBox.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-Misc-HandleBox.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">gtk-0.12.0: Binding to the Gtk+ graphical user interface library.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable (depends on GHC)</td></tr><tr><th>Stability</th><td>provisional</td></tr><tr><th>Maintainer</th><td>gtk2hs-users@lists.sourceforge.net</td></tr></table><p class="caption">Graphics.UI.Gtk.Misc.HandleBox</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Detail
</a></li><li><a href="#g:2">Class Hierarchy
</a></li><li><a href="#g:3">Types
</a></li><li><a href="#g:4">Constructors
</a></li><li><a href="#g:5">Methods
</a></li><li><a href="#g:6">Attributes
</a></li><li><a href="#g:7">Signals
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>a widget for detachable window portions
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:HandleBox">HandleBox</a> </li><li class="src short"><span class="keyword">class</span> <a href="Graphics-UI-Gtk-Abstract-Bin.html#t:BinClass">BinClass</a> o => <a href="#t:HandleBoxClass">HandleBoxClass</a> o </li><li class="src short"><a href="#v:castToHandleBox">castToHandleBox</a> :: <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> obj => obj -> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBox">HandleBox</a></li><li class="src short"><a href="#v:gTypeHandleBox">gTypeHandleBox</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a></li><li class="src short"><a href="#v:toHandleBox">toHandleBox</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> o => o -> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBox">HandleBox</a></li><li class="src short"><a href="#v:handleBoxNew">handleBoxNew</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBox">HandleBox</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:ShadowType">ShadowType</a> <ul class="subs"><li>= <a href="#v:ShadowNone">ShadowNone</a> </li><li>| <a href="#v:ShadowIn">ShadowIn</a> </li><li>| <a href="#v:ShadowOut">ShadowOut</a> </li><li>| <a href="#v:ShadowEtchedIn">ShadowEtchedIn</a> </li><li>| <a href="#v:ShadowEtchedOut">ShadowEtchedOut</a> </li></ul></li><li class="src short"><a href="#v:handleBoxSetShadowType">handleBoxSetShadowType</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:ShadowType">ShadowType</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:handleBoxGetShadowType">handleBoxGetShadowType</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:ShadowType">ShadowType</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:PositionType">PositionType</a> <ul class="subs"><li>= <a href="#v:PosLeft">PosLeft</a> </li><li>| <a href="#v:PosRight">PosRight</a> </li><li>| <a href="#v:PosTop">PosTop</a> </li><li>| <a href="#v:PosBottom">PosBottom</a> </li></ul></li><li class="src short"><a href="#v:handleBoxSetHandlePosition">handleBoxSetHandlePosition</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:PositionType">PositionType</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:handleBoxGetHandlePosition">handleBoxGetHandlePosition</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:PositionType">PositionType</a></li><li class="src short"><a href="#v:handleBoxSetSnapEdge">handleBoxSetSnapEdge</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:PositionType">PositionType</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:handleBoxGetSnapEdge">handleBoxGetSnapEdge</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:PositionType">PositionType</a></li><li class="src short"><a href="#v:handleBoxShadowType">handleBoxShadowType</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:ShadowType">ShadowType</a></li><li class="src short"><a href="#v:handleBoxHandlePosition">handleBoxHandlePosition</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:PositionType">PositionType</a></li><li class="src short"><a href="#v:handleBoxSnapEdge">handleBoxSnapEdge</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:PositionType">PositionType</a></li><li class="src short"><a href="#v:handleBoxSnapEdgeSet">handleBoxSnapEdgeSet</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:onChildAttached">onChildAttached</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:ConnectId">ConnectId</a> self)</li><li class="src short"><a href="#v:afterChildAttached">afterChildAttached</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:ConnectId">ConnectId</a> self)</li><li class="src short"><a href="#v:onChildDetached">onChildDetached</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:ConnectId">ConnectId</a> self)</li><li class="src short"><a href="#v:afterChildDetached">afterChildDetached</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:ConnectId">ConnectId</a> self)</li></ul></div><div id="interface"><h1 id="g:1">Detail
</h1><div class="doc"><p>The <code><a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBox">HandleBox</a></code> widget allows a portion of a window to be "torn off".
It is a bin widget which displays its child and a handle that the user can
drag to tear off a separate window (the float window) containing the child
widget. A thin ghost is drawn in the original location of the handlebox. By
dragging the separate window back to its original location, it can be
reattached.
</p><p>When reattaching, the ghost and float window, must be aligned along one
of the edges, the snap edge. This either can be specified by the application
programmer explicitely, or Gtk+ will pick a reasonable default based on the
handle position.
</p><p>To make detaching and reattaching the handlebox as minimally confusing as
possible to the user, it is important to set the snap edge so that the snap
edge does not move when the handlebox is deattached. For instance, if the
handlebox is packed at the bottom of a VBox, then when the handlebox is
detached, the bottom edge of the handlebox's allocation will remain fixed as
the height of the handlebox shrinks, so the snap edge should be set to
<code><a href="Graphics-UI-Gtk-Misc-HandleBox.html#v:PosBottom">PosBottom</a></code>.
</p></div><h1 id="g:2">Class Hierarchy
</h1><div class="doc"><pre>
| <code><a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObject">GObject</a></code>
| +----<code><a href="Graphics-UI-Gtk-Abstract-Object.html#t:Object">Object</a></code>
| +----<code><a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a></code>
| +----<code><a href="Graphics-UI-Gtk-Abstract-Container.html#t:Container">Container</a></code>
| +----<code><a href="Graphics-UI-Gtk-Abstract-Bin.html#t:Bin">Bin</a></code>
| +----HandleBox
</pre></div><h1 id="g:3">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:HandleBox" class="def">HandleBox</a> <a href="src/Graphics-UI-Gtk-Types.html#HandleBox" class="link">Source</a></p><div class="subs instances"><p id="control.i:HandleBox" class="caption collapser" onclick="toggleSection('i:HandleBox')">Instances</p><div id="section.i:HandleBox" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBox">HandleBox</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBox">HandleBox</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBox">HandleBox</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBox">HandleBox</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Abstract-Bin.html#t:BinClass">BinClass</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBox">HandleBox</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Abstract-Container.html#t:ContainerClass">ContainerClass</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBox">HandleBox</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBox">HandleBox</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Abstract-Object.html#t:ObjectClass">ObjectClass</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBox">HandleBox</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a href="Graphics-UI-Gtk-Abstract-Bin.html#t:BinClass">BinClass</a> o => <a name="t:HandleBoxClass" class="def">HandleBoxClass</a> o <a href="src/Graphics-UI-Gtk-Types.html#HandleBoxClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:HandleBoxClass" class="caption collapser" onclick="toggleSection('i:HandleBoxClass')">Instances</p><div id="section.i:HandleBoxClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBox">HandleBox</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:castToHandleBox" class="def">castToHandleBox</a> :: <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> obj => obj -> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBox">HandleBox</a><a href="src/Graphics-UI-Gtk-Types.html#castToHandleBox" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:gTypeHandleBox" class="def">gTypeHandleBox</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a><a href="src/Graphics-UI-Gtk-Types.html#gTypeHandleBox" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:toHandleBox" class="def">toHandleBox</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> o => o -> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBox">HandleBox</a><a href="src/Graphics-UI-Gtk-Types.html#toHandleBox" class="link">Source</a></p></div><h1 id="g:4">Constructors
</h1><div class="top"><p class="src"><a name="v:handleBoxNew" class="def">handleBoxNew</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBox">HandleBox</a><a href="src/Graphics-UI-Gtk-Misc-HandleBox.html#handleBoxNew" class="link">Source</a></p><div class="doc"><p>Create a new handle box.
</p></div></div><h1 id="g:5">Methods
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ShadowType" class="def">ShadowType</a> <a href="src/Graphics-UI-Gtk-General-Enums.html#ShadowType" class="link">Source</a></p><div class="doc"><p>Shadow types
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ShadowNone" class="def">ShadowNone</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ShadowIn" class="def">ShadowIn</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ShadowOut" class="def">ShadowOut</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ShadowEtchedIn" class="def">ShadowEtchedIn</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ShadowEtchedOut" class="def">ShadowEtchedOut</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:ShadowType" class="caption collapser" onclick="toggleSection('i:ShadowType')">Instances</p><div id="section.i:ShadowType" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Enum">Enum</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:ShadowType">ShadowType</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:ShadowType">ShadowType</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:ShadowType">ShadowType</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:handleBoxSetShadowType" class="def">handleBoxSetShadowType</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:ShadowType">ShadowType</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Graphics-UI-Gtk-Misc-HandleBox.html#handleBoxSetShadowType" class="link">Source</a></p><div class="doc"><p>Sets the type of shadow to be drawn around the border of the handle box.
</p></div></div><div class="top"><p class="src"><a name="v:handleBoxGetShadowType" class="def">handleBoxGetShadowType</a><a href="src/Graphics-UI-Gtk-Misc-HandleBox.html#handleBoxGetShadowType" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:ShadowType">ShadowType</a></td><td class="doc"><p>returns the type of shadow currently drawn around the
handle box.
</p></td></tr></table></div><div class="doc"><p>Gets the type of shadow drawn around the handle box. See
<code><a href="Graphics-UI-Gtk-Misc-HandleBox.html#v:handleBoxSetShadowType">handleBoxSetShadowType</a></code>.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:PositionType" class="def">PositionType</a> <a href="src/Graphics-UI-Gtk-General-Enums.html#PositionType" class="link">Source</a></p><div class="doc"><p>Position a scale's value is drawn relative to the
trough
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:PosLeft" class="def">PosLeft</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:PosRight" class="def">PosRight</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:PosTop" class="def">PosTop</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:PosBottom" class="def">PosBottom</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:PositionType" class="caption collapser" onclick="toggleSection('i:PositionType')">Instances</p><div id="section.i:PositionType" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Enum">Enum</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:PositionType">PositionType</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:PositionType">PositionType</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:PositionType">PositionType</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:handleBoxSetHandlePosition" class="def">handleBoxSetHandlePosition</a><a href="src/Graphics-UI-Gtk-Misc-HandleBox.html#handleBoxSetHandlePosition" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:PositionType">PositionType</a></td><td class="doc"><p><code>position</code> - the side of the handlebox where the handle
should be drawn.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Sets the side of the handlebox where the handle is drawn.
</p></div></div><div class="top"><p class="src"><a name="v:handleBoxGetHandlePosition" class="def">handleBoxGetHandlePosition</a><a href="src/Graphics-UI-Gtk-Misc-HandleBox.html#handleBoxGetHandlePosition" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:PositionType">PositionType</a></td><td class="doc"><p>returns the current handle position.
</p></td></tr></table></div><div class="doc"><p>Gets the handle position of the handle box. See
<code><a href="Graphics-UI-Gtk-Misc-HandleBox.html#v:handleBoxSetHandlePosition">handleBoxSetHandlePosition</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:handleBoxSetSnapEdge" class="def">handleBoxSetSnapEdge</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:PositionType">PositionType</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Graphics-UI-Gtk-Misc-HandleBox.html#handleBoxSetSnapEdge" class="link">Source</a></p><div class="doc"><p>Sets the snap edge of the HandleBox. The snap edge is the edge of the
detached child that must be aligned with the corresponding edge of the
"ghost" left behind when the child was detached to reattach the torn-off
window. Usually, the snap edge should be chosen so that it stays in the same
place on the screen when the handlebox is torn off.
</p><p>If the snap edge is not set, then an appropriate value will be guessed
from the handle position. If the handle position is <code><a href="Graphics-UI-Gtk-Misc-HandleBox.html#v:PosRight">PosRight</a></code> or <code><a href="Graphics-UI-Gtk-Misc-HandleBox.html#v:PosLeft">PosLeft</a></code>,
then the snap edge will be <code><a href="Graphics-UI-Gtk-Misc-HandleBox.html#v:PosTop">PosTop</a></code>, otherwise it will be <code><a href="Graphics-UI-Gtk-Misc-HandleBox.html#v:PosLeft">PosLeft</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:handleBoxGetSnapEdge" class="def">handleBoxGetSnapEdge</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:PositionType">PositionType</a><a href="src/Graphics-UI-Gtk-Misc-HandleBox.html#handleBoxGetSnapEdge" class="link">Source</a></p><div class="doc"><p>Gets the edge used for determining reattachment of the handle box. See
<code><a href="Graphics-UI-Gtk-Misc-HandleBox.html#v:handleBoxSetSnapEdge">handleBoxSetSnapEdge</a></code>.
</p></div></div><h1 id="g:6">Attributes
</h1><div class="top"><p class="src"><a name="v:handleBoxShadowType" class="def">handleBoxShadowType</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:ShadowType">ShadowType</a><a href="src/Graphics-UI-Gtk-Misc-HandleBox.html#handleBoxShadowType" class="link">Source</a></p><div class="doc"><p>Appearance of the shadow that surrounds the container.
</p><p>Default value: <code><a href="Graphics-UI-Gtk-Misc-HandleBox.html#v:ShadowEtchedOut">ShadowEtchedOut</a></code>
</p></div></div><div class="top"><p class="src"><a name="v:handleBoxHandlePosition" class="def">handleBoxHandlePosition</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:PositionType">PositionType</a><a href="src/Graphics-UI-Gtk-Misc-HandleBox.html#handleBoxHandlePosition" class="link">Source</a></p><div class="doc"><p>Position of the handle relative to the child widget.
</p><p>Default value: <code><a href="Graphics-UI-Gtk-Misc-HandleBox.html#v:PosLeft">PosLeft</a></code>
</p></div></div><div class="top"><p class="src"><a name="v:handleBoxSnapEdge" class="def">handleBoxSnapEdge</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:PositionType">PositionType</a><a href="src/Graphics-UI-Gtk-Misc-HandleBox.html#handleBoxSnapEdge" class="link">Source</a></p><div class="doc"><p>Side of the handlebox that's lined up with the docking point to dock the
handlebox.
</p><p>Default value: <code><a href="Graphics-UI-Gtk-Misc-HandleBox.html#v:PosTop">PosTop</a></code>
</p></div></div><div class="top"><p class="src"><a name="v:handleBoxSnapEdgeSet" class="def">handleBoxSnapEdgeSet</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-Misc-HandleBox.html#handleBoxSnapEdgeSet" class="link">Source</a></p><div class="doc"><p>Whether to use the value from the snap_edge property or a value derived
from handle_position.
</p><p>Default value: <code>False</code>
</p></div></div><h1 id="g:7">Signals
</h1><div class="top"><p class="src"><a name="v:onChildAttached" class="def">onChildAttached</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:ConnectId">ConnectId</a> self)<a href="src/Graphics-UI-Gtk-Misc-HandleBox.html#onChildAttached" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:afterChildAttached" class="def">afterChildAttached</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:ConnectId">ConnectId</a> self)<a href="src/Graphics-UI-Gtk-Misc-HandleBox.html#afterChildAttached" class="link">Source</a></p><div class="doc"><p>This signal is emitted when the contents of the handlebox are reattached
to the main window.
</p></div></div><div class="top"><p class="src"><a name="v:onChildDetached" class="def">onChildDetached</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:ConnectId">ConnectId</a> self)<a href="src/Graphics-UI-Gtk-Misc-HandleBox.html#onChildDetached" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:afterChildDetached" class="def">afterChildDetached</a> :: <a href="Graphics-UI-Gtk-Misc-HandleBox.html#t:HandleBoxClass">HandleBoxClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:ConnectId">ConnectId</a> self)<a href="src/Graphics-UI-Gtk-Misc-HandleBox.html#afterChildDetached" class="link">Source</a></p><div class="doc"><p>This signal is emitted when the contents of the handlebox are detached
from the main window.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
