Function: completion-preview-active-p

completion-preview-active-p is a byte-compiled function defined in completion-preview.el.gz.

This function is obsolete since 31.1; check for completion-preview-active-mode(var)/completion-preview-active-mode(fun) instead.

Signature

(completion-preview-active-p SYMBOL BUFFER)

Documentation

Check if the completion preview is currently shown in BUFFER.

The first argument, SYMBOL, is ignored. You can use this function as the completion-predicate property of commands that you define that should only be available when the completion preview is active.

Source Code

;; Defined in /usr/src/emacs/lisp/completion-preview.el.gz
(defun completion-preview-active-p (_symbol buffer)
  "Check if the completion preview is currently shown in BUFFER.

The first argument, SYMBOL, is ignored.  You can use this function as
the `completion-predicate' property of commands that you define that
should only be available when the completion preview is active."
  (declare
   (obsolete "check for `completion-preview-active-mode' instead." "31.1"))
  (buffer-local-value 'completion-preview-active-mode buffer))