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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
{-# LANGUAGE CPP #-}
-- -*-haskell-*-
-- GIMP Toolkit (GTK) Widget FileChooserButton
--
-- Author : Duncan Coutts
--
-- Created: 5 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 button to launch a file selection dialog
--
-- * Module available since Gtk+ version 2.6
--
module Graphics.UI.Gtk.Selectors.FileChooserButton (
-- * Detail
--
-- | The 'FileChooserButton' is a widget that lets the user select a file. It
-- implements the 'FileChooser' interface. Visually, it is a file name with a
-- button to bring up a 'FileChooserDialog'. The user can then use that dialog
-- to change the file associated with that button. This widget does not support
-- setting the \"select-multiple\" property to @True@.
--
-- The 'FileChooserButton' supports the 'FileChooserAction's
-- 'FileChooserActionOpen' and 'FileChooserActionSelectFolder'.
-- * Class Hierarchy
-- |
-- @
-- | 'GObject'
-- | +----'Object'
-- | +----'Widget'
-- | +----'Container'
-- | +----'Box'
-- | +----'HBox'
-- | +----FileChooserButton
-- @
#if GTK_CHECK_VERSION(2,6,0)
-- * Types
FileChooserButton,
FileChooserButtonClass,
castToFileChooserButton, gTypeFileChooserButton,
toFileChooserButton,
-- * Constructors
fileChooserButtonNew,
fileChooserButtonNewWithBackend,
fileChooserButtonNewWithDialog,
-- * Methods
fileChooserButtonGetTitle,
fileChooserButtonSetTitle,
fileChooserButtonGetWidthChars,
fileChooserButtonSetWidthChars,
-- * Attributes
fileChooserButtonDialog,
fileChooserButtonTitle,
fileChooserButtonWidthChars,
#endif
) where
import Control.Monad (liftM)
import System.Glib.FFI
import System.Glib.UTFString
import System.Glib.Attributes
import System.Glib.Properties
import Graphics.UI.Gtk.Abstract.Object (makeNewObject)
{#import Graphics.UI.Gtk.Types#}
#if GTK_CHECK_VERSION(2,6,0)
{#import Graphics.UI.Gtk.Selectors.FileChooser#} (FileChooserAction)
{# context lib="gtk" prefix="gtk" #}
--------------------
-- Interfaces
instance FileChooserClass FileChooserButton
--------------------
-- Constructors
-- | Creates a new file-selecting button widget.
--
fileChooserButtonNew ::
String -- ^ @title@ - the title of the browse dialog.
-> FileChooserAction -- ^ @action@ - the open mode for the widget.
-> IO FileChooserButton
fileChooserButtonNew title action =
makeNewObject mkFileChooserButton $
liftM (castPtr :: Ptr Widget -> Ptr FileChooserButton) $
withUTFString title $ \titlePtr ->
{# call gtk_file_chooser_button_new #}
titlePtr
((fromIntegral . fromEnum) action)
-- | Creates a new file-selecting button widget using @backend@.
--
fileChooserButtonNewWithBackend ::
String -- ^ @title@ - the title of the browse dialog.
-> FileChooserAction -- ^ @action@ - the open mode for the widget.
-> String -- ^ @backend@ - the name of the file system backend
-- to use.
-> IO FileChooserButton
fileChooserButtonNewWithBackend title action backend =
makeNewObject mkFileChooserButton $
liftM (castPtr :: Ptr Widget -> Ptr FileChooserButton) $
withUTFString backend $ \backendPtr ->
withUTFString title $ \titlePtr ->
{# call gtk_file_chooser_button_new_with_backend #}
titlePtr
((fromIntegral . fromEnum) action)
backendPtr
-- | Creates a 'FileChooserButton' widget which uses @dialog@ as it's
-- file-picking window.
--
fileChooserButtonNewWithDialog :: FileChooserDialogClass dialog =>
dialog -- ^ @dialog@ - the 'FileChooserDialog' widget to
-- use.
-> IO FileChooserButton
fileChooserButtonNewWithDialog dialog =
makeNewObject mkFileChooserButton $
liftM (castPtr :: Ptr Widget -> Ptr FileChooserButton) $
{# call gtk_file_chooser_button_new_with_dialog #}
(toWidget dialog)
--------------------
-- Methods
-- | Retrieves the title of the browse dialog used by the button.
--
fileChooserButtonGetTitle :: FileChooserButtonClass self => self
-> IO String -- ^ returns a pointer to the browse dialog's title.
fileChooserButtonGetTitle self =
{# call gtk_file_chooser_button_get_title #}
(toFileChooserButton self)
>>= peekUTFString
-- | Modifies the @title@ of the browse dialog used by the button.
--
fileChooserButtonSetTitle :: FileChooserButtonClass self => self
-> String -- ^ @title@ - the new browse dialog title.
-> IO ()
fileChooserButtonSetTitle self title =
withUTFString title $ \titlePtr ->
{# call gtk_file_chooser_button_set_title #}
(toFileChooserButton self)
titlePtr
-- | Retrieves the width in characters of the @button@ widget's entry and\/or
-- label.
--
fileChooserButtonGetWidthChars :: FileChooserButtonClass self => self
-> IO Int -- ^ returns an integer width (in characters) that the button will
-- use to size itself.
fileChooserButtonGetWidthChars self =
liftM fromIntegral $
{# call gtk_file_chooser_button_get_width_chars #}
(toFileChooserButton self)
-- | Sets the width (in characters) that the button will use to @nChars@.
--
fileChooserButtonSetWidthChars :: FileChooserButtonClass self => self
-> Int -- ^ @nChars@ - the new width, in characters.
-> IO ()
fileChooserButtonSetWidthChars self nChars =
{# call gtk_file_chooser_button_set_width_chars #}
(toFileChooserButton self)
(fromIntegral nChars)
--------------------
-- Attributes
-- | Instance of the 'FileChooserDialog' associated with the button.
--
fileChooserButtonDialog :: (FileChooserButtonClass self, FileChooserDialogClass fileChooserDialog) => WriteAttr self fileChooserDialog
fileChooserButtonDialog = writeAttrFromObjectProperty "dialog"
{# call pure unsafe gtk_file_chooser_dialog_get_type #}
-- | Title to put on the 'FileChooserDialog' associated with the button.
--
-- Default value: \"Select A File\"
--
fileChooserButtonTitle :: FileChooserButtonClass self => Attr self String
fileChooserButtonTitle = newAttr
fileChooserButtonGetTitle
fileChooserButtonSetTitle
-- |
--
fileChooserButtonWidthChars :: FileChooserButtonClass self => Attr self Int
fileChooserButtonWidthChars = newAttr
fileChooserButtonGetWidthChars
fileChooserButtonSetWidthChars
#endif
|
