<!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.Layout.AspectFrame</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-Layout-AspectFrame.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-Layout-AspectFrame.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.Layout.AspectFrame</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></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A frame that constrains its child to a particular aspect ratio
</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:AspectFrame">AspectFrame</a> </li><li class="src short"><span class="keyword">class</span> <a href="Graphics-UI-Gtk-Ornaments-Frame.html#t:FrameClass">FrameClass</a> o => <a href="#t:AspectFrameClass">AspectFrameClass</a> o </li><li class="src short"><a href="#v:castToAspectFrame">castToAspectFrame</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-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a></li><li class="src short"><a href="#v:gTypeAspectFrame">gTypeAspectFrame</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a></li><li class="src short"><a href="#v:toAspectFrame">toAspectFrame</a> :: <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrameClass">AspectFrameClass</a> o => o -> <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a></li><li class="src short"><a href="#v:aspectFrameNew">aspectFrameNew</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Float">Float</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Float">Float</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Float">Float</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-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a></li><li class="src short"><a href="#v:aspectFrameSet">aspectFrameSet</a> :: <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrameClass">AspectFrameClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Float">Float</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Float">Float</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Float">Float</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:aspectFrameXAlign">aspectFrameXAlign</a> :: <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrameClass">AspectFrameClass</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/Prelude.html#t:Float">Float</a></li><li class="src short"><a href="#v:aspectFrameYAlign">aspectFrameYAlign</a> :: <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrameClass">AspectFrameClass</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/Prelude.html#t:Float">Float</a></li><li class="src short"><a href="#v:aspectFrameRatio">aspectFrameRatio</a> :: <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrameClass">AspectFrameClass</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/Prelude.html#t:Float">Float</a></li><li class="src short"><a href="#v:aspectFrameObeyChild">aspectFrameObeyChild</a> :: <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrameClass">AspectFrameClass</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></ul></div><div id="interface"><h1 id="g:1">Detail
</h1><div class="doc"><p>The <code><a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a></code> is useful when you want pack a widget so that it can
resize but always retains the same aspect ratio. For instance, one might be
drawing a small preview of a larger image. <code><a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a></code> derives from
<code><a href="Graphics-UI-Gtk-Ornaments-Frame.html#t:Frame">Frame</a></code>, so it can draw a label and a frame around the child. The frame will
be "shrink-wrapped" to the size of the child.
</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>
| +----<code><a href="Graphics-UI-Gtk-Ornaments-Frame.html#t:Frame">Frame</a></code>
| +----AspectFrame
</pre></div><h1 id="g:3">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:AspectFrame" class="def">AspectFrame</a> <a href="src/Graphics-UI-Gtk-Types.html#AspectFrame" class="link">Source</a></p><div class="subs instances"><p id="control.i:AspectFrame" class="caption collapser" onclick="toggleSection('i:AspectFrame')">Instances</p><div id="section.i:AspectFrame" 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-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</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-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</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-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrameClass">AspectFrameClass</a> <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Ornaments-Frame.html#t:FrameClass">FrameClass</a> <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</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-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</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-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</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-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</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-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</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-Ornaments-Frame.html#t:FrameClass">FrameClass</a> o => <a name="t:AspectFrameClass" class="def">AspectFrameClass</a> o <a href="src/Graphics-UI-Gtk-Types.html#AspectFrameClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:AspectFrameClass" class="caption collapser" onclick="toggleSection('i:AspectFrameClass')">Instances</p><div id="section.i:AspectFrameClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrameClass">AspectFrameClass</a> <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:castToAspectFrame" class="def">castToAspectFrame</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-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a><a href="src/Graphics-UI-Gtk-Types.html#castToAspectFrame" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:gTypeAspectFrame" class="def">gTypeAspectFrame</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a><a href="src/Graphics-UI-Gtk-Types.html#gTypeAspectFrame" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:toAspectFrame" class="def">toAspectFrame</a> :: <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrameClass">AspectFrameClass</a> o => o -> <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a><a href="src/Graphics-UI-Gtk-Types.html#toAspectFrame" class="link">Source</a></p></div><h1 id="g:4">Constructors
</h1><div class="top"><p class="src"><a name="v:aspectFrameNew" class="def">aspectFrameNew</a><a href="src/Graphics-UI-Gtk-Layout-AspectFrame.html#aspectFrameNew" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Float">Float</a></td><td class="doc"><p><code>xalign</code> - Horizontal alignment of the child within
the allocation of the <code><a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a></code>. This ranges from 0.0
(left aligned) to 1.0 (right aligned)
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Float">Float</a></td><td class="doc"><p><code>yalign</code> - Vertical alignment of the child within the
allocation of the <code><a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a></code>. This ranges from 0.0
(left aligned) to 1.0 (right aligned)
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Float">Float</a></td><td class="doc"><p><code>ratio</code> - The desired aspect ratio. If <code>Nothing</code> the
aspect ratio is taken from the requistion of the child.
</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="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Create a new <code><a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a></code>.
</p><p>The frame may be augmented with a label which can be set by <code>frameSetLabel</code>.
</p></div></div><h1 id="g:5">Methods
</h1><div class="top"><p class="src"><a name="v:aspectFrameSet" class="def">aspectFrameSet</a><a href="src/Graphics-UI-Gtk-Layout-AspectFrame.html#aspectFrameSet" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrameClass">AspectFrameClass</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/Prelude.html#t:Float">Float</a></td><td class="doc"><p><code>xalign</code> - Horizontal alignment of the child within the
allocation of the <code><a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a></code>. This ranges from 0.0 (left
aligned) to 1.0 (right aligned)
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Float">Float</a></td><td class="doc"><p><code>yalign</code> - Vertical alignment of the child within the
allocation of the <code><a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a></code>. This ranges from 0.0 (left
aligned) to 1.0 (right aligned)
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Float">Float</a></td><td class="doc"><p><code>ratio</code> - The desired aspect ratio. If <code>Nothing</code> the
aspect ratio is taken from the requistion of the child.
</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>Set parameters for an existing <code><a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrame">AspectFrame</a></code>.
</p></div></div><h1 id="g:6">Attributes
</h1><div class="top"><p class="src"><a name="v:aspectFrameXAlign" class="def">aspectFrameXAlign</a> :: <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrameClass">AspectFrameClass</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/Prelude.html#t:Float">Float</a><a href="src/Graphics-UI-Gtk-Layout-AspectFrame.html#aspectFrameXAlign" class="link">Source</a></p><div class="doc"><p>X alignment of the child.
</p><p>Allowed values: [0,1]
</p><p>Default value: 0.5
</p></div></div><div class="top"><p class="src"><a name="v:aspectFrameYAlign" class="def">aspectFrameYAlign</a> :: <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrameClass">AspectFrameClass</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/Prelude.html#t:Float">Float</a><a href="src/Graphics-UI-Gtk-Layout-AspectFrame.html#aspectFrameYAlign" class="link">Source</a></p><div class="doc"><p>Y alignment of the child.
</p><p>Allowed values: [0,1]
</p><p>Default value: 0.5
</p></div></div><div class="top"><p class="src"><a name="v:aspectFrameRatio" class="def">aspectFrameRatio</a> :: <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrameClass">AspectFrameClass</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/Prelude.html#t:Float">Float</a><a href="src/Graphics-UI-Gtk-Layout-AspectFrame.html#aspectFrameRatio" class="link">Source</a></p><div class="doc"><p>Aspect ratio if obey_child is <code>False</code>.
</p><p>Allowed values: [1e-04,10000]
</p><p>Default value: 0.5
</p></div></div><div class="top"><p class="src"><a name="v:aspectFrameObeyChild" class="def">aspectFrameObeyChild</a> :: <a href="Graphics-UI-Gtk-Layout-AspectFrame.html#t:AspectFrameClass">AspectFrameClass</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-Layout-AspectFrame.html#aspectFrameObeyChild" class="link">Source</a></p><div class="doc"><p>Force aspect ratio to match that of the frame's child.
</p><p>Default value: <code>True</code>
</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>
