editor-pane-blink-rate

editor-pane-blink-rate Generic Function

Summary

Returns the cursor blinking rate for an editor pane.

Package

capi

Signature

editor-pane-blink-rate pane => blink-rate

Arguments

pane⇩

An editor-pane.

Values

blink-rate⇩

A non-negative real number, or nil.

Description

LispWorks calls the generic function editor-pane-blink-rate to determine the cursor blinking rate in milliseconds for pane. The pane uses the value blink-rate each time it gets the focus.

If blink-rate is a positive real number, then it is the blinking rate in milliseconds. If blink-rate is 0, then there is no blinking. If blink-rate is nil, then the default blinking rate is used.

The default method on editor-pane-blink-rate returns nil, which means use the default blinking rate. set-default-editor-pane-blink-rate.

You can define methods on editor-pane-blink-rate specializing on your own subclassses of editor-pane.