File: HButtonBox.chs

package info (click to toggle)
haskell-gtk 0.11.0-5
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 2,920 kB
  • ctags: 82
  • sloc: haskell: 1,929; ansic: 714; sh: 5; makefile: 3
file content (92 lines) | stat: -rw-r--r-- 2,899 bytes parent folder | download
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
-- -*-haskell-*-
--  GIMP Toolkit (GTK) Widget HButtonBox
--
--  Author : Matthew Walton
--
--  Created: 29 April 2004
--
--  Copyright (C) 2004-2005 Matthew Walton
--
--  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 container for arranging buttons horizontally
--
module Graphics.UI.Gtk.Layout.HButtonBox (
-- * Detail
-- 
-- | A button box should be used to provide a consistent layout of buttons
-- throughout your application. The layout\/spacing can be altered by the
-- programmer, or if desired, by the user to alter the \'feel\' of a program to
-- a small degree.
--
-- A 'HButtonBox' is created with 'hButtonBoxNew'. Buttons are packed
-- into a button box the same way widgets are added to any other
-- container, using
-- 'Graphics.UI.Gtk.Abstract.Container.containerAdd'. You can also use
-- 'Graphics.UI.Gtk.Abstract.Box.boxPackStart' or
-- 'Graphics.UI.Gtk.Abstract.Box.boxPackEnd', but for button boxes
-- both these functions work just like
-- 'Graphics.UI.Gtk.Abstract.Container.containerAdd', ie., they pack
-- the button in a way that depends on the current layout style and on
-- whether the button has had
-- 'Graphics.UI.Gtk.Abstract.ButtonBox.buttonBoxSetChildSecondary'
-- called on it.
--
-- The spacing between buttons can be set with
-- 'Graphics.UI.Gtk.Abstract.Box.boxSetSpacing'. The arrangement and
-- layout of the buttons can be changed with
-- 'Graphics.UI.Gtk.Abstract.ButtonBox.buttonBoxSetLayout'.

-- * Class Hierarchy
-- |
-- @
-- |  'GObject'
-- |   +----'Object'
-- |         +----'Widget'
-- |               +----'Container'
-- |                     +----'Box'
-- |                           +----'ButtonBox'
-- |                                 +----HButtonBox
-- @

-- * Types
  HButtonBox,
  HButtonBoxClass,
  castToHButtonBox, gTypeHButtonBox,
  toHButtonBox,

-- * Constructors
  hButtonBoxNew,
  ) 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" #}

--------------------
-- Constructors

-- | Creates a new horizontal button box.
--
hButtonBoxNew :: IO HButtonBox
hButtonBoxNew =
  makeNewObject mkHButtonBox $
  liftM (castPtr :: Ptr Widget -> Ptr HButtonBox) $
  {# call unsafe hbutton_box_new #}