scroll-if-not-visible-p

scroll-if-not-visible-p Accessor Generic Function

Summary

Accesses the scroll-if-not-visible-p attribute of a pane.

Package

capi

Signature

scroll-if-not-visible-p pane => value

(setf scroll-if-not-visible-p) value pane => value

Method signatures

scroll-if-not-visible-p (pane simple-pane)

(setf scroll-if-not-visible-p) value (pane simple-pane)

Arguments

`pane`⇩	A pane.
`value`⇩	One of `t`, `nil` or `:non-mouse`.

Values

value⇩

One of t, nil or :non-mouse.

Description

The accessor generic function scroll-if-not-visible-p gets and sets the scroll-if-not-visible-p attribute of pane.

value can be one of the following:

`t`	When `pane` is given the input focus, and it is not fully visible, and its parent can be scrolled to make the pane visible, then the parent is scrolled automatically. This is the default value.
`nil`	Never scroll the parent to make a pane visible.
`:non-mouse`	Like `t`, except that it does not scroll when the focus is given as a result of a mouse click in `pane`.

scroll-if-not-visible-p is called by CAPI each time it may need to scroll the parent. The method on simple-pane returns a value that is kept internally, and can be set by the default setf method.

You can specialize scroll-if-not-visible-p on your classes, but note that it is called often when the user clicks on any pane, so it must be reasonably fast.

The setter sets the scroll-if-not-visible-p attribute. It is called when the initarg :scroll-if-not-visible-p is used in making a simple-pane (or a subclass) instance, and can be called by your program. value must be t, nil or :non-mouse.

The method on simple-pane sets the internal value that is used by scroll-if-not-visible-p on simple-pane.