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
|
{-# LANGUAGE CPP #-}
{-# LANGUAGE OverloadedStrings #-}
-- -*-haskell-*-
-- GIMP Toolkit (GTK) Keys
--
-- Author : Jens Petersen
--
-- Created: 24 May 2002
--
-- Copyright (C) 2002-2005 Jens Petersen
--
-- 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.
-- #prune
-- |
-- Maintainer : gtk2hs-users@lists.sourceforge.net
-- Stability : provisional
-- Portability : portable (depends on GHC)
--
-- A 'KeyVal' is a numeric value identifying a keyboard key. The defined
-- values can be found at <http://gitweb.freedesktop.org/?p=xorg/proto/x11proto.git;a=blob_plain;f=keysymdef.h>.
-- The names of the keys are the names of the macros without the prefix.
--
module Graphics.UI.Gtk.Gdk.Keys (
KeyVal,
KeyCode,
keyName,
keyFromName,
keyToChar,
keyvalName,
keyvalFromName,
keyvalToChar,
keyvalConvertCase,
keyvalToUpper,
keyvalToLower,
keyvalIsUpper,
keyvalIsLower,
) where
import Control.Monad (liftM)
import System.Glib.FFI
import System.Glib.UTFString
{#context lib="gdk" prefix ="gdk"#}
-- | Key values are the codes which are sent whenever a key is pressed or
-- released.
--
type KeyVal = Word32
type KeyCode = Word16
-- | Converts a key value into a symbolic name.
--
keyName :: KeyVal -> DefaultGlibString
keyName k = unsafePerformIO $ keyvalName k
-- | Converts a key name to a key value.
--
keyFromName :: DefaultGlibString -> KeyVal
keyFromName k = unsafePerformIO $ keyvalFromName k
-- | Convert from a Gdk key symbol to the corresponding Unicode character.
--
keyToChar ::
KeyVal -- ^ @keyval@ - a Gdk key symbol
-> Maybe Char -- ^ returns the corresponding unicode character, or
-- Nothing if there is no corresponding character.
keyToChar k = unsafePerformIO $ keyvalToChar k
keyvalName :: KeyVal -> IO DefaultGlibString
keyvalName keyval = do
strPtr <- {# call gdk_keyval_name #} (fromIntegral keyval)
if strPtr==nullPtr then return "" else peekUTFString strPtr
keyvalFromName :: DefaultGlibString -> IO KeyVal
keyvalFromName keyvalName =
liftM fromIntegral $
withUTFString keyvalName $ \keyvalNamePtr ->
{# call gdk_keyval_from_name #}
keyvalNamePtr
keyvalToChar :: KeyVal -> IO (Maybe Char)
keyvalToChar keyval =
{# call gdk_keyval_to_unicode #} (fromIntegral keyval)
>>= \code -> if code == 0 then return Nothing
else return $ Just $ toEnum $ fromIntegral code
-- | Obtains the upper- and lower-case versions of the keyval symbol. Examples of keyvals are GDK_a,
-- 'Enter', 'F1', etc.
keyvalConvertCase :: KeyVal -- ^ @symbol@ a keyval
-> (KeyVal, KeyVal) -- ^ @(lower, upper)@
-- ^ lower is the lowercase version of symbol.
-- ^ upper is uppercase version of symbol.
keyvalConvertCase keyval =
unsafePerformIO $
alloca $ \ lowerPtr ->
alloca $ \ upperPtr -> do
{#call gdk_keyval_convert_case #}
(fromIntegral keyval)
lowerPtr
upperPtr
lower <- peek lowerPtr
upper <- peek upperPtr
return (fromIntegral lower, fromIntegral upper)
-- | Converts a key value to upper case, if applicable.
keyvalToUpper :: KeyVal -- ^ @keyval@ a key value.
-> KeyVal -- ^ returns the upper case form of keyval,
-- or keyval itself if it is already in upper case or it is not subject to case
keyvalToUpper keyval =
unsafePerformIO $
liftM fromIntegral $
{#call gdk_keyval_to_upper #}
(fromIntegral keyval)
-- | Converts a key value to lower case, if applicable.
keyvalToLower :: KeyVal -- ^ @keyval@ a key value.
-> KeyVal -- ^ returns the lower case form of keyval,
-- or keyval itself if it is already in lower case or it is not subject to case
keyvalToLower keyval =
unsafePerformIO $
liftM fromIntegral $
{#call gdk_keyval_to_lower #}
(fromIntegral keyval)
-- | Returns 'True' if the given key value is in upper case.
keyvalIsLower :: KeyVal
-> Bool -- ^ returns 'True' if keyval is in upper case, or if keyval is not subject to case conversion.
keyvalIsLower keyval =
unsafePerformIO $
liftM toBool $
{#call gdk_keyval_is_lower #}
(fromIntegral keyval)
-- | Returns 'True' if the given key value is in upper case.
keyvalIsUpper :: KeyVal
-> Bool -- ^ returns 'True' if keyval is in upper case, or if keyval is not subject to case conversion.
keyvalIsUpper keyval =
unsafePerformIO $
liftM toBool $
{#call gdk_keyval_is_upper #}
(fromIntegral keyval)
|
