highlight-pinboard-object Function

Summary

Highlights a specified pinboard object.

Package

capi

Signature

highlight-pinboard-object pinboard object &key redisplay => was-unhighlighted-p

Arguments

pinboard⇩	A pinboard-layout.
object⇩	A pinboard-object.
redisplay⇩	A generalized boolean.

Values

was-unhighlighted-p⇩

A boolean.

Description

The function highlight-pinboard-object causes the pinboard object object to become highlighted until unhighlight-pinboard-object is called on it.

The pinboard object highlighting is drawn according to the highlight-style of the pinboard-layout pinboard.

If redisplay is non-nil the highlighting is drawn immediately. The default value for redisplay is t.

The returned value was-unhighlighted-p is true if object was unhighlighted before the call.

See also

unhighlight-pinboard-object
draw-pinboard-object-highlighted
pinboard-object
pinboard-layout