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
|
{-# LANGUAGE CPP #-}
-- -*-haskell-*-
-- GIMP Toolkit (GTK) Object
--
-- Author : Axel Simon
--
-- Created: 9 April 2001
--
-- Copyright (C) 2001-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)
--
-- The base class of the Gtk+ type hierarchy.
--
-- * Each widget is a represented as a purely abstract data type. It can only
-- be accessed through and the special access functions that are defined
-- in each widget file.
--
module Graphics.UI.Gtk.Abstract.Object (
-- * Detail
--
-- | 'Object' is the base class for all widgets, and for a few non-widget
-- objects such as 'Adjustment'. 'Object' predates 'GObject'; non-widgets that
-- derive from 'Object' rather than 'GObject' do so for backward compatibility
-- reasons.
--
-- Object has been removed in Gt3k, but this module still provides useful
-- functions.
-- * Class Hierarchy
-- |
-- @
-- | 'GObject'
-- | +----Object
-- | +----'Widget'
-- | +----'Adjustment'
-- | +----'CellRenderer'
-- | +----'FileFilter'
-- | +----'ItemFactory'
-- | +----'Tooltips'
-- | +----'TreeViewColumn'
-- @
#if GTK_MAJOR_VERSION < 3
-- * Types
Object,
ObjectClass,
castToObject, gTypeObject,
toObject,
#endif
-- * Methods
makeNewObject,
-- * Weak references
GWeakNotify,
objectWeakref,
objectWeakunref,
-- * Signals
objectDestroy,
notifyProperty
) where
import Control.Monad (when)
import System.Glib.FFI
import System.Glib.Attributes (ReadWriteAttr)
{#import Graphics.UI.Gtk.Types#}
{#import Graphics.UI.Gtk.Signals#}
import Data.IORef
{# context lib="gtk" prefix="gtk" #}
--------------------
-- Methods
-- turn the initial floating state to sunk
--
-- * The floating\/sunk concept of a GTK object is not very useful to us.
-- The following procedure circumvents the whole subject and ensures
-- proper cleanup:
-- on creation: objectRef, objectSink
-- on finalization: objectUnref
--
-- * This function cannot be bound by c2hs because it is not possible to
-- override the pointer hook.
#if !GLIB_CHECK_VERSION(2,10,0)
foreign import ccall unsafe "gtk_object_sink"
objectSink :: Ptr obj -> IO ()
#endif
-- This is a convenience function to generate a new widget. It adds the
-- finalizer with the method described under objectSink.
--
-- * The constr argument is the contructor of the specific object.
--
#if GTK_MAJOR_VERSION < 3
makeNewObject :: ObjectClass obj =>
#else
makeNewObject :: GObjectClass obj =>
#endif
(ForeignPtr obj -> obj, FinalizerPtr obj) -> IO (Ptr obj) -> IO obj
makeNewObject (constr, objectUnref) generator = do
objPtr <- generator
when (objPtr == nullPtr) (fail "makeNewObject: object is NULL")
#if GLIB_CHECK_VERSION(2,10,0)
objectRefSink objPtr
#else
objectRef objPtr
objectSink objPtr
#endif
obj <- newForeignPtr objPtr objectUnref
return $! constr obj
{#pointer GWeakNotify#}
foreign import ccall "wrapper" mkDestructor
:: (Ptr () -> Ptr GObject -> IO ()) -> IO GWeakNotify
-- | Attach a callback that will be called after the
-- destroy hooks have been called
--
#if GTK_MAJOR_VERSION < 3
objectWeakref :: ObjectClass o => o -> IO () -> IO GWeakNotify
#else
objectWeakref :: GObjectClass o => o -> IO () -> IO GWeakNotify
#endif
objectWeakref obj uFun = do
funPtrContainer <- newIORef nullFunPtr
uFunPtr <- mkDestructor $ \_ _ -> do
uFun
funPtr <- readIORef funPtrContainer
freeHaskellFunPtr funPtr
writeIORef funPtrContainer uFunPtr
{#call unsafe g_object_weak_ref#} (toGObject obj) uFunPtr nullPtr
return uFunPtr
-- | Detach a weak destroy callback function
--
#if GTK_MAJOR_VERSION < 3
objectWeakunref :: ObjectClass o => o -> GWeakNotify -> IO ()
#else
objectWeakunref :: GObjectClass o => o -> GWeakNotify -> IO ()
#endif
objectWeakunref obj fun =
{#call unsafe g_object_weak_unref#} (toGObject obj) fun nullPtr
--------------------
-- Signals
-- | Signals that all holders of a reference to the 'Object' should release
-- the reference that they hold. May result in finalization of the object if
-- all references are released.
--
#if GTK_MAJOR_VERSION < 3
objectDestroy :: ObjectClass self => Signal self (IO ())
#else
objectDestroy :: WidgetClass self => Signal self (IO ())
#endif
objectDestroy = Signal (connect_NONE__NONE "destroy")
-- | Register a notify callback that is triggered when the given property
-- has been modified.
--
-- * Note that this callback is triggered even if the actual value of
-- the property has not changed.
-- * Not all attributes are properties. A warning will be generated at
-- runtime if the passed-in attribute is not a property of the class
-- with which it was registered.
--
#if GTK_MAJOR_VERSION < 3
notifyProperty :: ObjectClass self => ReadWriteAttr self a b -> Signal self (IO ())
#else
notifyProperty :: GObjectClass self => ReadWriteAttr self a b -> Signal self (IO ())
#endif
notifyProperty attr = Signal (\on obj cb -> connect_PTR__NONE ("notify::"++show attr) on obj (const cb))
|
