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
|
-- -*-haskell-*-
-- GIMP Toolkit (GTK) Widget RadioMenuItem
--
-- Author : Axel Simon
--
-- Created: 21 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.
--
-- Note: These are not the original Gtk functions as they involve handling a
-- Gtk owned GList. The interface is rather oriented towards the RadioButton
-- widget interface.
--
-- |
-- Maintainer : gtk2hs-users@lists.sourceforge.net
-- Stability : provisional
-- Portability : portable (depends on GHC)
--
-- A choice from multiple check menu items
--
module Graphics.UI.Gtk.MenuComboToolbar.RadioMenuItem (
-- * Detail
--
-- | A radio menu item is a check menu item that belongs to a group. At each
-- instant exactly one of the radio menu items from a group is selected.
-- * Class Hierarchy
-- |
-- @
-- | 'GObject'
-- | +----'Object'
-- | +----'Widget'
-- | +----'Container'
-- | +----'Bin'
-- | +----'Item'
-- | +----'MenuItem'
-- | +----'CheckMenuItem'
-- | +----RadioMenuItem
-- @
-- * Types
RadioMenuItem,
RadioMenuItemClass,
castToRadioMenuItem, gTypeRadioMenuItem,
toRadioMenuItem,
-- * Constructors
radioMenuItemNew,
radioMenuItemNewWithLabel,
radioMenuItemNewWithMnemonic,
radioMenuItemNewFromWidget,
radioMenuItemNewWithLabelFromWidget,
radioMenuItemNewWithMnemonicFromWidget,
-- * Compatibilty aliases
radioMenuItemNewJoinGroup,
radioMenuItemNewJoinGroupWithLabel,
radioMenuItemNewJoinGroupWithMnemonic,
) 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 'RadioMenuItem'.
--
radioMenuItemNew :: IO RadioMenuItem
radioMenuItemNew =
makeNewObject mkRadioMenuItem $
liftM (castPtr :: Ptr Widget -> Ptr RadioMenuItem) $
{# call unsafe radio_menu_item_new #}
nullPtr
-- | Creates a new 'RadioMenuItem' whose child is a simple 'Label'.
--
radioMenuItemNewWithLabel :: String -> IO RadioMenuItem
radioMenuItemNewWithLabel label =
makeNewObject mkRadioMenuItem $
liftM (castPtr :: Ptr Widget -> Ptr RadioMenuItem) $
withUTFString label $ \labelPtr ->
{# call unsafe radio_menu_item_new_with_label #}
nullPtr
labelPtr
-- | Creates a new 'RadioMenuItem' containing a label. The label will be
-- created using 'labelNewWithMnemonic', so underscores in @label@ indicate the
-- mnemonic for the menu item.
--
radioMenuItemNewWithMnemonic :: String -> IO RadioMenuItem
radioMenuItemNewWithMnemonic label =
makeNewObject mkRadioMenuItem $
liftM (castPtr :: Ptr Widget -> Ptr RadioMenuItem) $
withUTFString label $ \labelPtr ->
{# call unsafe radio_menu_item_new_with_mnemonic #}
nullPtr
labelPtr
-- | Create a new radio button, adding it to the same group as the group to
-- which @groupMember@ belongs.
--
radioMenuItemNewFromWidget ::
RadioMenuItem -- ^ @groupMember@ - a member of an existing radio button
-- group, to which the new radio button will be added.
-> IO RadioMenuItem
radioMenuItemNewFromWidget groupMember =
{# call unsafe radio_menu_item_get_group #} groupMember >>= \groupPtr ->
makeNewObject mkRadioMenuItem $
liftM (castPtr :: Ptr Widget -> Ptr RadioMenuItem) $
{# call unsafe radio_menu_item_new #}
groupPtr
-- | Create a new radio button with a label, adding it to the same group as the
-- group to which @groupMember@ belongs.
--
radioMenuItemNewWithLabelFromWidget ::
RadioMenuItem -- ^ @groupMember@ - a member of an existing radio button
-- group, to which the new radio button will be added.
-> String
-> IO RadioMenuItem
radioMenuItemNewWithLabelFromWidget groupMember label =
{# call unsafe radio_menu_item_get_group #} groupMember >>= \groupPtr ->
withUTFString label $ \strPtr ->
makeNewObject mkRadioMenuItem $
liftM (castPtr :: Ptr Widget -> Ptr RadioMenuItem) $
{# call unsafe radio_menu_item_new_with_label #}
groupPtr
strPtr
-- | Create a new radio button with a label and attach it to the group of
-- another radio button. Underscores in the label string indicate the mnemonic
-- for the menu item.
--
radioMenuItemNewWithMnemonicFromWidget :: RadioMenuItem
-> String
-> IO RadioMenuItem
radioMenuItemNewWithMnemonicFromWidget groupMember label =
{# call unsafe radio_menu_item_get_group #} groupMember >>= \groupPtr ->
withUTFString label $ \strPtr ->
makeNewObject mkRadioMenuItem $
liftM (castPtr :: Ptr Widget -> Ptr RadioMenuItem) $
{# call unsafe radio_menu_item_new_with_mnemonic #}
groupPtr
strPtr
-- These were added in gtk 2.4, the above Join methods simulate them in earlier
-- versions. These aliases are here for compatibility.
-- | Alias for 'radioMenuItemNewFromWidget'.
radioMenuItemNewJoinGroup = radioMenuItemNewFromWidget
-- | Alias for 'radioMenuItemNewWithLabelFromWidget'.
radioMenuItemNewJoinGroupWithLabel = radioMenuItemNewWithLabelFromWidget
-- | Alias for 'radioMenuItemNewWithMnemonicFromWidget'.
radioMenuItemNewJoinGroupWithMnemonic = radioMenuItemNewWithMnemonicFromWidget
|
