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
164
|
{-# LANGUAGE CPP #-}
-- -*-haskell-*-
-- GIMP Toolkit (GTK) Widget ToggleToolButton
--
-- Author : Duncan Coutts
--
-- Created: 7 April 2005
--
-- Copyright (C) 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 'ToolItem' containing a toggle button
--
-- * Module available since Gtk+ version 2.4
--
module Graphics.UI.Gtk.MenuComboToolbar.ToggleToolButton (
-- * Detail
--
-- | A 'ToggleToolButton' is a 'ToolItem' that contains a toggle button.
--
-- Use 'toggleToolButtonNew' to create a new 'ToggleToolButton'. Use
-- 'toggleToolButtonNewFromStock' to create a new 'ToggleToolButton' containing
-- a stock item.
-- * Class Hierarchy
-- |
-- @
-- | 'GObject'
-- | +----'Object'
-- | +----'Widget'
-- | +----'Container'
-- | +----'Bin'
-- | +----'ToolItem'
-- | +----'ToolButton'
-- | +----ToggleToolButton
-- | +----'RadioToolButton'
-- @
#if GTK_CHECK_VERSION(2,4,0)
-- * Types
ToggleToolButton,
ToggleToolButtonClass,
castToToggleToolButton, gTypeToggleToolButton,
toToggleToolButton,
-- * Constructors
toggleToolButtonNew,
toggleToolButtonNewFromStock,
-- * Methods
toggleToolButtonSetActive,
toggleToolButtonGetActive,
-- * Attributes
#if GTK_CHECK_VERSION(2,8,0)
toggleToolButtonActive,
#endif
-- * Signals
onToolButtonToggled,
afterToolButtonToggled,
#endif
) where
import Control.Monad (liftM)
import System.Glib.FFI
import System.Glib.UTFString
import System.Glib.Attributes
import Graphics.UI.Gtk.Abstract.Object (makeNewObject)
{#import Graphics.UI.Gtk.Types#}
{#import Graphics.UI.Gtk.Signals#}
import Graphics.UI.Gtk.General.StockItems
{# context lib="gtk" prefix="gtk" #}
#if GTK_CHECK_VERSION(2,4,0)
--------------------
-- Constructors
-- | Returns a new 'ToggleToolButton'
--
toggleToolButtonNew :: IO ToggleToolButton
toggleToolButtonNew =
makeNewObject mkToggleToolButton $
liftM (castPtr :: Ptr ToolItem -> Ptr ToggleToolButton) $
{# call gtk_toggle_tool_button_new #}
-- | Creates a new 'ToggleToolButton' containing the image and text from a
-- stock item.
--
-- It is an error if @stockId@ is not a name of a stock item.
--
toggleToolButtonNewFromStock ::
StockId -- ^ @stockId@ - the name of the stock item
-> IO ToggleToolButton
toggleToolButtonNewFromStock stockId =
makeNewObject mkToggleToolButton $
liftM (castPtr :: Ptr ToolItem -> Ptr ToggleToolButton) $
withUTFString stockId $ \stockIdPtr ->
{# call gtk_toggle_tool_button_new_from_stock #}
stockIdPtr
--------------------
-- Methods
-- | Sets the status of the toggle tool button. Set to @True@ if you want the
-- 'ToggleButton' to be \'pressed in\', and @False@ to raise it. This action
-- causes the toggled signal to be emitted.
--
toggleToolButtonSetActive :: ToggleToolButtonClass self => self -> Bool -> IO ()
toggleToolButtonSetActive self isActive =
{# call gtk_toggle_tool_button_set_active #}
(toToggleToolButton self)
(fromBool isActive)
-- | Queries a 'ToggleToolButton' and returns its current state. Returns
-- @True@ if the toggle button is pressed in and @False@ if it is raised.
--
toggleToolButtonGetActive :: ToggleToolButtonClass self => self -> IO Bool
toggleToolButtonGetActive self =
liftM toBool $
{# call gtk_toggle_tool_button_get_active #}
(toToggleToolButton self)
--------------------
-- Attributes
#if GTK_CHECK_VERSION(2,8,0)
-- | If the toggle tool button should be pressed in or not.
--
-- Default value: @False@
--
toggleToolButtonActive :: ToggleToolButtonClass self => Attr self Bool
toggleToolButtonActive = newAttr
toggleToolButtonGetActive
toggleToolButtonSetActive
#endif
--------------------
-- Signals
-- | Emitted whenever the toggle tool button changes state.
--
onToolButtonToggled, afterToolButtonToggled :: ToggleToolButtonClass self => self
-> IO ()
-> IO (ConnectId self)
onToolButtonToggled = connect_NONE__NONE "toggled" False
afterToolButtonToggled = connect_NONE__NONE "toggled" True
#endif
|
