1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
|
-- -*-haskell-*-
-- GIMP Toolkit (GTK) Widget AspectFrame
--
-- Author : Axel Simon
--
-- Created: 15 May 2001
--
-- Copyright (C) 1999-2005 Axel Simon
--
-- This library is free software; you can redistribute it and/or
-- modify it under the terms of the GNU Lesser General Public
-- License as published by the Free Software Foundation; either
-- version 2.1 of the License, or (at your option) any later version.
--
-- This library is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-- Lesser General Public License for more details.
--
-- |
-- Maintainer : gtk2hs-users@lists.sourceforge.net
-- Stability : provisional
-- Portability : portable (depends on GHC)
--
-- A frame that constrains its child to a particular aspect ratio
--
module Graphics.UI.Gtk.Layout.AspectFrame (
-- * Detail
--
-- | The 'AspectFrame' 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. 'AspectFrame' derives from
-- 'Frame', so it can draw a label and a frame around the child. The frame will
-- be \"shrink-wrapped\" to the size of the child.
-- * Class Hierarchy
-- |
-- @
-- | 'GObject'
-- | +----'Object'
-- | +----'Widget'
-- | +----'Container'
-- | +----'Bin'
-- | +----'Frame'
-- | +----AspectFrame
-- @
-- * Types
AspectFrame,
AspectFrameClass,
castToAspectFrame, gTypeAspectFrame,
toAspectFrame,
-- * Constructors
aspectFrameNew,
-- * Methods
aspectFrameSet,
-- * Attributes
aspectFrameXAlign,
aspectFrameYAlign,
aspectFrameRatio,
aspectFrameObeyChild,
) where
import Control.Monad (liftM)
import Data.Maybe (isNothing)
import System.Glib.FFI
import System.Glib.Attributes
import System.Glib.Properties
import Graphics.UI.Gtk.Abstract.Object (makeNewObject)
{#import Graphics.UI.Gtk.Types#}
{# context lib="gtk" prefix="gtk" #}
--------------------
-- Constructors
-- | Create a new 'AspectFrame'.
--
-- The frame may be augmented with a label which can be set by @frameSetLabel@.
--
aspectFrameNew ::
Float -- ^ @xalign@ - Horizontal alignment of the child within
-- the allocation of the 'AspectFrame'. This ranges from 0.0
-- (left aligned) to 1.0 (right aligned)
-> Float -- ^ @yalign@ - Vertical alignment of the child within the
-- allocation of the 'AspectFrame'. This ranges from 0.0
-- (left aligned) to 1.0 (right aligned)
-> Maybe Float -- ^ @ratio@ - The desired aspect ratio. If @Nothing@ the
-- aspect ratio is taken from the requistion of the child.
-> IO AspectFrame
aspectFrameNew xalign yalign ratio =
makeNewObject mkAspectFrame $
liftM (castPtr :: Ptr Widget -> Ptr AspectFrame) $
{# call unsafe aspect_frame_new #}
nullPtr
(realToFrac xalign)
(realToFrac yalign)
(maybe 0.0 realToFrac ratio)
(fromBool $ isNothing ratio)
--------------------
-- Methods
-- | Set parameters for an existing 'AspectFrame'.
--
aspectFrameSet :: AspectFrameClass self => self
-> Float -- ^ @xalign@ - Horizontal alignment of the child within the
-- allocation of the 'AspectFrame'. This ranges from 0.0 (left
-- aligned) to 1.0 (right aligned)
-> Float -- ^ @yalign@ - Vertical alignment of the child within the
-- allocation of the 'AspectFrame'. This ranges from 0.0 (left
-- aligned) to 1.0 (right aligned)
-> Maybe Float -- ^ @ratio@ - The desired aspect ratio. If @Nothing@ the
-- aspect ratio is taken from the requistion of the child.
-> IO ()
aspectFrameSet self xalign yalign ratio =
{# call aspect_frame_set #}
(toAspectFrame self)
(realToFrac xalign)
(realToFrac yalign)
(maybe 0.0 realToFrac ratio)
(fromBool $ isNothing ratio)
--------------------
-- Attributes
-- | X alignment of the child.
--
-- Allowed values: [0,1]
--
-- Default value: 0.5
--
aspectFrameXAlign :: AspectFrameClass self => Attr self Float
aspectFrameXAlign = newAttrFromFloatProperty "xalign"
-- | Y alignment of the child.
--
-- Allowed values: [0,1]
--
-- Default value: 0.5
--
aspectFrameYAlign :: AspectFrameClass self => Attr self Float
aspectFrameYAlign = newAttrFromFloatProperty "yalign"
-- | Aspect ratio if obey_child is @False@.
--
-- Allowed values: [1e-04,10000]
--
-- Default value: 0.5
--
aspectFrameRatio :: AspectFrameClass self => Attr self Float
aspectFrameRatio = newAttrFromFloatProperty "ratio"
-- | Force aspect ratio to match that of the frame's child.
--
-- Default value: @True@
--
aspectFrameObeyChild :: AspectFrameClass self => Attr self Bool
aspectFrameObeyChild = newAttrFromBoolProperty "obey-child"
|