Generic Function | Package: cg | ToC | DocOverview | CGDoc | RelNotes | FAQ | Index | PermutedIndex
| Allegro CL version 10.1 Unrevised from 10.0 to 10.1. 10.0 version

## cursor

Arguments: window-or-dialog-item-or-hotspot

Returns the current mouse cursor of window-or-dialog-item-or-hotspot, which determines the appearance of the mouse cursor whenever it is inside that window, control, or hotspot. (setf cursor) will set the current mouse cursor.

The value may be either an instance of the `cursor` class or an integer that is the value of one of the built-in mouse cursor variables such as `cross-cursor`. The value may also be `nil`, which for a window means to remove the mouse cursor completely when it is inside the window, and for a dialog-item means to use the default cursor for that control, which is usually the arrow cursor. For a `hotspot`, `nil` means to use the parent window's cursor. The value may also be the keyword `:default`, which means to use the default cursor for either a window or a dialog-item. The default value is `:default` for a window and `nil` for a dialog-item or hotspot. The default cursor image is typically an arrow cursor (see `arrow-cursor`).

The custom cursor of a window is used only in the interior of the window, and it is not possible to set the cursor for the frame area of a window. Similarly, certain areas of some controls, such as the column headers of a `list-view` control or the body of a `tab-control`, are not customizable and will not show the custom cursor that is assigned to the control.

To use different mouse cursors in different areas of a single window's interior, you can write a mouse-moved method that specializes on the window's class and which calls (setf cursor) on the window, passing a different cursor depending on the cursor-position argument that was passed to mouse-moved. Alternately, you could write a cursor method that returns a different cursor based on the value returned by a call to ncursor-position or cursor-position.

See the section on Mouse Cursors in cg-pixmaps.htm for more infomation.

Copyright (c) 1998-2022, Franz Inc. Lafayette, CA., USA. All rights reserved.
This page was not revised from the 10.0 page.
Created 2019.8.20.

|  | ToC | DocOverview | CGDoc | RelNotes | FAQ | Index | PermutedIndex
| Allegro CL version 10.1 Unrevised from 10.0 to 10.1. 10.0 version