File: Bin.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 (86 lines) | stat: -rw-r--r-- 2,563 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
-- -*-haskell-*-
--  GIMP Toolkit (GTK) Widget Bin
--
--  Author : Duncan Coutts
--
--  Created: 25 April 2004
--
--  Copyright (C) 2004-2005 Duncan Coutts
--
--  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 with just one child
--
module Graphics.UI.Gtk.Abstract.Bin (
-- * Detail
-- 
-- | The 'Bin' widget is a container with just one child. It is not very
-- useful itself, but it is useful for deriving subclasses, since it provides
-- common code needed for handling a single child widget.
--
-- Many Gtk+ widgets are subclasses of 'Bin', including 'Window', 'Button',
-- 'Frame', 'HandleBox', and 'ScrolledWindow'.

-- * Class Hierarchy
-- |
-- @
-- |  'GObject'
-- |   +----'Object'
-- |         +----'Widget'
-- |               +----'Container'
-- |                     +----Bin
-- |                           +----'Window'
-- |                           +----'Alignment'
-- |                           +----'Frame'
-- |                           +----'Button'
-- |                           +----'Item'
-- |                           +----'ComboBox'
-- |                           +----'EventBox'
-- |                           +----'Expander'
-- |                           +----'HandleBox'
-- |                           +----'ToolItem'
-- |                           +----'ScrolledWindow'
-- |                           +----'Viewport'
-- @

-- * Types
  Bin,
  BinClass,
  castToBin, gTypeBin,
  toBin,

-- * Methods
  binGetChild,
  ) where

import System.Glib.FFI
import Graphics.UI.Gtk.Abstract.Object  (makeNewObject)
{#import Graphics.UI.Gtk.Types#}

{# context lib="gtk" prefix="gtk" #}

--------------------
-- Methods

-- | Gets the child of the 'Bin', or @Nothing@ if the bin contains no child
-- widget.
--
binGetChild :: BinClass self => self
 -> IO (Maybe Widget) -- ^ returns pointer to child of the 'Bin'
binGetChild self =
  maybeNull (makeNewObject mkWidget) $
  {# call gtk_bin_get_child #}
    (toBin self)