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
|
-- -*-haskell-*-
-- GIMP Toolkit (GTK) Widget CheckButton
--
-- 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)
--
-- Create widgets with a discrete toggle button
--
module Graphics.UI.Gtk.Buttons.CheckButton (
-- * Detail
--
-- | A 'CheckButton' places a discrete 'ToggleButton' next to a widget,
-- (usually a 'Label'). See the section on 'ToggleButton' widgets for more
-- information about toggle\/check buttons.
--
-- The important signal (\'toggled\') is also inherited from 'ToggleButton'.
-- * Class Hierarchy
-- |
-- @
-- | 'GObject'
-- | +----'Object'
-- | +----'Widget'
-- | +----'Container'
-- | +----'Bin'
-- | +----'Button'
-- | +----'ToggleButton'
-- | +----CheckButton
-- | +----'RadioButton'
-- @
-- * Types
CheckButton,
CheckButtonClass,
castToCheckButton, gTypeCheckButton,
toCheckButton,
-- * Constructors
checkButtonNew,
checkButtonNewWithLabel,
checkButtonNewWithMnemonic,
) where
import Control.Monad (liftM)
import System.Glib.FFI
import System.Glib.UTFString
import Graphics.UI.Gtk.Abstract.Object (makeNewObject)
{#import Graphics.UI.Gtk.Types#}
{# context lib="gtk" prefix="gtk" #}
--------------------
-- Constructors
-- | Creates a new 'CheckButton'.
--
checkButtonNew :: IO CheckButton
checkButtonNew =
makeNewObject mkCheckButton $
liftM (castPtr :: Ptr Widget -> Ptr CheckButton) $
{# call unsafe check_button_new #}
-- | Creates a new 'CheckButton' with a 'Label' to the right of it.
--
checkButtonNewWithLabel ::
String -- ^ @label@ - the text for the check button.
-> IO CheckButton
checkButtonNewWithLabel label =
makeNewObject mkCheckButton $
liftM (castPtr :: Ptr Widget -> Ptr CheckButton) $
withUTFString label $ \labelPtr ->
{# call unsafe check_button_new_with_label #}
labelPtr
-- | Creates a new 'CheckButton' containing a label. The label will be created
-- using 'Graphics.UI.Gtk.Display.Label.labelNewWithMnemonic', so underscores
-- in @label@ indicate the mnemonic for the check button.
--
checkButtonNewWithMnemonic ::
String -- ^ @label@ - The text of the button, with an underscore
-- in front of the mnemonic character
-> IO CheckButton
checkButtonNewWithMnemonic label =
makeNewObject mkCheckButton $
liftM (castPtr :: Ptr Widget -> Ptr CheckButton) $
withUTFString label $ \labelPtr ->
{# call unsafe check_button_new_with_mnemonic #}
labelPtr
|
