[Gtk2hs-commit] (main branch): Add new module Buttons.VolumeButton

[Andy S. <And...@co...>]

diffing dir...
Tue Sep  7 04:48:13 EDT 2010  Andy Stewart <laz...@gm...>
  * Add new module Buttons.VolumeButton
  Ignore-this: ae9d437d70b9bf4387a2742a02507fe0
    {
    addfile ./gtk/Graphics/UI/Gtk/Buttons/VolumeButton.chs
    hunk ./gtk/Graphics/UI/Gtk/Buttons/VolumeButton.chs 1
    +{-# LANGUAGE CPP #-}
    +-- -*-haskell-*-
    +--  GIMP Toolkit (GTK) Widget VolumeButton
    +--
    +--  Author : Andy Stewart
    +--
    +--  Created: 22 Mar 2010
    +--
    +--  Copyright (C) 2010 Andy Stewart
    +--
    +--  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  : gtk...@li...
    +-- Stability   : provisional
    +-- Portability : portable (depends on GHC)
    +--
    +-- A button which pops up a volume control
    +--
    +-- * Module available since Gtk+ version 2.12
    +--
    +module Graphics.UI.Gtk.Buttons.VolumeButton (
    +
    +-- * Detail
    +--
    +-- | 'VolumeButton' is a subclass of 'ScaleButton' that has been tailored for
    +-- use as a volume control widget with suitable icons, tooltips and accessible
    +-- labels.
    +
    +-- * Class Hierarchy
    +--
    +-- |
    +-- @
    +-- |  'GObject'
    +-- |   +----'Object'
    +-- |         +----'Widget'
    +-- |               +----'Container'
    +-- |                     +----'Bin'
    +-- |                           +----'Button'
    +-- |                                 +----'ScaleButton'
    +-- |                                       +----VolumeButton
    +-- @
    +
    +#if GTK_CHECK_VERSION(2,12,0)
    +-- * Types
    +  VolumeButton,
    +  VolumeButtonClass,
    +  castToVolumeButton,
    +  toVolumeButton,
    +
    +-- * Constructors
    +  volumeButtonNew,
    +#endif
    +  ) where
    +
    +import Control.Monad	(liftM)
    +
    +import System.Glib.FFI
    +import Graphics.UI.Gtk.Abstract.Object	(makeNewObject)
    +{#import Graphics.UI.Gtk.Types#}
    +
    +{# context lib="gtk" prefix="gtk" #}
    +
    +#if GTK_CHECK_VERSION(2,12,0)
    +--------------------
    +-- Constructors
    +
    +-- | Creates a 'VolumeButton', with a range between 0.0 and 1.0, with a
    +-- stepping of 0.02. Volume values can be obtained and modified using the
    +-- functions from 'ScaleButton'.
    +--
    +volumeButtonNew :: IO VolumeButton
    +volumeButtonNew =
    +  makeNewObject mkVolumeButton $
    +  liftM (castPtr :: Ptr Widget -> Ptr VolumeButton) $
    +  {# call gtk_volume_button_new #}
    +#endif
    }