22.4 The Pointer Protocol

pointer   [Protocol Class]
          

The protocol class that corresponds to a pointing device. If you want to create a new class that behaves like a pointer, it should be a subclass of pointer. All instantiable subclasses of pointer must obey the pointer protocol. Members of this class are mutable. [annotate]

[annotate]

pointerp  object [Protocol Predicate]
          

Returns true if object is a pointer, otherwise returns false. [annotate]

[annotate]

:port   [Initarg]
          

The :port initarg is used to specify the port with which the pointer is associated. [annotate]

[annotate]

standard-pointer   [Class]
          

The instantiable class that implements a pointer. [annotate]

[annotate]

pointer-sheet  pointer [Generic Function]
(setf pointer-sheet)  sheet pointer [Generic Function]
          

Returns (or sets) the sheet over which the pointer pointer is located. [annotate]

[annotate]

pointer-button-state  pointer [Generic Function]
          

Returns the current state of the buttons of the pointer pointer as an integer. This will be a mask consisting of the logior of +pointer-left-button+, +pointer-middle-button+, and +pointer-right-button+. [annotate]

[annotate]

pointer-position  pointer [Generic Function]
          

Returns the x and y position of the pointer pointer as two values. [annotate]

[annotate]

(setf* pointer-position)  x y pointer [Generic Function]
          

Sets the x and y position of the pointer pointer to the specified position. [annotate]

For CLIM implementations that do not support setf*, the "setter" function for this is pointer-set-position. [annotate]

[annotate]

pointer-cursor  pointer [Generic Function]
(setf pointer-cursor)  cursor pointer [Generic Function]
          

A pointer object usually has a visible cursor associated with it. These functions return (or set) the cursor associated with the pointer pointer. [annotate]

[annotate]

port  (pointer standard-pointer) [Method]