Function cursor-new-from-name - cl-cffi-gtk3 API documentation

Package: gdk

Function gdk:cursor-new-from-name

Lambda List

gdk:cursor-new-from-name (display name)

Arguments

display -- a gdk:display object for which the cursor will be created
name -- a string with the name of the cursor

Return Value

The new gdk:cursor object, or nil if there is no cursor with the given name.

Details

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"

Examples

(gdk:cursor-new-from-name (gdk:display-default) "wait")
=> #<GDK-X11-CURSOR {1001AFE123}>
(gdk:cursor-new-from-name (gdk:display-default) "unknown")
=> NIL