3.3 Window system input

3.3.1 Mouse documentation

Interactions with the mouse are made easier by mouse documentation, which allows programs to:

prompt users who enter an active region
explain the effects of various mouse actions

There are three ways of specifying mouse documentation.

The macro with-mouse-documentation sets the mouse documentation line to a specified string or to the result of evaluating a function argument during the execution of specified forms.

(with-mouse-documentation
    ("Default mouse documentation")
  (yes-or-no-p "continue?"))

The function make-active-region accepts the keyword argument:mouse-documentation. This argument is either a string or a function that takes an active region argument and returns a string. When the mouse is inside the active region, the who window displays this string.

(setq *window* (make-window :width 100 :height 100 :title "Doc"))
(setq *region*
      (make-active-region
        (make-region :x 0 :y 0 :width 50 :height 50)
         :bitmap *window* :mouse-documentation
                     "Mouse has entered the active
 region"))

You can set or change the mouse documentation of an existing active region by using the functionactive-region-mouse-documentation.

(defun ar-documentation (ar)
  (format nil "Mouse has entered ~A" 
    (active-region-bitmap ar)))
(setf (active-region-mouse-documentation *region*)
      #'ar-documentation)

When no other mouse documentation is specified by one of these methods, default mouse documentation appears in the who window.

For more information about active regions, see Section 3.4.3 on page 39.

The Window Tool Kit - 9 SEP 1996

Generated with Harlequin WebMaker