3.16 cursor%

► |  | The Racket Graphical Interface Toolkit

1 | Windowing
2 | Widget Gallery
3 | Windowing Classes
4 | Windowing Functions
5 | Editors
6 | Snip and Style Classes
7 | Editor Classes
8 | Editor Functions
9 | WXME Decoding
10 | Preferences
11 | Dynamic Loading
12 | Startup Actions
13 | Init Libraries
14 | Platform Dependencies
| Index

▼ | 3 | Windowing Classes

3.1 | area<%>
3.2 | area-container<%>
3.3 | area-container-window<%>
3.4 | button%
3.5 | canvas<%>
3.6 | canvas%
3.7 | check-box%
3.8 | checkable-menu-item%
3.9 | choice%
3.10 | clipboard-client%
3.11 | clipboard<%>
3.12 | combo-field%
3.13 | control<%>
3.14 | column-control-event%
3.15 | control-event%
3.16 | cursor%
3.17 | dialog%
3.18 | event%
3.19 | frame%
3.20 | gauge%
3.21 | group-box-panel%
3.22 | grow-box-spacer-pane%
3.23 | horizontal-pane%
3.24 | horizontal-panel%
3.25 | key-event%
3.26 | labelled-menu-item<%>
3.27 | list-box%
3.28 | list-control<%>
3.29 | menu%
3.30 | menu-bar%
3.31 | menu-item<%>
3.32 | menu-item%
3.33 | menu-item-container<%>
3.34 | message%
3.35 | mouse-event%
3.36 | pane%
3.37 | panel%
3.38 | popup-menu%
3.39 | printer-dc%
3.40 | radio-box%
3.41 | selectable-menu-item<%>
3.42 | separator-menu-item%
3.43 | scroll-event%
3.44 | slider%
3.45 | subarea<%>
3.46 | subwindow<%>
3.47 | tab-panel%
3.48 | text-field%
3.49 | timer%
3.50 | top-level-window<%>
3.51 | vertical-pane%
3.52 | vertical-panel%
3.53 | window<%>

On this page:

make-object
ok?

top contents ← prev up next →

class cursor% : class?
superclass: object%

A cursor is a small icon that indicates the location of the mouse pointer. The bitmap image typically indicates the current mode or meaning of a mouse click at its current location.

A cursor is assigned to each window (or the window may use its parent’s cursor; see set-cursor for more information), and the pointer image is changed to match the window’s cursor when the pointer is moved over the window. Each cursor object may be assigned to many windows.

> > constructor
> > (make-object cursor% |  | image |  |  |  |
> > |  | mask |  |  |  |
> > | [ | hot-spot-x |  |  |  |
> > |  | hot-spot-y]) |  | → |  | (is-a?/c cursor%)
> image : (is-a?/c bitmap%)
> mask : (is-a?/c bitmap%)
> hot-spot-x : (integer-in 0 15) = 0
> hot-spot-y : (integer-in 0 15) = 0
> (make-object cursor% id) → (is-a?/c cursor%)
> | id |  | : |  |
> (or/c 'arrow 'bullseye 'cross 'hand 'ibeam 'watch 'blank
> 'size-n/s 'size-e/w 'size-ne/sw 'size-nw/se)

The first case creates a cursor using an image bitmap and a mask bitmap. Both bitmaps must have depth 1 and size 16 by 16 pixels. The hot-spot-x and hot-spot-y arguments determine the focus point of the cursor within the cursor image, relative to its top-left corner.

The second case creates a cursor using a stock cursor, specified as one of the following:

- 'arrow — the default cursor

- 'bullseye — concentric circles

- 'cross — a crosshair

- 'hand — an open hand

- 'ibeam — a vertical line, indicating that clicks control a text-selection caret

- 'watch — a watch or hourglass, indicating that the user must wait for a computation to complete

- 'arrow+watch — the default cursor with a watch or hourglass, indicating that some computation is in progress, but the cursor can still be used

- 'blank — invisible

- 'size-e/w — arrows left and right

- 'size-n/s — arrows up and down

- 'size-ne/sw — arrows up-right and down-left

- 'size-nw/se — arrows up-left and down-right

If the cursor is created successfully, ok? returns #t, otherwise the cursor object cannot be assigned to a window.

> method (send a-cursor ok?) → boolean?

Returns #t if the cursor is can be assigned to a window, #f otherwise.
top contents ← prev up next →