Generic Function

Summary

Returns the cursor blinking rate for an editor pane.

Package

capi

Signature

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

Arguments

self

An editor pane.

Values

blink-rate

A non-negative real number, or nil.

Description

The system calls the function editor-pane-blink-rate to determine the cursor blinking rate in milliseconds. 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 your own methods on editor-pane-blink-rate for editor-pane and subclasses thereof.

See also

*editor-cursor-active-style*
editor-pane
editor-pane-native-blink-rate
set-default-editor-pane-blink-rate
Displaying and entering text