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
|
-- -*-haskell-*-
-- GIMP Toolkit (GTK) Cursor
--
-- Author : Bit Connor <bit@mutantlemon.com>
-- Andy Stewart <lazycat.manatee@gmail.com>
--
-- Created: 18 November 2007
--
-- Copyright (C) 2007 Bit Connor
-- Copyright (C) 2009 Andy Stewart
--
-- 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)
--
-- Cursors | Standard and pixmap cursors.
--
module Graphics.UI.Gtk.Gdk.Cursor (
-- * Types
Cursor(..),
-- * Enums
CursorType(..),
-- * Constructors
cursorNew,
-- * Methods
cursorNewFromPixmap,
cursorNewFromPixbuf,
cursorNewFromName,
cursorNewForDisplay,
cursorGetDisplay,
cursorGetImage
) where
import Control.Monad (liftM)
import System.Glib.FFI
import System.Glib.UTFString
import Foreign.ForeignPtr (ForeignPtr, castForeignPtr, unsafeForeignPtrToPtr)
import Graphics.UI.Gtk.General.Structs
{#import Graphics.UI.Gtk.Types#} hiding (Arrow)
{#context lib="gdk" prefix ="gdk"#}
--------------------
-- Types
{#pointer *Cursor foreign newtype #}
--------------------
-- Enums
-- | Cursor types.
{#enum GdkCursorType as CursorType {underscoreToCase} deriving (Bounded,Eq,Show)#}
--------------------
-- Utils
makeNewCursor :: Ptr Cursor -> IO Cursor
makeNewCursor rPtr = do
cursor <- newForeignPtr rPtr cursor_unref
return (Cursor cursor)
foreign import ccall unsafe "&gdk_cursor_unref"
cursor_unref :: FinalizerPtr Cursor
--------------------
-- Constructors
-- | Creates a new cursor from the set of builtin cursors for the default display.
-- See 'cursorNewForDisplay'.
-- To make the cursor invisible, use 'BlankCursor'.
cursorNew ::
CursorType -- ^ @cursorType@ cursor to create
-> IO Cursor -- ^ return a new 'Cursor'
cursorNew cursorType = do
cursorPtr <- {#call cursor_new#} $fromIntegral (fromEnum cursorType)
makeNewCursor cursorPtr
--------------------
-- Methods
-- | Creates a new cursor from a given pixmap and mask. Both the pixmap and
-- mask must have a depth of 1 (i.e. each pixel has only 2 values - on or off).
-- The standard cursor size is 16 by 16 pixels.
--
cursorNewFromPixmap ::
Pixmap -- ^ @source@ - the pixmap specifying the cursor.
-> Pixmap -- ^ @mask@ - the pixmap specifying the mask, which must be the
-- same size as source.
-> Color -- ^ @fg@ - the foreground color, used for the bits in the source
-- which are 1. The color does not have to be allocated first.
-> Color -- ^ @bg@ - the background color, used for the bits in the source
-- which are 0. The color does not have to be allocated first.
-> Int -- ^ @x@ - the horizontal offset of the \'hotspot\' of the cursor.
-> Int -- ^ @y@ - the vertical offset of the \'hotspot\' of the cursor.
-> IO Cursor
cursorNewFromPixmap source mask fg bg x y =
with fg $ \fgPtr ->
with bg $ \bgPtr -> do
rPtr <- {# call unsafe cursor_new_from_pixmap #} source mask (castPtr fgPtr) (castPtr bgPtr) (fromIntegral x) (fromIntegral y)
makeNewCursor rPtr
-- | Creates a new cursor from a pixbuf.
-- Not all GDK backends support RGBA cursors. If they are not supported, a monochrome approximation will be displayed.
-- The functions 'displaySupportsCursorAlpha' and 'displaySupportsCursorColor' can be used to determine whether RGBA cursors are supported;
-- 'displayGetDefaultCursorSize' and 'displayGetMaximalCursorSize' give information about cursor sizes.
--
-- On the X backend, support for RGBA cursors requires a sufficently new version of the X Render extension.
--
cursorNewFromPixbuf ::
Display -- ^ @display@ the 'Display' for which the cursor will be created
-> Pixbuf -- ^ @pixbuf@ the 'Pixbuf' containing the cursor image
-> Int -- ^ @x@ the horizontal offset of the 'hotspot' of the cursor.
-> Int -- ^ @y@ the vertical offset of the 'hotspot' of the cursor.
-> IO Cursor -- ^ return a new 'Cursor'.
cursorNewFromPixbuf display pixbuf x y = do
cursorPtr <- {#call cursor_new_from_pixbuf#} display pixbuf (fromIntegral x) (fromIntegral y)
makeNewCursor cursorPtr
-- | Creates a new cursor by looking up name in the current cursor theme.
cursorNewFromName ::
Display -- ^ @display@ the 'Display' for which the cursor will be created
-> String -- ^ @name@ the name of the cursor
-> IO (Maybe Cursor) -- ^ return a new 'Cursor', or @Nothing@ if there is no cursor with the given name
cursorNewFromName display name =
withUTFString name $ \namePtr -> do
cursorPtr <- {#call cursor_new_from_name#} display namePtr
if cursorPtr == nullPtr then return Nothing else liftM Just $ makeNewCursor cursorPtr
-- | Creates a new cursor from the set of builtin cursors.
cursorNewForDisplay ::
Display -- ^ @display@ the 'Display' for which the cursor will be created
-> CursorType -- ^ @cursorType@ cursor to create
-> IO Cursor -- ^ return a new 'Cursor'
cursorNewForDisplay display cursorType = do
cursorPtr <- {#call cursor_new_for_display#} display $fromIntegral (fromEnum cursorType)
makeNewCursor cursorPtr
-- | Returns the display on which the GdkCursor is defined.
cursorGetDisplay ::
Cursor -- ^ @cursor@ 'Cursor'
-> IO Display -- ^ return the 'Display' associated to cursor
cursorGetDisplay cursor =
constructNewGObject mkDisplay $ {#call cursor_get_display#} cursor
-- | Returns a 'Pixbuf' with the image used to display the cursor.
-- Note that depending on the capabilities of the windowing system and on the cursor, GDK may not be able to obtain the image data.
-- In this case, @Nothing@ is returned.
cursorGetImage ::
Cursor -- ^ @cursor@ 'Cursor'
-> IO (Maybe Pixbuf) -- ^ a 'Pixbuf' representing cursor, or @Nothing@
cursorGetImage cursor =
maybeNull (constructNewGObject mkPixbuf) $ {#call cursor_get_image#} cursor
|