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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
{-# LANGUAGE CPP #-}
-- -*-haskell-*-
-- GIMP Toolkit (GTK) Widget MenuToolButton
--
-- 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 button with an additional dropdown menu
--
-- * Module available since Gtk+ version 2.6
--
module Graphics.UI.Gtk.MenuComboToolbar.MenuToolButton (
-- * Detail
--
-- | A 'MenuToolButton' is a 'ToolItem' that contains a button and a small
-- additional button with an arrow. When clicked, the arrow button pops up a
-- dropdown menu.
--
-- Use 'menuToolButtonNew' to create a new 'MenuToolButton'. Use
-- 'menuToolButtonNewFromStock' to create a new 'MenuToolButton' containing a
-- stock item.
-- * Class Hierarchy
-- |
-- @
-- | 'GObject'
-- | +----'Object'
-- | +----'Widget'
-- | +----'Container'
-- | +----'Bin'
-- | +----'ToolItem'
-- | +----'ToolButton'
-- | +----MenuToolButton
-- @
#if GTK_CHECK_VERSION(2,6,0)
-- * Types
MenuToolButton,
MenuToolButtonClass,
castToMenuToolButton, gTypeMenuToolButton,
toMenuToolButton,
-- * Constructors
menuToolButtonNew,
menuToolButtonNewFromStock,
-- * Methods
menuToolButtonSetMenu,
menuToolButtonGetMenu,
menuToolButtonSetArrowTooltip,
-- * Attributes
menuToolButtonMenu,
-- * Signals
onShowMenu,
afterShowMenu,
#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,6,0)
--------------------
-- Constructors
-- | Creates a new 'MenuToolButton' using @iconWidget@ as icon and @label@ as
-- label.
--
menuToolButtonNew :: WidgetClass iconWidget =>
Maybe iconWidget -- ^ @iconWidget@ - a widget that will be used as icon
-- widget, or @Nothing@
-> Maybe String -- ^ @label@ - a string that will be used as label, or
-- @Nothing@
-> IO MenuToolButton
menuToolButtonNew iconWidget label =
makeNewObject mkMenuToolButton $
liftM (castPtr :: Ptr ToolItem -> Ptr MenuToolButton) $
maybeWith withUTFString label $ \labelPtr ->
{# call gtk_menu_tool_button_new #}
(maybe (Widget nullForeignPtr) toWidget iconWidget)
labelPtr
-- | Creates a new 'MenuToolButton'. The new 'MenuToolButton' will contain an
-- icon and label from the stock item indicated by @stockId@.
--
menuToolButtonNewFromStock ::
StockId -- ^ @stockId@ - the name of a stock item
-> IO MenuToolButton
menuToolButtonNewFromStock stockId =
makeNewObject mkMenuToolButton $
liftM (castPtr :: Ptr ToolItem -> Ptr MenuToolButton) $
withUTFString stockId $ \stockIdPtr ->
{# call gtk_menu_tool_button_new_from_stock #}
stockIdPtr
--------------------
-- Methods
-- | Sets the 'Menu' that is popped up when the user clicks on the arrow. If
-- @menu@ is @Nothing@, the arrow button becomes insensitive.
--
menuToolButtonSetMenu :: (MenuToolButtonClass self, MenuClass menu) => self
-> Maybe menu -- ^ @menu@ - the 'Menu' associated with 'MenuToolButton'
-> IO ()
menuToolButtonSetMenu self menu =
{# call gtk_menu_tool_button_set_menu #}
(toMenuToolButton self)
(maybe (Widget nullForeignPtr) toWidget menu)
-- | Gets the 'Menu' associated with 'MenuToolButton'.
--
menuToolButtonGetMenu :: MenuToolButtonClass self => self -> IO (Maybe Menu)
menuToolButtonGetMenu self =
maybeNull (makeNewObject mkMenu) $
liftM (castPtr :: Ptr Widget -> Ptr Menu) $
{# call gtk_menu_tool_button_get_menu #}
(toMenuToolButton self)
-- | Sets the 'Tooltips' object to be used for arrow button which pops up the
-- menu. See 'Graphics.UI.Gtk.MenuComboToolbar.ToolItem.toolItemSetTooltip'
-- for setting a tooltip on the whole 'MenuToolButton'.
--
menuToolButtonSetArrowTooltip :: MenuToolButtonClass self => self
-> Tooltips -- ^ @tooltips@ - the 'Tooltips' object to be used
-> String -- ^ @tipText@ - text to be used as tooltip text for tool item
-> String -- ^ @tipPrivate@ - text to be used as private tooltip text
-> IO ()
menuToolButtonSetArrowTooltip self tooltips tipText tipPrivate =
withUTFString tipPrivate $ \tipPrivatePtr ->
withUTFString tipText $ \tipTextPtr ->
{# call gtk_menu_tool_button_set_arrow_tooltip #}
(toMenuToolButton self)
tooltips
tipTextPtr
tipPrivatePtr
--------------------
-- Attributes
-- | The dropdown menu.
--
menuToolButtonMenu :: (MenuToolButtonClass self, MenuClass menu) => ReadWriteAttr self (Maybe Menu) (Maybe menu)
menuToolButtonMenu = newAttr
menuToolButtonGetMenu
menuToolButtonSetMenu
--------------------
-- Signals
-- |
--
onShowMenu, afterShowMenu :: MenuToolButtonClass self => self
-> IO ()
-> IO (ConnectId self)
onShowMenu = connect_NONE__NONE "show-menu" False
afterShowMenu = connect_NONE__NONE "show-menu" True
#endif
|
