GI.Gdk.Objects.Cursor

A Cursor represents a cursor. Its contents are private.

Cursors are immutable objects, so they can not change after they have been constructed.

Exported types

newtype Cursor

Memory-managed wrapper type.

Constructors

Cursor (ManagedPtr Cursor)

Instances

Eq Cursor

Defined in GI.Gdk.Objects.Cursor

Methods

(==) :: Cursor -> Cursor -> Bool

(/=) :: Cursor -> Cursor -> Bool

IsGValue Cursor

Convert Cursor to and from GValue with toGValue and fromGValue.

Defined in GI.Gdk.Objects.Cursor

Methods

toGValue :: Cursor -> IO GValue

fromGValue :: GValue -> IO Cursor

ManagedPtrNewtype Cursor

Defined in GI.Gdk.Objects.Cursor

Methods

toManagedPtr :: Cursor -> ManagedPtr Cursor

TypedObject Cursor

Defined in GI.Gdk.Objects.Cursor

Methods

glibType :: IO GType

GObject Cursor

Defined in GI.Gdk.Objects.Cursor

HasParentTypes Cursor

Defined in GI.Gdk.Objects.Cursor

type ParentTypes Cursor

Defined in GI.Gdk.Objects.Cursor

type ParentTypes Cursor = '[Object]

class (GObject o, IsDescendantOf Cursor o) => IsCursor o

Type class for types which can be safely cast to Cursor, for instance with toCursor.

Instances

(GObject o, IsDescendantOf Cursor o) => IsCursor o

Defined in GI.Gdk.Objects.Cursor

toCursor :: (MonadIO m, IsCursor o) => o -> m Cursor

Cast to Cursor, for types for which this is known to be safe. For general casts, use castTo.

Methods

Overloaded methods

getFallback

cursorGetFallback

Arguments

:: (HasCallStack, MonadIO m, IsCursor a)

=> a

cursor: a Cursor.

-> m (Maybe Cursor)

Returns: the fallback of the cursor or Nothing to use the default cursor as fallback.

Returns the fallback for this cursor. The fallback will be used if this cursor is not available on a given Display.

For named cursors, this can happen when using nonstandard names or when using an incomplete cursor theme. For textured cursors, this can happen when the texture is too large or when the Display it is used on does not support textured cursors.

getHotspotX

cursorGetHotspotX

Arguments

:: (HasCallStack, MonadIO m, IsCursor a)

=> a

cursor: a Cursor.

-> m Int32

Returns: the horizontal offset of the hotspot or 0 for named cursors

Returns the horizontal offset of the hotspot. The hotspot indicates the pixel that will be directly above the cursor.

getHotspotY

cursorGetHotspotY

Arguments

:: (HasCallStack, MonadIO m, IsCursor a)

=> a

cursor: a Cursor.

-> m Int32

Returns: the vertical offset of the hotspot or 0 for named cursors

Returns the vertical offset of the hotspot. The hotspot indicates the pixel that will be directly above the cursor.

getName

cursorGetName

Arguments

:: (HasCallStack, MonadIO m, IsCursor a)

=> a

cursor: a Cursor.

-> m (Maybe Text)

Returns: the name of the cursor or Nothing if it is not a named cursor

Returns the name of the cursor. If the cursor is not a named cursor, Nothing will be returned and the GdkCursor[texture](#g:signal:texture) property will be set.

getTexture

cursorGetTexture

Arguments

:: (HasCallStack, MonadIO m, IsCursor a)

=> a

cursor: a Cursor.

-> m (Maybe Texture)

Returns: the texture for cursor or Nothing if it is a named cursor

Returns the texture for the cursor. If the cursor is a named cursor, Nothing will be returned and the GdkCursor[name](#g:signal:name) property will be set.

newFromName

cursorNewFromName

Arguments

:: (HasCallStack, MonadIO m, IsCursor a)

=> Text

name: the name of the cursor

-> Maybe a

fallback: Nothing or the Cursor to fall back to when this one cannot be supported

-> m (Maybe Cursor)

Returns: a new Cursor, or Nothing if there is no cursor with the given name

Creates a new cursor by looking up name in the current cursor theme.

A recommended set of cursor names that will work across different platforms can be found in the CSS specification:

• "none"
• "default"
• "help"
• "pointer"
• "context-menu"
• "progress"
• "wait"
• "cell"
• "crosshair"
• "text"
• "vertical-text"
• "alias"
• "copy"
• "no-drop"
• "move"
• "not-allowed"
• "grab"
• "grabbing"
• "all-scroll"
• "col-resize"
• "row-resize"
• "n-resize"
• "e-resize"
• "s-resize"
• "w-resize"
• "ne-resize"
• "nw-resize"
• "sw-resize"
• "se-resize"
• "ew-resize"
• "ns-resize"
• "nesw-resize"
• "nwse-resize"
• "zoom-in"
• "zoom-out"

newFromTexture

cursorNewFromTexture

Arguments

:: (HasCallStack, MonadIO m, IsTexture a, IsCursor b)

=> a

texture: the texture providing the pixel data

-> Int32

hotspotX: the horizontal offset of the “hotspot” of the cursor

-> Int32

hotspotY: the vertical offset of the “hotspot” of the cursor

-> Maybe b

fallback: Nothing or the Cursor to fall back to when this one cannot be supported

-> m Cursor

Returns: a new Cursor.

Creates a new cursor from a Texture.

Properties

fallback

No description available in the introspection data.

constructCursorFallback :: (IsCursor o, MonadIO m, IsCursor a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “fallback” property. This is rarely needed directly, but it is used by new.

getCursorFallback :: (MonadIO m, IsCursor o) => o -> m (Maybe Cursor)

Get the value of the “fallback” property. When overloading is enabled, this is equivalent to

get cursor #fallback

hotspotX

No description available in the introspection data.

constructCursorHotspotX :: (IsCursor o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “hotspot-x” property. This is rarely needed directly, but it is used by new.

getCursorHotspotX :: (MonadIO m, IsCursor o) => o -> m Int32

Get the value of the “hotspot-x” property. When overloading is enabled, this is equivalent to

get cursor #hotspotX

hotspotY

No description available in the introspection data.

constructCursorHotspotY :: (IsCursor o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “hotspot-y” property. This is rarely needed directly, but it is used by new.

getCursorHotspotY :: (MonadIO m, IsCursor o) => o -> m Int32

Get the value of the “hotspot-y” property. When overloading is enabled, this is equivalent to

get cursor #hotspotY

name

No description available in the introspection data.

constructCursorName :: (IsCursor o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “name” property. This is rarely needed directly, but it is used by new.

getCursorName :: (MonadIO m, IsCursor o) => o -> m (Maybe Text)

Get the value of the “name” property. When overloading is enabled, this is equivalent to

get cursor #name

texture

No description available in the introspection data.

constructCursorTexture :: (IsCursor o, MonadIO m, IsTexture a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “texture” property. This is rarely needed directly, but it is used by new.

getCursorTexture :: (MonadIO m, IsCursor o) => o -> m (Maybe Texture)

Get the value of the “texture” property. When overloading is enabled, this is equivalent to

get cursor #texture